Протестировать методы API можно на странице интерактивного обозревателя и без написания кода
Некоторые ресурсы, описанные на странице, по-умолчанию могут быть не доступны из-за типа приложения. См. типы и уровни приложений
Данный ресурс позволяет получать информацию о текущих вызовах добавочного номера, а также управлять этими вызовами.
Описание полей
| Имя | Тип | Описание |
|---|---|---|
call_api_id | string | Идентификатор вызова для последующего управления |
record_uuid | string | Идентификатор записи разговора |
call_flow | string | Направление вызова. Принимает значение "in" или "out" |
called_number | string | Набранный номер |
called_did | string | Внешний номер, на который был осуществлён вызов |
init_time_gmt | string | Дата и время инициализации вызова |
answer_time_gmt | string | Дата и время ответа вызова |
caller_id_number | string | Номер звонящего |
caller_id_name | string | Имя звонящего |
caller_extension | extension | Информация о вызывающий добавочном номере |
called_extension | extension | Информация о вызываемом добавочном номере |
real_call | boolean | При значении "false", хоть вызов и закреплен за добавочным, но диалога не ведет (например, была переадресация на мобильный номер) |
Управление вызовом
Для того, чтобы обновить текущий необходимо выполнить API-запрос PUT на следующий URL, указав extension_id и call_api_id:
PUT /extension/{extension_id}/current_calls/{call_api_id}
В теле запроса должны быть переданы параметры action и send_dst.
Действия по управлению вызовом
| Действие | Описание |
|---|---|
transfer | Перевод вызова на указанный в send_dst номер. |
eavesdrop | Прослушивание вызова. При API-запросе вызывается указанный в send_dst номер, при снятии трубки абонент слышит телефонный разговор. |
whisper | Обращение к участнику вызова (суфлирование). При API-запросе вызывается указанный в send_dst номер, при снятии трубки абонент может обращаться к участнику вызова. |
| conference | Обращение к обоим участникам вызова (конференция). При API-запросе вызывается указанный в send_dst номер, при снятии трубки абонент может обращаться к участникам вызова. |
hold | Постановка вызова на удержание |
offhold | Снятие вызова с удержания |
park | Парковка вызова |
pickup | Перехват вызова. При API-запросе вызывается указанный в send_dst номер, при снятии трубки абонент соединяется с участником вызова. |
Прерывание вызова
Для того, чтобы прервать текущий вызов, необходимо выполнить API-запрос DELETE на следующий URL, указав extension_id и call_api_id:
DELETE /extension/{extension_id}/current_calls/{call_api_id}
Ресурсы раздела "Добавочный"
GET /extension/{extension_id}/current_calls/
Получить список вызовов для добавочного типа "телефонный терминал"
Параметры URL
Имя | Тип |
|---|---|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
PUT /extension/{extension_id}/current_calls/{call_api_id}
Обновить вызов
Параметры URL
Имя | Тип |
|---|---|
|
|
|
|
Параметры JSON
Имя | Тип | Обязательный |
|---|---|---|
|
|
|
|
|
|
DELETE /extension/{extension_id}/current_calls/{call_api_id}
Прервать вызов
Параметры URL
Имя | Тип |
|---|---|
|
|
|
|