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

Owned by Сергей Любимов (Unlicensed)
Last updated: Aug 28, 2020 by Asia Khalitova (Unlicensed)
2 min read

Мы обновили документацию, актуальная версия страницы доступна по ссылке: Информация о составных частях вызова (/cdr/)

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

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

Ресурс cdr

Имя

Тип

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

Описание

to_username

string

нет

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

source_number

string

нет

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

result

string

нет

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

  • busy - номер занят
  • answered - вызов отвечен
  • not answered - вызов не отвечен 
  • answered elsewhere - вызов не отвечен получателем, но был отвечен кем-то другим (при одновременном вызове добавочных через очередь, либо одновременным переводом("simple transfer") сразу на несколько номеров)
  • rejected - вызов отклонен принимающей стороной
  • failed - любые другие ошибки вызова
  • voicemail  - был переведен на голосовую почту

duration

integer

нет

Длительность

hangup_time_gmt

string

нет

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

dealer_owner_id

integer

нет

Идентификатор дилера клиента, к которому относиться вызов

to_domain

string

нет

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

record_file_size

integer

нет

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

from_username

string

нет

Номер звонящего

application

string

нет

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

start_time_gmt

string

нет

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

ext_number_reg

string

нет

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

hangup_cause

string

нет

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

extension_group_owner_id

integer

нет

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

init_time_gmt

string

нет

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

dest_domain

string

нет

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

record_uuid

string

нет

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

from_domain

string

нет

Домен звонящего

source_domain

string

нет

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

extension_type

string

нет

Тип добавочного

did_domain

string

нет

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

from_screen_name

string

нет

Имя звонящего

extension_name

string

нет

Имя добавочного

flow

string

нет

Направление. Может принимать значение in, out или transfer

dest_number

string

нет

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

extension_id

integer

нет

Идентификатор добавочного

did_number

string

нет

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

client_owner_id

integer

нет

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

hangup_disposition

stringнет

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

callee_bye: трубку положила принимающая сторона
caller_bye: трубку положила вызывающая сторона
caller_cancel: вызывающая сторона отказалась ждать ответа
callee_refuse: принимающая сторона отказалась отвечать (была занята, отсутствовала регистрация и т.п.)
internal_cancel: вызов завершен сервером (обычно таймаут вызова или при пачке вызовов кто-то снял трубку)
'' - (пустой вариант) не удалось определить.

calls_hangup_dispositionstringнетИспользуется для определения инициатора разрыва соединение в вызове(ресурс - calls). Значение описаны в поле выше "hangup_disposition"
calls_resultstringнетРезультат вызова. Возможные значения смотрите в поле выше "result"
call_uuidstringнетУникальный идентификатор вызова

Ресурсы

Раздел "группа добавочных"

GET /extension_group/{extension_id}/cdr/

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

Параметры URL

Имя

Тип

extension_id

string

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

Имя

Тип

extension_idarray [integer]

start_datetime

string

end_datetimestring
start_durationinteger
end_durationinteger

flow

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

to_usernamearray [string]
pageinteger
per_pageinteger

order

string

Поля ответа

Имя

Тип

per_page

integer

cdr

array [cdr]

order

string

page

integer

Раздел "добавочный"

GET /extension/{extension_id}/cdr/

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

Параметры URL

Имя

Тип

extension_id

string

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

Имя

Тип

start_datetime

string

end_datetimestring
start_durationinteger
end_durationinteger

flow

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

to_usernamearray [string]
pageinteger
per_pageinteger

order

string

Поля ответа

Имя

Тип

per_page

integer

cdr

array [cdr]

order

string

page

integer

Теги по теме