Конференция (/conference/)
- Asia Khalitova (Unlicensed)
- Evgeniy
Протестировать методы API можно на странице интерактивного обозревателя API и без написания кода
Некоторые ресурсы, описанные на странице, по умолчанию могут быть не доступны из-за типа приложения (см. Создание и авторизация приложений)
Ресурс предназначен для управления свойствами внутреннего номера типа 'conference'.
У телефонного терминала типа ‘phone’ доступна временная, локальная конференция. Дополнительную информацию по локальной конференции можно получить по ссылке: Конференции.
Внутренний номер конференции - это:
1. Неактивная конференция. В таком случае внутренний номер типа “конференции” представляет собой конфигурируемые параметры будущей конференции. Если конференция еще не активна - то при звонке на конференцию она станет активной и будет представлять собой конференцию с параметрами, указанными в свойствах внутреннего номера конференции.
2. Активная конференция - конференция, созданная по параметрам, указанным в свойствах внутреннего номера конференции. Если выполняется условие окончания конференции - конференция перестает быть активной. Изменения, выполняемые в активной конференции являются временными, на время активации конференции
Параметры неактивной конференции
Свойства параметров
Имя | Тип | Обяза-тельный | Значение по умолчанию | Описание |
|---|---|---|---|---|
announce_caller_name | boolean | нет | false | Если данный параметр активен, то при входе в конференцию будет запрошено имя пользователя внутреннего номера, которое затем будет озвучено всем в конференции |
enter_sound | integer | нет | null | Идентификатор звукового файла, который будет проигран при входе в конференцию |
max_members | integer | нет | null | Максимальное количество участников конференции (по умолчанию — 100) |
pin | string | нет | null | Пин-код участника конференции. Нельзя попасть в конференцию, не зная пин-кода, если пин-код задан |
moderator_pin | string | нет | null | Пин-код модератора. Не может быть указан без указания пин-кода для участников конференции (параметр pin) |
mute_non_moderator | boolean | нет | false | При входе в конференцию будет отключен микрофон всем, кроме модераторов. Также у простых участников не будет возможности использовать команду включения микрофона *1 |
music_on_hold_sound | integer | нет | null | Мелодия, которая будет проиграна, если в конференции только 1 участник (мелодия ожидания других участников) |
record_enabled | boolean | нет | false | Запись участника конференции из числа приглашенных (внешних номеров). Не распространяется на добавочные платформы |
Ресурсы
Активная конференция
Запрос статуса активной конференции
GET /extension/{extension_id}/conference/status/
Чтобы выполнить запрос статуса активной конференции, необходимо указать action. Возможен один из следующих (выделено жирным шрифтом):
show_members: содержит список членов конференции {"members": [ member1_dict, member2_dict,… ]}
Описание параметров члена конференции:
Параметр | Описание |
|---|---|
member_id | id участника конференции |
member_number | Номер участника конференции |
member_name | Имя участника конференции |
muted | Может говорить или нет |
deafed | Может слышать или нет |
moderator | Является ли модератором (зашел с пином участника или же с пином модератора) |
call_api_id | all_api_id для удаления участника из конференции сбросом вызова ресурсом delete /extension/{extension_id}/current_calls/{call_api_id} или перевода ресурсом put /extension/{extension_id}/current_calls/{call_api_id} |
is_locked - конференция может быть заблокирована для входа новых участников. True - заблокирована, False- можно зайти новым участникам.
max_members - максимальное число единовременных участников в этой активной конференции
count - текущее число единовременных участников конференции
run_time - время работы текущей активной конференции в секундах
Параметры URL
Имя | Тип |
|---|---|
|
|
Параметры запроса
Имя | Тип | Описание |
|---|---|---|
|
| Обязательный параметр. Один из: show_members, is_locked, max_members, count, run_time |
Пример
Управление созданной конференцией
PUT /extension/{extension_id}/conference/status/
Обновление активной конференции в режиме реального времени (настройки не сохранятся, если конференция перестанет быть активной - например, при условии, если все участники конференции покинут конференцию)
Параметры URL
Имя | Тип |
|---|---|
|
|
Параметры JSON
Имя | Тип | Описание |
|---|---|---|
|
| Если не передан member_id - вкл\выкл запрет на разговор всем “не модератором”, если передан member_id - то вкл\выкл запрет на разговор конкретному member_id |
|
| Остановить проигрывание любых файлов в конференции |
|
| вкл\выкл возможность входа в конференцию для новых участников |
|
| Если не передан member_id - вкл\выкл возможность слышать всем “не модератором”, если передан member_id - то вкл\выкл возможность слышать конкретному member_id |
|
| вкл\выкл проигрывание enter_sound |
|
| указывается в комбинации с mute или deaf |
|
| Проиграть файл (указать идентификатор звукового файла) в конференцию |
Приглашение в конференцию с телефонного терминала
Участник конференции – внутренний номер (в том числе модератор) может:
Команда | Действие |
|---|---|
*8 | Пригласить внешний номер в конференцию |
*1 | Включить/выключить микрофон (команда доступна только для модератора, если включена функция конференции mute_non_moderator) |
Участник конференции - модератор может:
Команда | Действие |
|---|---|
*90 | Включить микрофоны всем участникам конференции (кроме модераторов) |
*91 | Отключить микрофоны всем участникам конференции (кроме модераторов) |
*92 | Запрет подключения новых участников к конференции, заблокировать конференцию. При попытке подключиться к конференции новому участнику, в том числе модератору конференции, произойдет сброс |
*93 | Действие, обратное команде *92 |
*94 | Отключение оповещения о входе нового участника конференции |
*95 | Включения оповещения о входе нового участника конференции |