Page Comparison

_{Протестировать методы API можно на странице}_{интерактивного обозревателя API}_{и без написания кода}
_{Некоторые ресурсы, описанные на странице, по умолчанию могут быть не доступны из-за типа приложения (см.}_{Создание и авторизация приложений}₎

Ресурс предназначен для управления свойствами внутреннего номера типа 'conference'.

У телефонного терминала типа ‘phone’ доступна временная, локальная конференция. Дополнительную информацию по локальной конференции можно получить по ссылке: Конференции.

Внутренний номер конференции - это:

1. Неактивная конференция. В таком случае внутренний номер типа “конференции” представляет собой конфигурируемые параметры будущей конференции. Если конференция еще не активна - то при звонке на конференцию она станет активной и будет представлять собой конференцию с параметрами, указанными в свойствах внутреннего номера конференции.
2. Активная конференция - конференция, созданная по параметрам, указанным в свойствах внутреннего номера конференции. Если выполняется условие окончания конференции - конференция перестает быть активной. Изменения, выполняемые в активной конференции являются временными, на время активации конференции

Table of Contents

Параметры неактивной конференции

Свойства параметров

Имя	Тип	Обяза-тельный	Значение по умолчанию	Описание
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	Запись участника конференции из числа приглашенных (внешних номеров). Не распространяется на добавочные платформы

Ресурсы

Expand

title	GET /extension/{extension_id}/conference/

GET /extension/{extension_id}/conference/

Получить свойства конференции

Параметры URL

Имя	Тип
extension_id	string

Поля ответа

Имя	Тип
announce_caller_name	boolean
enter_sound	long
max_members	long
moderator_pin	string
music_on_hold_sound	long
mute_non_moderator	boolean
pin	string
record_enabled	boolean

Expand

title	PUT /extension/{extension_id}/conference/

PUT /extension/{extension_id}/conference/

Изменить свойства конференции

Параметры URL

Имя	Тип
extension_id	string

Параметры запроса

Имя	Тип
announce_caller_name	boolean
enter_sound	long
max_members	long
moderator_pin	string
music_on_hold_sound	long
mute_non_moderator	boolean
pin	string
record_enabled	boolean

Поля ответа

Имя	Тип
announce_caller_name	boolean
enter_sound	long
max_members	long
moderator_pin	string
music_on_hold_sound	long
mute_non_moderator	boolean
pin	string
record_enabled	boolean

Активная конференция

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

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

Имя	Тип
`extension_id`	`string`

Параметры запроса

Имя

Тип

Описание

action

string

Обязательный параметр.

Один из: show_members, is_locked, max_members, count, run_time

Пример

Tabs

data

[{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"В разделе "},{"type":"text","text":"authentication","marks":[{"type":"strong"}]},{"type":"text","text":" в поля "},{"type":"text","text":"client_id","marks":[{"type":"strong"}]},{"type":"text","text":" и "},{"type":"text","text":"client_secret","marks":[{"type":"strong"}]},{"type":"text","text":" требуется ввести полученные при регистрации приложения значения "},{"type":"text","text":"Application_ID","marks":[{"type":"strong"}]},{"type":"text","text":" и "},{"type":"text","text":"Application_Secret","marks":[{"type":"strong"}]},{"type":"text","text":", затем нажать на кнопку \""},{"type":"text","text":"Try it out!","marks":[{"type":"strong"}]},{"type":"text","text":"\". Если данные приложения верны, в ответ вернётся токен доступа ("},{"type":"text","text":"access_token","marks":[{"type":"strong"}]},{"type":"text","text":"). Полученный токен доступа следует ввести в поле \""},{"type":"text","text":"Access Token Field","marks":[{"type":"strong"}]},{"type":"text","text":"\" вверху страницы и сохранить его нажатием кнопки \""},{"type":"text","text":"Set Token","marks":[{"type":"strong"}]},{"type":"text","text":"\"."}]},{"type":"paragraph","content":[{"type":"text","text":"В качестве "},{"type":"text","text":"EXT_ID","marks":[{"type":"strong"}]},{"type":"text","text":" необходимо указать id добавочного конференции"}]},{"type":"table","attrs":{"isNumberColumnEnabled":false,"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"метод","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"ресурс","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"данные","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"POST"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"heading","attrs":{"level":3},"content":[{"type":"text","text":"/extension/EXT_ID/conference/status/?action="},{"type":"text","text":"show_members","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"{"},{"type":"hardBreak"},{"type":"text","text":"\"members\": ["},{"type":"hardBreak"},{"type":"text","text":"{"},{"type":"hardBreak"},{"type":"text","text":"\"member_id\": \"75\","},{"type":"hardBreak"},{"type":"text","text":"\"member_number\": \"022*384\","},{"type":"hardBreak"},{"type":"text","text":"\"member_name\": \"Caller_name\","}]},{"type":"paragraph","content":[{"type":"text","text":"”muted”: false,"}]},{"type":"paragraph","content":[{"type":"text","text":"”deafed”: false,"}]},{"type":"paragraph","content":[{"type":"text","text":"”moderator” : true,"},{"type":"hardBreak"},{"type":"text","text":"\"call_api_id\": \"3232240860-9b9772be-4e0e-11ed-9250-81c398f02f83\""},{"type":"hardBreak"},{"type":"text","text":"}"},{"type":"hardBreak"},{"type":"text","text":"]"},{"type":"hardBreak"},{"type":"text","text":"}"}]}]}]}]},{"type":"paragraph","content":[]}]},"id":"a99c4d84-05f3-49c2-88c6-9f0556878d24","label":"","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Для отправки запросов с помощью программы cURL установим значения переменных "},{"type":"text","text":"url ","marks":[{"type":"strong"}]},{"type":"text","text":"и "},{"type":"text","text":"access_token","marks":[{"type":"strong"}]},{"type":"text","text":":"}]},{"type":"paragraph","content":[{"type":"text","text":"export url=\"https://<hostname>/api/ver1.0\"","marks":[{"type":"code"}]},{"type":"text","text":" "},{"type":"hardBreak"},{"type":"text","text":"(где hostname — hostname API-сервера провайдера IP-телефонии),"}]},{"type":"paragraph","content":[{"type":"text","text":"export access_token=\"8SNsrS0jV35vfmKqKeKtRrHfpbg4UX\"","marks":[{"type":"code"}]},{"type":"text","text":" "},{"type":"hardBreak"},{"type":"text","text":"(полученный токен доступа)."}]},{"type":"paragraph","content":[{"type":"text","text":"export ext_id = 1234 (id добавочного конференции)"}]},{"type":"paragraph","content":[{"type":"text","text":"Отправим запрос:"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"type":"text","text":"curl \\\n-H \"Authorization: Bearer ${access_token}\" \\\n-H \"Content-Type: application/json\" \\\n-X GET ${url}/extension/${ext_id}/conference/status/?action=show_members"}]}]},"id":"b0402360-8c18-4ed4-9ce8-4a1219d273e4","label":"Программа cURL ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Для отправки запросов на языке Python установим значения переменных URL и ACCESS_TOKEN:"}]},{"type":"paragraph","content":[{"type":"text","text":"URL = \"https://<hostname>/api/ver1.0\"","marks":[{"type":"code"}]},{"type":"hardBreak"},{"type":"text","text":"(где hostname — hostname API-сервера провайдера IP-телефонии),"}]},{"type":"paragraph","content":[{"type":"text","text":"ACCESS_TOKEN = \"8SNsrS0jV35vfmKqKeKtRrHfpbg4UX\"","marks":[{"type":"code"}]},{"type":"hardBreak"},{"type":"text","text":"(полученный токен доступа)."}]},{"type":"paragraph","content":[{"type":"text","text":"ext_id = 1234 (id добавочного конференци)"}]},{"type":"codeBlock","attrs":{"language":"python"},"content":[{"type":"text","text":"#!/usr/bin/python\r\n\r\nimport requests\r\n\r\nurl = f\"{URL}/extension/{ext_id}/conference/status/?action=show_members\"\r\nheaders = {\r\n 'Authorization': f'Bearer {ACCESS_TOKEN}',\r\n 'Content-Type': 'application/json'\r\n}\r\nresponse = requests.get(url, headers=headers)\nprint(response.text)"}]}]},"id":"c6d8e587-6d73-4654-b5ae-0cc627974822","label":"На языке Python3 ","type":"tab"}]

tabsConfiguration

{"position":"top"}

[{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"В разделе "},{"type":"text","text":"authentication","marks":[{"type":"strong"}]},{"type":"text","text":" в поля "},{"type":"text","text":"client_id","marks":[{"type":"strong"}]},{"type":"text","text":" и "},{"type":"text","text":"client_secret","marks":[{"type":"strong"}]},{"type":"text","text":"  требуется ввести полученные при регистрации приложения значения "},{"type":"text","text":"Application_ID","marks":[{"type":"strong"}]},{"type":"text","text":" и "},{"type":"text","text":"Application_Secret","marks":[{"type":"strong"}]},{"type":"text","text":", затем нажать на кнопку \""},{"type":"text","text":"Try it out!","marks":[{"type":"strong"}]},{"type":"text","text":"\". Если данные приложения верны, в ответ вернётся токен доступа ("},{"type":"text","text":"access_token","marks":[{"type":"strong"}]},{"type":"text","text":"). Полученный токен доступа следует ввести в поле \""},{"type":"text","text":"Access Token Field","marks":[{"type":"strong"}]},{"type":"text","text":"\" вверху страницы и сохранить его нажатием кнопки \""},{"type":"text","text":"Set Token","marks":[{"type":"strong"}]},{"type":"text","text":"\"."}]},{"type":"paragraph","content":[{"type":"text","text":"В качестве "},{"type":"text","text":"EXT_ID","marks":[{"type":"strong"}]},{"type":"text","text":" необходимо указать id добавочного конференции"}]},{"type":"table","attrs":{"isNumberColumnEnabled":false,"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"метод","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"ресурс","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"данные","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"POST"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"heading","attrs":{"level":3},"content":[{"type":"text","text":"/extension/EXT_ID/conference/status/?action="},{"type":"text","text":"show_members","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"{"},{"type":"hardBreak"},{"type":"text","text":"\"members\": ["},{"type":"hardBreak"},{"type":"text","text":"{"},{"type":"hardBreak"},{"type":"text","text":"\"member_id\": \"75\","},{"type":"hardBreak"},{"type":"text","text":"\"member_number\": \"022*384\","},{"type":"hardBreak"},{"type":"text","text":"\"member_name\": \"Caller_name\","}]},{"type":"paragraph","content":[{"type":"text","text":"”muted”: false,"}]},{"type":"paragraph","content":[{"type":"text","text":"”deafed”: false,"}]},{"type":"paragraph","content":[{"type":"text","text":"”moderator” : true,"},{"type":"hardBreak"},{"type":"text","text":"\"call_api_id\": \"3232240860-9b9772be-4e0e-11ed-9250-81c398f02f83\""},{"type":"hardBreak"},{"type":"text","text":"}"},{"type":"hardBreak"},{"type":"text","text":"]"},{"type":"hardBreak"},{"type":"text","text":"}"}]}]}]}]},{"type":"paragraph","content":[]}]},"id":"a99c4d84-05f3-49c2-88c6-9f0556878d24","label":"","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Для отправки запросов с помощью программы cURL установим значения переменных "},{"type":"text","text":"url ","marks":[{"type":"strong"}]},{"type":"text","text":"и "},{"type":"text","text":"access_token","marks":[{"type":"strong"}]},{"type":"text","text":":"}]},{"type":"paragraph","content":[{"type":"text","text":"export url=\"https://<hostname>/api/ver1.0\"","marks":[{"type":"code"}]},{"type":"text","text":" "},{"type":"hardBreak"},{"type":"text","text":"(где hostname — hostname API-сервера провайдера IP-телефонии),"}]},{"type":"paragraph","content":[{"type":"text","text":"export access_token=\"8SNsrS0jV35vfmKqKeKtRrHfpbg4UX\"","marks":[{"type":"code"}]},{"type":"text","text":" "},{"type":"hardBreak"},{"type":"text","text":"(полученный токен доступа)."}]},{"type":"paragraph","content":[{"type":"text","text":"export ext_id = 1234 (id добавочного конференции)"}]},{"type":"paragraph","content":[{"type":"text","text":"Отправим запрос:"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"type":"text","text":"curl \\\n-H \"Authorization: Bearer ${access_token}\" \\\n-H \"Content-Type: application/json\" \\\n-X GET ${url}/extension/${ext_id}/conference/status/?action=show_members"}]}]},"id":"b0402360-8c18-4ed4-9ce8-4a1219d273e4","label":"Программа cURL    ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Для отправки запросов на языке Python установим значения переменных URL и ACCESS_TOKEN:"}]},{"type":"paragraph","content":[{"type":"text","text":"URL = \"https://<hostname>/api/ver1.0\"","marks":[{"type":"code"}]},{"type":"hardBreak"},{"type":"text","text":"(где hostname — hostname API-сервера провайдера IP-телефонии),"}]},{"type":"paragraph","content":[{"type":"text","text":"ACCESS_TOKEN = \"8SNsrS0jV35vfmKqKeKtRrHfpbg4UX\"","marks":[{"type":"code"}]},{"type":"hardBreak"},{"type":"text","text":"(полученный токен доступа)."}]},{"type":"paragraph","content":[{"type":"text","text":"ext_id = 1234 (id добавочного конференци)"}]},{"type":"codeBlock","attrs":{"language":"python"},"content":[{"type":"text","text":"#!/usr/bin/python\r\n\r\nimport requests\r\n\r\nurl = f\"{URL}/extension/{ext_id}/conference/status/?action=show_members\"\r\nheaders = {\r\n    'Authorization': f'Bearer {ACCESS_TOKEN}',\r\n    'Content-Type': 'application/json'\r\n}\r\nresponse = requests.get(url, headers=headers)\nprint(response.text)"}]}]},"id":"c6d8e587-6d73-4654-b5ae-0cc627974822","label":"На языке Python3    ","type":"tab"}]

Управление созданной конференцией

PUT /extension/{extension_id}/conference/status/

Обновление активной конференции в режиме реального времени (настройки не сохранятся, если конференция перестанет быть активной - например, при условии, если все участники конференции покинут конференцию)

Параметры URL

Имя	Тип
`extension_id`	`string`

Параметры JSON

Имя	Тип	Описание
`mute`	`boolean`	Если не передан member_id - вкл\выкл запрет на разговор всем “не модератором”, если передан member_id - то вкл\выкл запрет на разговор конкретному member_id
`stop_play`	`boolean`	Остановить проигрывание любых файлов в конференции
`lock`	`boolean`	вкл\выкл возможность входа в конференцию для новых участников
`deaf`	`boolean`	Если не передан member_id - вкл\выкл возможность слышать всем “не модератором”, если передан member_id - то вкл\выкл возможность слышать конкретному member_id
`enter_sound`	`boolean`	вкл\выкл проигрывание enter_sound
`member_id`	`integer`	указывается в комбинации с mute или deaf
`play_file`	`integer`	Проиграть файл (указать идентификатор звукового файла) в конференцию

Приглашение в конференцию с телефонного терминала

Участник конференции – внутренний номер (в том числе модератор) может:

Команда	Действие
*8	Пригласить внешний номер в конференцию
*1	Включить/выключить микрофон (команда доступна только для модератора, если включена функция конференции mute_non_moderator)

Участник конференции - модератор может:

Команда	Действие
*90	Включить микрофоны всем участникам конференции (кроме модераторов)
*91	Отключить микрофоны всем участникам конференции (кроме модераторов)
*92	Запрет подключения новых участников к конференции, заблокировать конференцию. При попытке подключиться к конференции новому участнику, в том числе модератору конференции, произойдет сброс
*93	Действие, обратное команде *92
*94	Отключение оповещения о входе нового участника конференции
*95	Включения оповещения о входе нового участника конференции

Versions Compared

Old Version 6

New Version Current

Key