Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

At the end of an inbound or outbound call, a callback is sent to the configured webhook. This callback contains a Call Data Record for the call. To determine whether the notification is from an inbound call use the call_dir field of the payload.

paste-code-macro
languagejson
titleCDR Object
{
 "type": "string",
 type: "cdr","payload":{
     "call_id"        : int,
      payload: {"phone_number"   :"string",
     "caller_id"      : "string"
   extension  "reference_id"   : <ext>"string",
     "call_direction" : "string",
number     "result_code"    : <client_number>"string",
     "cause_value"   dial_number  : <dial_number>int,
     "user_id"   call_ref     : <internal_call_ref>int,
     "campaign_id"   contact_ref  : <custom_call_ref>int,
     "list_id"    dialed_at    : <dialed_at> int,
     "call_type"   end_reason   : <disposition>int,
     "recording_url"   end_code: "string",
     "start_date_time": "DateTime",
    : <ISDN"end_terminationdate_code>,time"  : "DateTime",
     call"ivr_time"    : <call_time> , : int,
      hold"ring_time"      : <hold_time>int,
     "talk_time"   call_dir   : int,
: <call_dir>,    "user_time"     recording_url : <recording_ref>int,
     "hold_time"   ref   : int,
     : "click-dial""wrap_time"      : int
 }
}

Values

...

<ext>

...

The agent extension or number (if the call is external; between 2 external parties)

...

<dial_number>

...

The number the PBX used as part of this call

  • Outbound: the caller ID that was shown to the callee

  • Inbound: the (DID) number that was dialed by the caller

...

<internal_call_ref>

...

Current (inline with Dialer spec)

  • Unique Internal identifier for this specific call, this is used to download recordings.

...

<custom_call_ref>

Your custom identifier for the caller/callee or matter.

It should remain the same between multiple calls for the same callee and should be used to link CDR data to a specific person.

...

Outbound/External: This reference can be set upon creating a C2D call via the API

...

Inbound: the value is either an empty string or can be set by the caller via an IVR if that feature is enabled.

...

<disposition>

...

Dispositions: how the call ended

...

<ISDN_termination_code>

...

The ISDN termination code

...

<client_number>

The clients number (as opposed to the agent)

...

Inbound: callers number (can be empty if the callers number is set to private)

...

Key

Type

Description

type

string

Payload Data

call_id

int

phone_number

string

caller_id

string

reference_id

string

call_direction

string

result_code

string

cause_value

int

user_id

int

campaign_id

int

list_id

int

call_type

int

recording_url

string

start_date_time

DateTime

end_time_time

DateTime

ivr_time

int

ring_time

int

talk_time

int

user_time

int

hold_time

int

wrap_time

int