Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

End of call notifications (CDR):

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.

{
    type: "cdr",
    payload: {
        extension    : <ext>,
        number       : <client_number>,
        dial_number  : <dial_number>,
        call_ref     : <internal_call_ref>,
        contact_ref  : <custom_call_ref>,
        dialed_at    : <dialed_at> ,
        end_reason   : <disposition>,
        end_code     : <ISDN_termination_code>,
        call_time    : <call_time> ,
        hold_time    : <hold_time>,
        call_dir     : <call_dir>,
        recording_url: <recording_ref>,
        ref          : "click-dial"
    }
}

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.

  • Default:  if no contact_ref is specified one is generated, although it serves no real purpose

<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)

  • Outbound: dialed number

  • No labels