Текущие вызовы (/current_calls/)

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

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

1 Описание структур данных
2 Управление вызовом
3 Ресурсы раздела "Клиент"
4 Ресурсы раздела "Внутренний номер"

Описание структур данных

Имя	Тип	Описание

Имя	Тип	Описание
answer_time_gmt	string	Дата и время ответа вызова
call_api_id	string	Идентификатор вызова для последующего управления
call_flow	string	Направление вызова. Принимает значение in или out
callback_id	string	Идентификатор обратного вызова
called_did	string	Внешний номер, на который был осуществлён вызов
called_extension	array	Информация о вызываемом внутреннем номере
called_number	string	Набранный номер
caller_extension	array	Информация о вызывающем внутреннем номере
caller_id_name	string	Имя вызывающего абонента
caller_id_number	string	Номер вызывающего абонента
extension_id	long	Идентификатор внутреннего номера
init_time_gmt	string	Дата и время инициализации вызова
real_call	boolean	При значении false, хоть вызов и закреплен за внутренним номером, но диалога не ведет (например, была переадресация на мобильный номер)
record_uuid	string	Идентификатор записи разговора

Управление вызовом

Для того, чтобы обновить текущий вызов, необходимо выполнить API-запрос PUT на следующий URL, указав extension_id и call_api_id:
PUT /extension/{extension_id}/current_calls/{call_api_id}
В теле запроса должны быть переданы параметры action и send_dst.

Действия по управлению вызовом

Действие	Описание

Действие	Описание
transfer	"Слепой" перевод вызова на указанный в send_dst номер
attended_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 /client/{client_id}/current_calls/

Получить список вызовов для всех внутренних номеров клиента типа "телефонный терминал"

Параметры URL

Имя	Тип

Имя	Тип
client_id	string

Поля ответа

Имя	Тип

Имя	Тип
call_list	array

Массив array

Имя	Тип

Имя	Тип
answer_time_gmt	string
call_api_id	string
call_flow	string
callback_id	string
called_did	string
called_extension	array
called_number	string
caller_extension	array
caller_id_name	string
caller_id_number	string
extension_id	long
init_time_gmt	string
real_call	boolean
record_uuid	string

Ресурсы раздела "Внутренний номер"

GET /extension/{extension_id}/current_calls/

Получить список вызовов для внутреннего номера типа "телефонный терминал"

Параметры URL

Имя	Тип

Имя	Тип
extension_id	string

Поля ответа

Имя	Тип

Имя	Тип
call_list	array

Массив array

Имя	Тип

Имя	Тип
answer_time_gmt	string
call_api_id	string
call_flow	string
callback_id	string
called_did	string
called_extension	array
called_number	string
caller_extension	array
caller_id_name	string
caller_id_number	string
extension_id	long
init_time_gmt	string
real_call	boolean
record_uuid	string

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

Обновить текущий вызов

Параметры URL

Имя	Тип

Имя	Тип
call_api_id	string
extension_id	string

Параметры JSON

Имя	Тип

Имя	Тип
action	string
send_dst	string
caller_id_name	string
caller_id_number	string

GET /extension/{extension_id}/current_calls/{call_api_id}

Получить информацию о текущем вызове для внутреннего номера типа "телефонный терминал" по call_api_id

Параметры URL

Имя	Тип

Имя	Тип
call_api_id	string
extension_id	string

Поля ответа

Имя	Тип

Имя	Тип
answer_time_gmt	string
call_api_id	string
call_flow	string
callback_id	string
called_did	string
called_extension	array
called_number	string
caller_extension	array
caller_id_name	string
caller_id_number	string
extension_id	long
init_time_gmt	string
real_call	boolean
record_uuid	string