Skip to main content

Создание чата конференции

Метод и конечная точка​

POST /conference.createChat

Описание​

Создает чат для конференции, в который будут добавлены указанные участники.

Параметры​

Перечень параметров представлен в таблице.

НазваниеОбязательныйТип данныхОписание
meetingIdнетstringИдентификатор встречи
nameнетstringНазвание чата
descriptionнетstringОписание чата
showChatнетstringПоказывать чат
persistentChatнетbooleanПостоянный чат

Запрос​

curl -X 'POST' \
'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/conference.createChat' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-User-Id: <USER_ID>' \
-H 'x-auth-token: <AUTH_TOKEN>' \
-d '{ \
"meetingId": "<MEETING_ID>",
"name": "<CHAT_NAME>",
"persistentChat": true
}'

Где:

  • <ENV> — окружение, на котором выполняется запрос;
  • <DEFAULT_DOMAIN> — домен сервера Squadus;
  • <USER_ID> — идентификатор пользователя, от имени которого выполняется запрос;
  • <AUTH_TOKEN> — токен аутентификации пользователя;
  • <MEETING_ID> — идентификатор встречи;
  • <CHAT_NAME> — название чата.

Ответ​

200 — Basic information about the conference chat — Информация о чате конференции. Пример вывода:

{
"success": true,
"data": {
"_id": "chat_123456",
"name": "Conference Chat",
"conferenceChat": true,
"persistentChat": true,
"usersCount": 5
}
}