Запуск конференции

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

POST /scc.startConference

Описание

Отображает сниппет конференции в комнате. Не запускает видеоконференцию, а только создает сообщение-приглашение.

Параметры

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

Название	Обязательный	Тип данных	Описание
notify	да	boolean	Отправлять уведомления участникам
conferenceNumber	да	string	Номер конференции
rid	да	string	Идентификатор комнаты
all	да	boolean	Пригласить всех участников комнаты
invitedUsersIds	нет	array	Список ID пользователей для приглашения

Запрос

curl -X 'POST' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/scc.startConference' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-User-Id: <USER_ID>' \
  -H 'x-auth-token: <AUTH_TOKEN>' \
  -d '{ \
  "notify": true,
  "conferenceNumber": "<CONFERENCE_NUMBER>",
  "rid": "<ROOM_ID>",
  "all": false,
  "invitedUsersIds": [
  "<USER_ID_1>",
  "<USER_ID_2>"
  ]
  }'

Где:

• <ENV> — окружение, на котором выполняется запрос;
• <DEFAULT_DOMAIN> — домен сервера Squadus;
• <USER_ID> — идентификатор пользователя, от имени которого выполняется запрос;
• <AUTH_TOKEN> — токен аутентификации пользователя;
• <CONFERENCE_NUMBER> — номер конференции;
• <ROOM_ID> — идентификатор комнаты;
• <USER_ID_1>, <USER_ID_2> — идентификаторы приглашаемых пользователей.

Ответ

200 — Basic API response with success status — Конференция запущена. Пример вывода:

{
  "success": true
}