Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Протестировать методы API можно на странице интерактивного обозревателя и без написания кода

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

Данный ресурс позволяет получать информацию о текущих вызовах добавочного номера, а также управлять этими вызовами.

Описание полей

ИмяТипОписание
call_api_idstringИдентификатор вызова для последующего управления
record_uuidstringИдентификатор записи разговора
call_flowstringНаправление вызова. Принимает значение "in" или "out"
called_numberstringНабранный номер
called_didstringВнешний номер, на который был осуществлён вызов
init_time_gmtstringДата и время инициализации вызова
answer_time_gmtstringДата и время ответа вызова
caller_id_numberstringНомер звонящего
caller_id_namestringИмя звонящего
caller_extensionextensionИнформация о вызывающий добавочном номере
called_extensionextensionИнформация о вызываемом добавочном номере
real_callboolean При значении "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

Имя

Тип

extension_id

string

Поля ответа

Имя

Тип

call_list

array [call_mdl]


PUT /extension/{extension_id}/current_calls/{call_api_id}

Обновить вызов

Параметры URL

Имя

Тип

call_api_id

string

extension_id

string

Параметры JSON

Имя

Тип

Обязательный

action

string

да

send_dst

string

нет

DELETE /extension/{extension_id}/current_calls/{call_api_id}

Прервать вызов

Параметры URL

Имя

Тип

call_api_id

string

extension_id

string

  • No labels