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

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

POST /scc.createConference

Описание

Создает новую конференцию. Параметр rid обязателен при создании конференции в комнате.

Параметры

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

Название	Обязательный	Тип данных	Описание
conference.name	да	string	Название конференции
conference.type	да	string	Тип: REGULAR, PERSONAL, FIX
conference.rid	нет	string	Идентификатор комнаты
conference.password	нет	string	Пароль конференции
conference.invitations	да	array	Список приглашенных пользователей
conference.conferenceFormat	нет	string	Формат: webinar, streaming, meeting
conference.adapter	нет	string	Адаптер: Jitsi, Webinar, Iva
conference.conferenceSettings	да	object	Настройки конференции
conference.plannedStartTime	нет	number	Запланированное время начала (timestamp)
conference.plannedEndTime	нет	number	Запланированное время окончания (timestamp)
conference.createChat	нет	boolean	Создать чат конференции
conference.persistentChat	нет	boolean	Постоянный чат

Запрос

curl -X 'POST' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/scc.createConference' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-User-Id: <USER_ID>' \
  -H 'x-auth-token: <AUTH_TOKEN>' \
  -d '{ \
  "conference": {
  "name": "<CONFERENCE_NAME>",
  "type": "REGULAR",
  "rid": "<ROOM_ID>",
  "invitations": [
  {
  "id": "<USER_ID_1>",
  "name": "<USER_NAME_1>",
  "role": "MODERATOR"
  }
  ],
  "conferenceSettings": {
  "audioMute": false,
  "videoMute": false,
  "waitingRoomEnable": true
  },
  "createChat": true
  }
  }'

Где:

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

Ответ

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

{
  "success": true,
  "data": {
    "_id": "conf_123456",
    "name": "Project Review",
    "number": "1234567890",
    "status": "CREATED",
    "type": "REGULAR",
    "rid": "GENERAL",
    "conferenceSettings": {
      "audioMute": false,
      "videoMute": false,
      "waitingRoomEnable": true
    },
    "creator": {
      "id": "7w9BMr9r78W4RNe8x",
      "name": "John Doe"
    },
    "createdAt": "2026-06-24T10:00:00.000Z"
  }
}