Methods

Objects

cdr

CDR management.

Method Description
cdr.export_async Creates an export job to generate a CSV export based on search filters
cdr.get Get inbound or outbound CDRs.
cdr.get_by_callid_in Get inbound CDR by callid.
cdr.get_by_callid_out Get outbound CDR by callid.

Methods

cdr.export_async

Description

Creates an export job to generate a CSV export based on search filters

Signature

method: cdr.export_async

params: [object filters, object webhook]

Parameters

Parameter Type Description NULL
filters object Search filters
Object: CDR.SearchFilters
NO
webhook object Dynamic webhook for this export. Status updates (e.g. when the export is available) will be sent to this specific webhook. You only need to set 'endpoint' and optionally 'options'.
Object: Webhook
YES

Result

Type Description Format/Object
string Job ID Format: hid (Unique object identifier)

cdr.get

Description

Get inbound or outbound CDRs.

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: cdr.get

params: [string type, string from, string to, string app, string did]

Parameters

Parameter Type Description NULL
type string CDR type.
Values: "IN", "OUT"
NO
from string Retrieve from this date (inclusive).
Format: datetime (YYYY-MM-DD HH:MM:SS in UTC timezone. Example: "2012-04-24 23:42:00")
NO
to string Retrive to this date (inclusive).
Format: datetime (YYYY-MM-DD HH:MM:SS in UTC timezone. Example: "2012-04-24 23:42:00")
NO
app string (Optional) Filter CDRs with this Voice App.
Format: hash (Unique object identifier)
YES
did string (Optional) Filter CDRs with this DID.
Format: hash (Unique object identifier)
YES

Result

Type Description Format/Object
array CDRs

See Also

  • Object: CDR.In
  • Object: CDR.Out

cdr.get_by_callid_in

Description

Get inbound CDR by callid.

Signature

method: cdr.get_by_callid_in

params: [int callid]

Parameters

Parameter Type Description NULL
callid int Call ID
Format: callid (64-bit unsigned integer)
NO

Result

Type Description Format/Object
object CDR Object: CDR.In

See Also

  • Object: CDR.In

cdr.get_by_callid_out

Description

Get outbound CDR by callid.

Signature

method: cdr.get_by_callid_out

params: [int callid]

Parameters

Parameter Type Description NULL
callid int Call ID
Format: callid (64-bit unsigned integer)
NO

Result

Type Description Format/Object
object CDR Object: CDR.Out

See Also

  • Object: CDR.Out