Call Data Record (/cdr/)
- esnata (Unlicensed)
- Evgeniy
- Ilya Titaev
You can test API methods in the interactive API browser page and without writing any code
Some resources described in the page may not be available by default due to the application type (see Creating and authorizing applications)
This resource is intended to get information about components of a call:
Description of Data Structures
Name | Type | Mandatory | Description |
---|
Name | Type | Mandatory | Description |
---|---|---|---|
ani_number | string | no | Number from the list of incoming client numbers |
application | string | no | Application describing the call type. May have value callcenter, callback, intercept, or null |
call_uuid | string | no | Unique call identifier |
calls_hangup_disposition | string | no | It is used to determine the call disconnection initiator, depending on the call components. The values are described in the field hangup_disposition |
calls_result | string | no | The call result depending on its components. Possible values are described in the field result |
client_owner_id | integer | no | Identifier of the client |
dest_domain | string | no | Callee domain for calls with direction out or transfer |
dest_number | string | no | Callee number for calls with direction out or transfer (option flow) |
did_domain | string | no | External number domain (DID – Direct Inward Dialing), which the call entered to |
did_number | string | no | External number (DID – Direct Inward Dialing), which the call entered to |
duration | integer | no | Call duration |
ext_number_reg | string | no | The external number of the extension number if the extension number has an external number registration. Otherwise, the field has the value null |
extension_group_owner_id | integer | no | Identifier of the extension number group. May be null if the extension number was not a member of any group at the time of the call |
extension_id | integer | no | Identifier of the extension number |
extension_name | string | no | Name of the extension number |
extension_type | string | no | Type of the extension number |
flow | string | no | Call direction. May take the value in, out or transfer |
from_domain | string | no | Caller domain |
from_screen_name | string | no | Caller name |
from_username | string | no | Caller number |
hangup_cause | string | no | Reason of the call end (field may be ignored, it is used for backward compatibility) |
hangup_disposition | string | no | Used to determine the disconnection initiator:
|
hangup_time_gmt | string | no | Call end UTC time |
init_time_gmt | string | no | Call start UTC time |
record_file_size | integer | no | Size of call record file, in bytes Is null if no record was made |
record_uuid | string | no | Identifier of the conversation record. Is null if no record was made |
result | string | no | Call result. May take the following values:
|
source_domain | string | no | Call origin domain for calls with direction in (option flow) |
source_number | string | no | Call origin number for calls with direction in (option flow) |
start_time_gmt | string | no | UTC time when the call was answered. May be null if the call was not answered |
to_domain | string | no | Callee domain |
to_username | string | no | Callee number |
bundle_info | string | нет | info about Multiple Extension Numbers for One Employee . read: bundle_info |
transfer_reason | string | no | mnemo representation of transfer reason |
remote_call_sign | string | no | mnemo representation of external call |
"Client" Section Resources
GET /client/{client_id}/cdr/
Get information about the call components to all client numbers
URL Options
Name | Type |
---|
Name | Type |
---|---|
client_id | string |
Request Options
Name | Type |
---|
Name | Type |
---|---|
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 |
Response Fields
Name | Type |
---|
Name | Type |
---|---|
cdr | array [cdr_response] |
order | string |
page | long |
per_page | long |
Resource cdr_response
Name | Type |
---|
Name | Type |
---|---|
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 |
"Extension Number Group” Section Resources
GET /extension_group/{ext_group_id}/cdr/
Get information about the components of the call to the extension number
URL Options
Name | Type |
---|
Name | Type |
---|---|
ext_group_id | string |
Request Options
Name | Type |
---|
Name | Type |
---|---|
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 |
Response Fields
Name | Type |
---|
Name | Type |
---|---|
cdr | array [cdr_response] |
order | string |
page | long |
per_page | long |
Resource cdr_response
Name | Type |
---|
Name | Type |
---|---|
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 |
"Extension Number” Section Resources
GET /extension/{extension_id}/cdr/
Get information about the components of the call to the extension number(s) inside the group
URL Options
Name | Type |
---|
Name | Type |
---|---|
extension_id | string |
Request Options
Name | Type |
---|
Name | Type |
---|---|
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 |
Response Fields
Name | Type |
---|
Name | Type |
---|---|
cdr | array [cdr_response] |
order | string |
page | long |
per_page | long |
Resource cdr_response
Name | Type |
---|
Name | Type |
---|---|
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 |