Информация о составных частях вызова (/cdr/)

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

Данный ресурс предназначен для получения информации о составных частях вызова:

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

Имя

Тип

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

Описание

Имя

Тип

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

Описание

ani_number

string

нет

Номер из списка входящих номеров клиента

application

string

нет

Приложение, характеризующее тип вызова. Может иметь значение callcentercallbackintercept или null

call_uuid

string

нет

Уникальный идентификатор вызова

calls_hangup_disposition

string

нет

Используется для определения инициатора разрыва соединения в вызове в зависимости от его составных частей. Значения описаны в поле hangup_disposition

calls_result

string

нет

Результат вызова в зависимости от его составных частей. Возможные значения описаны в поле result

client_owner_id

integer

нет

Идентификатор клиента

dest_domain

string

нет

Домен получателя вызова для вызовов с направлением out или transfer

dest_number

string

нет

Номер получателя вызова для вызовов с направлением out или transfer (параметр flow)

did_domain

string

нет

Домен внешнего номера (DID – Direct Inward Dialing), на который поступил вызов

did_number

string

нет

Внешний номер (DID – Direct Inward Dialing), на который поступил вызов

duration

integer

нет

Длительность вызова

ext_number_reg

string

нет

Внешний номер внутреннего номера, если у внутреннего номера есть регистрация внешнего номера. В противном случае поле имеет значение null

extension_group_owner_id

integer

нет

Идентификатор группы внутреннего номера. Может иметь значение null, если внутренний номер на момент вызова не состоял ни в одной из групп

extension_id

integer

нет

Идентификатор внутреннего номера

extension_name

string

нет

Имя внутреннего номера

extension_type

string

нет

Тип внутреннего номера

flow

string

нет

Направление вызова. Может принимать значение inout или transfer

from_domain

string

нет

Домен вызывающего абонента

from_screen_name

string

нет

Имя вызывающего абонента

from_username

string

нет

Номер вызывающего абонента

hangup_cause

string

нет

Причина окончания вызова (поле можно игнорировать, присутствует для обратной совместимости)

hangup_disposition

string

нет

Используется для определения инициатора разрыва соединения:

  • callee_bye – трубку положила принимающая сторона;

  • caller_bye – трубку положила вызывающая сторона;

  • caller_cancel – вызывающая сторона отказалась ждать ответа;

  • callee_refuse – принимающая сторона отказалась отвечать (была занята, отсутствовала регистрация и т.п.);

  • internal_cancel – вызов завершен сервером (обычно тайм-аут вызова или если данный вызовов был принят другим внутренним номером);

  • '' (пустой вариант) – не удалось определить

hangup_time_gmt

string

нет

Время окончания вызова по UTC

init_time_gmt

string

нет

Время начала вызова по UTC

record_file_size

integer

нет

Размер файла записи разговора в байтах. Имеет значение null, если запись не велась

record_uuid

string

нет

Идентификатор записи разговора. Имеет значение null, если запись не велась

result

string

нет

Результат вызова. Может принимать значения:

  • busy – номер занят;

  • answered – вызов отвечен;

  • not answered – вызов не отвечен ;

  • answered elsewhere – вызов не отвечен получателем, но был отвечен кем-то другим (при одновременном вызове внутренних номеров через очередь либо одновременным переводом ("simple transfer") сразу на несколько номеров);

  • diverted - вызов был переведен на принимающем вызов устройстве

  • rejected – вызов отклонен принимающей стороной;

  • failed – любые другие ошибки вызова;

  • voicemail – вызов был переведен на голосовую почту

source_domain

string

нет

Домен источника вызова для вызовов с направлением in (параметр flow)

source_number

string

нет

Номер источника вызова для вызовов с направлением in (параметр flow)

start_time_gmt

string

нет

Время по UTC, когда вызов был отвечен. Может иметь значение null, если вызов не был отвечен

to_domain

string

нет

Домен получателя вызова

to_username

string

нет

Номер получателя вызова

bundle_info

string

нет

Информация о bundle.

Bundle_info

transfer_reason

string

нет

Причина перевода в сокращенном виде.

Transfer reason

remote_call_sign

string

нет

Признак перевода во вне (не локальный вызов)

Remote_call_sign

Ресурсы раздела "Клиент"

GET /client/{client_id}/cdr/

Получить информацию о составных частях вызова на все номера клиента

Параметры URL

Имя

Тип

Имя

Тип

client_id

string

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

Имя

Тип

Имя

Тип

start_datetime

string

from_username

array [string]

to_username

array [string]

flow

array [string('in', 'out', 'transfer')]

order

string

extension_id

array [integer]

end_datetime

string

extension_type

array [string]

per_page

integer

end_duration

integer

start_duration

integer

page

integer

Поля ответа

Имя

Тип

Имя

Тип

cdr

array [cdr_response]

order

string

page

long

per_page

long

Ресурс cdr_response

Имя

Тип

Имя

Тип

ani_number

string

application

string

call_uuid

string

calls_hangup_disposition

string

calls_result

string

client_owner_id

long

dest_domain

string

dest_number

string

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

record_file_size

long

record_uuid

string

result

string

source_domain

string

source_number

string

start_time_gmt

string

to_domain

string

to_username

string

transfer_reason

string

Ресурсы раздела "Группа внутренних номеров"

GET /extension_group/{ext_group_id}/cdr/

Получить информацию о составных частях вызова на внутренний номер

Параметры URL

Имя

Тип

Имя

Тип

ext_group_id

string

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

Имя

Тип

Имя

Тип

start_datetime

string

from_username

array [string]

to_username

array [string]

flow

array [string('in', 'out', 'transfer')]

order

string

extension_id

array [integer]

end_datetime

string

extension_type

array [string]

per_page

integer

end_duration

integer

start_duration

integer

page

integer

Поля ответа

Имя

Тип

Имя

Тип

cdr

array [cdr_response]

order

string

page

long

per_page

long

Ресурс cdr_response

Имя

Тип

Имя

Тип

ani_number

string

application

string

call_uuid

string

calls_hangup_disposition

string

calls_result

string

client_owner_id

long

dest_domain

string

dest_number

string

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

record_file_size

long

record_uuid

string

result

string

source_domain

string

source_number

string

start_time_gmt

string

to_domain

string

to_username

string

transfer_reason

string

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

GET /extension/{extension_id}/cdr/

Получить информацию о составных частях вызова на внутренний(ие) номера(а) внутри группы

Параметры URL

Имя

Тип

Имя

Тип

extension_id

string

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

Имя

Тип

Имя

Тип

start_datetime

string

from_username

array [string]

to_username

array [string]

page

integer

flow

array [string('in', 'out', 'transfer')]

order

string

per_page

integer

end_duration

integer

start_duration

integer

end_datetime

string

Поля ответа

Имя

Тип

Имя

Тип

cdr

array [cdr_response]

order

string

page

long

per_page

long

Ресурс cdr_response

Имя

Тип

Имя

Тип

ani_number

string

application

string

call_uuid

string

calls_hangup_disposition

string

calls_result

string

client_owner_id

long

dest_domain

string

dest_number

string

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

record_file_size

long

record_uuid

string

result

string

source_domain

string

source_number

string

start_time_gmt

string

to_domain

string

to_username

string

transfer_reason

string