Обновление конференции

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

PUT /scc.updateConference

Описание

Обновляет существующую конференцию. rid и тип конференции не могут быть изменены.

Параметры

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

Название	Обязательный	Тип данных	Описание
conference.number	да	string	Номер конференции
conference.name	да	string	Новое название конференции
conference.invitations	да	array	Обновленный список приглашений
conference.conferenceSettings	да	object	Обновленные настройки конференции
conference.password	нет	string	Новый пароль конференции
conference.plannedStartTime	нет	number	Новое запланированное время начала (timestamp)
conference.plannedEndTime	нет	number	Новое запланированное время окончания (timestamp)
conference.createChat	нет	boolean	Создать чат конференции
conference.showChat	нет	boolean	Показывать чат
conference.persistentChat	нет	boolean	Постоянный чат

Запрос

curl -X 'PUT' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/scc.updateConference' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-User-Id: <USER_ID>' \
  -H 'x-auth-token: <AUTH_TOKEN>' \
  -d '{ \
  "conference": {
  "number": "<CONFERENCE_NUMBER>",
  "name": "<NEW_NAME>",
  "invitations": [
  {
  "id": "<USER_ID_1>",
  "name": "<USER_NAME_1>",
  "role": "MODERATOR"
  }
  ],
  "conferenceSettings": {
  "audioMute": true,
  "videoMute": false,
  "waitingRoomEnable": true
  }
  }
  }'

Где:

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

Ответ

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

{
  "success": true,
  "data": {
    "_id": "conf_123456",
    "name": "Updated Conference Name",
    "number": "1234567890",
    "conferenceSettings": {
      "audioMute": true,
      "videoMute": false,
      "waitingRoomEnable": true
    }
  }
}