Calls (/calls/)

bridged_domain 

string 

no 

User domain of the subscriber whom the connection has been established with 

bridged_duration 

long 

no 

Duration of connection of two subscribers. May be null if no connection with the second subscriber has not been established 

bridged_time_gmt 

string 

no 

UTC time when two subscribers were connected. May be null if no connection with the second subscriber has been established 

bridged_username 

string 

no 

Number of the subscriber whom the connection has been established with 

call_uuid 

string 

no 

Unique call identifier 

client_owner_id 

long 

no 

Identifier of the client whom the call belongs to 

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 

long 

no 

Call duration 

ext_number_reg 

string 

no 

The external number of the extension number, which the call belongs to, if the extension number has an external number registration. Otherwise, the field has the value null 

extension_group_owner_id 

long 

no 

Group identifier of the extension number, which the call belongs to. May be null if the extension number was not a member of any group at the time of the call 

extension_id 

long 

no 

Identifier of the extension number, which the call belongs to. 

extension_name 

string 

no 

Name of the extension number, which the call belongs to. 

extension_type 

string 

no 

Type of the extension number, which the call belongs to. 

flow 

string 

no 

Call direction. May take the value in or out 

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: 

• callee_bye – the callee hung up;

• caller_bye – the caller hung up;

• caller_cancel – the caller refused to wait for an answer;

• callee_refuse – the callee refused to answer (was busy, there was no registration, etc.);

• internal_cancel – the call was terminated by the server (usually due to call timeout or if the call was answered by another extension number);

• '' (empty) – failed to determine 

hangup_time_gmt 

string 

no 

Call end UTC time 

init_time_gmt 

string 

no 

Call start UTC time 

result 

string 

no 

Call result. Can take the following values: 

• busy – the number is busy;

• answered – the call was answered, but not necessarily by the operator (for example, by IVR or queue);

• bridged – as a result, the call was answered by the operator;

• not answered – the call was not answered;

• rejected – the call was rejected by the callee; 

• failed – any other call errors occurred 

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 

diversion_number

string

no 

Number from diversion header value

quality_rate

object

no

Conversation rate: {rate: int, max_rate: int}

rate - rate,

max_rate - maximum possible rate

ivr_history

string

no

Contains history of caller jumps in IVR with format:
”context_id1,context_option1,dial_sequence1;context_id2,context_option2,dial_sequence2;…”

Data collection in ivr is activated after set options_to_cdr of ivr rule set_variable (Voice Menu (/ivr/) context_option_rule) to true (or any variable value except false), is disabled after set options_to_cdr to false or False

ivr_history can contain:

• context_id - id of context (get context data - GET /extension/{extension_id}/ivr/context/{context_id} Voice Menu (/ivr/) | Resources of the section "Voice menu (ivr)" ) ,

• context_option - name of option Voice Menu (/ivr/) (context option)

• dial_sequence - the typed DTMF of a caller that got this context_option . Might be absent

example of ivr_history string:
”1,1;1,invalid,64;“
1,1; - was appeared in context with id 1 in option 1 and nothing was dialed from caller

1,invalid,64; - was appeared in context with id 1 in option invalid and 64 was dialed from caller

callback

object

no

Contains information if a callback was made.

dst_num - The destination number of the call

src_num - The calling subscriber's number

src_id - id of the extension src_num