eXpress

https://docs.express.ms/
Admin
eXpress is an enterprise communications platform offering secure messaging, voice and video calls,...
Tokens:1,030,323
Snippets:5,711
Trust Score:9.2
Update:1 month ago
Show doc for...
Tokens:
Raw
### Start development with npm start

Source: https://docs.express.ms/chatbots/developer-guide/deploying-and-updating-smartapp/deploying-smartapp

Run this command to start the development process for the SmartApp.

```bash
npm start
```

--------------------------------

### Start PostgreSQL service

Source: https://docs.express.ms/server-operation/backup-and-recovery/service-recovery-process

Starts the PostgreSQL service on a standalone instance.

```bash
systemctl start postgresql
```

--------------------------------

### MSI installation with LogLevel parameter

Source: https://docs.express.ms/server-installation/integrations/outlook/plagin-keycloak/outlook-plagin

Command-line example for installing the ExpressMeeting MSI package with a specific logging level. The parameter LogLevel is passed to automatically initialize the logging level during installation.

```text
ExpressMeeting_v_3.0.1.1.msi LogLevel=Information
```

--------------------------------

### Initialize VoEx project

Source: https://docs.express.ms/server-installation/installation/transcoding

Initializes the VoEx project.

```bash
dpl --init
```

--------------------------------

### Get chat info - request parameters

Source: https://docs.express.ms/chatbots/developer-guide/api/botx-api/chats-api

Example of the query parameters for the get chat info endpoint, showing the group_chat_id parameter.

```http
?group_chat_id=dcfa5a7c-7cc4-4c89-b6c0-80325604f9f4
```

--------------------------------

### Get sticker packs request URL

Source: https://docs.express.ms/chatbots/developer-guide/api/botx-api/stickers-api

Example query string for the GET /api/v3/botx/stickers/packs endpoint, including user_huid, limit, and after parameters.

```http
?user_huid=84a12e71-3efc-5c34-87d5-84e3d9ad64fd&limit=10&after=ABCEoS5xPvxcNIfVhOPZrWT9AA0ACnVwZGF0ZWRfYXQAf____QAAAAA=
```

--------------------------------

### Start Media server with dpl -d

Source: https://docs.express.ms/server-installation/installation/media-configuration/janus-stun-turn

Commands to start the Media server. First navigate to the /opt/express-voice directory, then run dpl -d to launch the server.

```bash
cd /opt/express-voice

```

```bash
dpl -d

```

--------------------------------

### Get personal chat - request parameters

Source: https://docs.express.ms/chatbots/developer-guide/api/botx-api/chats-api

Example query parameters for the GET /api/v1/botx/chats/personal endpoint. The user_huid parameter is a UUID identifying the user.

```http
?user_huid=dcfa5a7c-7cc4-4c89-b6c0-80325604f9f4
```

--------------------------------

### Вызов SDK.ready() для инициализации SmartApp

Source: https://docs.express.ms/smartapps/developer-guide/smartapp-sdk/methods/others

Пример использования метода ready из @expressms/smartapp-sdk. Метод возвращает Promise, который разрешается объектом с полями initialData и isMain. В примере извлекаются initialData и isMain из ответа.

```javascript
import * as SDK from "@expressms/smartapp-sdk";


async function initApp() {
  const readyResponse = await SDK.ready();

  const { initialData, isMain } = readyResponse;
  const { initiator, meta } = initialData || {};

```

--------------------------------

### Get sticker packs successful response

Source: https://docs.express.ms/chatbots/developer-guide/api/botx-api/stickers-api

Example 200 response for the GET /api/v3/botx/stickers/packs endpoint, showing the packs list and pagination object.

```json
{
  "status": "ok",
  "result": {
      "packs": [
           {
             "id": "26080153-a57d-5a8c-af0e-fdecee3c4435",
             "name": "Sticker Pack",
             "preview": "/uploads/sticker_pack/26080153-a57d-5a8c-af0e-fdecee3c4435/9df3143975ad4e6d93bf85079fbb5f1d.png?v=1614781425296",
             "public": true,
             "stickers_count": 2,
             "stickers_order": [
               "a998f599-d7ac-5e04-9fdb-2d98224ce4ff",
               "25054ac4-8be2-5a4b-ae00-9efd38c73fb7"
             ],
             "inserted_at": "2020-11-28T12:56:43.672163Z",
             "updated_at": "2021-02-18T12:52:31.571133Z",
             "deleted_at": null,
           }
      ],
      "pagination": {
          "after": "ABAmCAFTpX1ajK8O_ezuPEQ1AA0ACnVwZGF0ZWRfYXQAf____gAAAAA="
     }
  }
}
```

--------------------------------

### Установка Docker (apt install docker.io)

Source: https://docs.express.ms/server-installation/installation/operating-systems-preset/os-astra-linux-orel

Команда для установки Docker в ОС Astra Linux "Орел".

```bash
apt install docker.io

```

--------------------------------

### Start screen session for migration

Source: https://docs.express.ms/server-operation/updating/migration/messaging-migration-3.51/migration-manual-mode/copying-event-registry

Starts the screen utility to run the migration in a persistent session. Recommended because the query may take a long time depending on server resources and settings.

```bash
screen
```

--------------------------------

### Get list of chats - successful response

Source: https://docs.express.ms/chatbots/developer-guide/api/botx-api/chats-api

Example of a successful response from the endpoint for getting a list of chats. The response contains a status and a result array with chat details.

```json
{
  "status": "ok",
  "result": [
    {
      "group_chat_id": "740cf331-d833-5250-b5a5-5b5cbc697ff5",
      "chat_type": "group_chat",
      "name": "Chat Name",
      "description": "Desc",
      "members": [
        "6fafda2c-6505-57a5-a088-25ea5d1d0364",
        "705df263-6bfd-536a-9d51-13524afaab5c"
      ],
      "shared_history": false,
      "inserted_at": "2019-08-29T11:22:48.358586Z",
      "updated_at": "2019-08-30T21:02:10.453786Z"
    }
  ]
}
```

--------------------------------

### Get chat info - successful response

Source: https://docs.express.ms/chatbots/developer-guide/api/botx-api/chats-api

Example of a successful response from the get chat info endpoint, containing detailed chat information including members with admin flags.

```json
{
  "status": "ok",
  "result": {
    "chat_type": "group_chat",
    "creator": "6fafda2c-6505-57a5-a088-25ea5d1d0364",
    "description": null,
    "group_chat_id": "740cf331-d833-5250-b5a5-5b5cbc697ff5",
    "inserted_at": "2019-08-29T11:22:48.358586Z",
    "members": [
      {
        "admin": true,
        "server_id": "32bb051e-cee9-5c5c-9c35-f213ec18d11e",
        "user_huid": "6fafda2c-6505-57a5-a088-25ea5d1d0364",
        "user_kind": "user"
      },
      {
        "admin": false,
        "server_id": "32bb051e-cee9-5c5c-9c35-f213ec18d11e",
        "user_huid": "705df263-6bfd-536a-9d51-13524afaab5c",
        "user_kind": "botx"
      }
    ],
    "name": "Group Chat Example",
    "shared_history": false
  }
}
```

--------------------------------

### Install SmartApp SDK with npm

Source: https://docs.express.ms/smartapps/developer-guide/smartapp-sdk

Install the SmartApp SDK using npm. Requires nodejs >= 14 and npm or yarn.

```bash
npm i -S @expressms/smartapp-sdk

```

--------------------------------

### Get personal chat - success response

Source: https://docs.express.ms/chatbots/developer-guide/api/botx-api/chats-api

Example successful response from the GET /api/v1/botx/chats/personal endpoint. Returns chat details including group_chat_id, chat_type, name, description, members, shared_history, and timestamps.

```json
{
  "status": "ok",
  "result": {
      "group_chat_id": "740cf331-d833-5250-b5a5-5b5cbc697ff5",
      "chat_type": "group_chat",
      "name": "Chat Name",
      "description": "Desc",
      "members": [
        "6fafda2c-6505-57a5-a088-25ea5d1d0364",
        "705df263-6bfd-536a-9d51-13524afaab5c"
      ],
      "shared_history": false,
      "inserted_at": "2019-08-29T11:22:48.358586Z",
      "updated_at": "2019-08-30T21:02:10.453786Z"
  }
}
```

--------------------------------

### Установка Docker (dnf install docker-ce docker-ce-cli)

Source: https://docs.express.ms/server-installation/installation/operating-systems-preset/os-red-os

Устанавливает пакеты Docker CE и CLI. Выполняется после настройки SELinux.

```bash
dnf install docker-ce docker-ce-cli

```
Tokens:
Raw