Создать комнату

Обновлено 18 декабря 2024

Скачать спецификацию

POST

/room/create

Возвращает объект с параметрами комнаты: идентификатором, веб-адресом и паролем.

Запрос

• application/json

Body

required

roomTitle

string

nullable

Произвольное название комнаты.

serverVideoRecordAutoStartEnabled

boolean

nullable

По умолчанию: false

Указывает на необходимость автоматической записи встречи. Для начала записи нужно, чтобы на встрече присутствовало минимум два участника.

roomType
string
nullable
Возможные значения: [WEBINAR, MEETING]
По умолчанию: MEETING
Тип комнаты. Возможные значения:
• WEBINAR — вебинар. Доступно, только если у вас подключены вебинары;
• MEETING — встреча, значение по умолчанию.
webinar objectnullable

Параметры вебинара.

Вебинары и видеоконференции для бизнеса и обучения оплачиваются отдельно.

reusable

boolean

required

Указывает на то повторяется вебинар или нет.

Если вебинар разовый (reusable: false), в поле scheduledAt нужно указать время, на которое назначено событие.

scheduledAt

string

Задает дату и время, когда будет доступен вебинара.

Указывается только для разовых событий: поле reusable: false.

description

string

nullable

Описание вебинара.

transcriptionAutoStartEnabled

boolean

По умолчанию: false

Включение транскрибирования встречи.

Включить транскрибирование невозможно, если уже уже включено создание краткого содержания встречи (summarizationEnabled: true).

После завершения встречи вы можете все транцкрипций для выбранной комнаты с помощью метода POST /room/{roomId}/transcriptions.

summarizationEnabled

boolean

По умолчанию: false

Включение создания краткого содержания встречи.

После включения краткого содержания, включить транскрибирование невозможно (transcriptionAutoStartEnabled: true).

Ответы

• 200

OK

• application/json

• Схема
• Пример из схемы

Schema

roomId

string

Идентификатор комнаты.

roomPassword

string

Пароль для доступа к комнате.

roomUrl

string

Веб-адрес, который содержит идентификатор комнаты и пароль для доступа к ней.

webinar objectnullable
Параметры вебинара. Содержит null, если в запросе не были переданы параметры вебинара.
viewerUrl
string
Ссылка для зрителей.
viewerPassword
string

{
  "roomId": "tool-5g1c28",
  "roomPassword": "pd499ooo",
  "roomUrl": "https://jazz.sberbank.ru/tool-5g1c28?psw=OAMGUUtdChkGEwFHFEkdCgkZHA",
  "webinar": {
    "viewerUrl": "http://salutejazz.ru/wg8hnr?type=webinar&role=VIEWER&psw=OEoIEUpXVEIbWg8HFUNDURRQEg",
    "viewerPassword": "9jt8314r"
  }
}

Loading...

Loading...