Вызовы (/calls/)
- Asia Khalitova (Unlicensed)
- Ilya Titaev
- Dmitri Savolainen
- Evgeniy
Протестировать методы API можно на странице интерактивного обозревателя API и без написания кода
Некоторые ресурсы, описанные на странице, по умолчанию могут быть не доступны из-за типа приложения (см. Создание и авторизация приложений)
Данный ресурс позволяет получить данные о вызовах клиента. Ресурс аналогичен ресурсу call_history, за исключением отсутствия массива составных частей вызова (cdr). Выполняется быстрее, чем call_history, поэтому его предпочтительно использовать, когда составные части вызова не важны.
Описание структур данных
Ресурс calls
Имя | Тип | Обяза-тельный | Описание |
---|
Имя | Тип | Обяза-тельный | Описание |
---|---|---|---|
bridged_domain | string | нет | Домен пользователя абонента, с которым произошло соединение |
bridged_duration | long | нет | Длительность соединения двух абонентов. Может иметь значение null, если соединение со вторым абонентов не произошло |
bridged_time_gmt | string | нет | Время по UTC, когда было установлено соединение двух абонентов. Может иметь значение null, если соединение со вторым абонентом не произошло |
bridged_username | string | нет | Номер абонента, с которым произошло соединение |
call_uuid | string | нет | Уникальный идентификатор вызова |
client_owner_id | long | нет | Идентификатор клиента, к которому относится вызов |
did_domain | string | нет | Домен внешнего номера (DID – Direct Inward Dialing), на который поступил вызов |
did_number | string | нет | Внешний номер (DID – Direct Inward Dialing), на который поступил вызов |
duration | long | нет | Длительность вызова |
ext_number_reg | string | нет | Внешний номер внутреннего номера, к которому относится вызов, если у внутреннего номера есть регистрация внешнего номера. В противном случае поле имеет значение null |
extension_group_owner_id | long | нет | Идентификатор группы внутреннего номера, к которому относится вызов. Может иметь значение null, если внутренний номер на момент вызова не состоял ни в одной из групп |
extension_id | long | нет | Идентификатор внутреннего номера, к которому относится вызов |
extension_name | string | нет | Имя внутреннего номера, к которому относится вызов |
extension_type | string | нет | Тип внутреннего номера, к которому относится вызов |
flow | string | нет | Направление вызова. Может принимать значение in или out |
from_domain | string | нет | Домен вызывающего абонента |
from_screen_name | string | нет | Имя вызывающего абонента |
from_username | string | нет | Номер вызывающего абонента |
hangup_cause | string | нет | Причина окончания вызова (поле можно игнорировать, присутствует для обратной совместимости) |
hangup_disposition | string | нет | Используется для определения инициатора разрыва соединения:
|
hangup_time_gmt | string | нет | Время окончания вызова по UTC |
init_time_gmt | string | нет | Время начала вызова по UTC |
result | string | нет | Результат вызова. Может принимать значения:
|
start_time_gmt | string | нет | Время по UTC, когда вызов был отвечен. Может иметь значение null, если вызов не был отвечен |
to_domain | string | нет | Домен получателя вызова |
to_username | string | нет | Номер получателя вызова |
diversion_number | string | нет | Номер из заголовка diversion |
quality_rate | object | нет | Оценка разговора текущего звонка в виде: {rate: int, max_rate: int} rate - оценка, max_rate - максимально возможная оценка |
ivr_history | string | нет | содержит историю переходов вызова внутри IVR в формате Cбор данных в IVR активируется после установленной переменной options_to_cdr правила set_variable (Голосовое меню (/ivr/) context_option_rule) значением в true (любое значение переменной), отключается установкой переменной options_to_cdr значением в false или False
например: 1,invalid,64; - попали в контексте c id 1 в опцию invalid донабрав 64 с клавиатуры |
callback | object | нет | Содержит информацию, если был сделан обратный вызов.
|
Ресурсы раздела “Клиент”
GET /client/{client_id}/calls/
Параметры URL
Имя | Тип |
---|
Имя | Тип |
---|---|
client_id | string |
Параметры запроса
Имя | Тип |
---|
Имя | Тип |
---|---|
start_datetime | string |
from_username | array [string] |
start_bridged_duration | integer |
flow | array [string] |
bridged_username | array [string] |
end_bridged_duration | integer |
order | string |
end_datetime | string |
did_number | array [string] |
per_page | integer |
end_duration | integer |
extension_id | array [integer] |
to_username | array [string] |
start_duration | integer |
page | integer |
Поля ответа
Имя | Тип |
---|
Имя | Тип |
---|---|
calls | Array[calls] |
order | string |
page | long |
per_page | long |
Ресурс calls
Имя | Тип |
---|
Имя | Тип |
---|---|
bridged_domain | string |
bridged_duration | long |
bridged_time_gmt | string |
bridged_username | string |
call_uuid | string |
client_owner_id | long |
did_domain | string |
did_number | string |
duration | long |
ext_number_reg | string |
extension_group_owner_id | long |
extension_id | long |
extension_name | string |
extension_type | string |
flow | string |
from_domain | string |
from_screen_name | string |
from_username | string |
hangup_cause | string |
hangup_disposition | string |
hangup_time_gmt | string |
init_time_gmt | string |
result | string |
start_time_gmt | string |
to_domain | string |
to_username | string |
diversion_number | string |