SIP Sorcery Help - REST Provisioning Service: Call Detail Records

ID: A system generated GUID that uniquely identifies the Dial Plan record. It cannot be updated.
DialPlanName: A descriptive name for the Dial Plan record. The Dial Plan name is used when selecting the outgoing and incoming dial plans that a SIP account uses.
TraceEmailAddress: An optional parameter that if set will email a trace of the log messages from each (and every) execution of the dial plan.
DialPlanScript: The Ruby script for the dial plan.
ScriptTypeDescription: The type of the dial plan. It cannot be updated and in most cases should be set to "Ruby".
AcceptNonInvite: A boolean parameter that if set to true allows the dial plan to process other requests apart from INVITEs. In most cases should be left as False.

Call Detail Records

The service methods available for Call Detail Records (CDR) are listed below. In all cases the "where" parameter is an optional filter. It can be used to filter the results of a Get or Count query. Call Detail Records are created automatically by the system in response to SIP call events and records cannot be updated or inserted using this provisioning service.

Count: GET cdr/count?where={where},
Get: GET cdr/get?where={where}&offset={offset}&count={count}&orderby={property [asc|desc]}

The typical JSON format for a Call Detail Record is shown below.

The Ruby script below illustrates how to use each of the service methods for Call Detail records.

Help & Support

Call Detail Records