Grandstream UCM6100 Series IP PBX Appliance CDR API Guide - Manual (Page 10)

UCM6100 Series CDR and REC API Guide Page 9 of 17
CDR API – ACCESS CALL DETAIL RECORDS
CDR API URL FORMAT
The format of the HTTPS request for the CDR API is as below. This is used to request the CDR data
matching given parameters as set by the third party application.
https://[UCM IP]:[Port]/cdrapi?[option1]=[value]&[option2]=[value]&...
By default, the port number for the API is 8443.
CDR API URL PARAMETERS
The options included in the above request URI control the record matching and output format. For CDR
matching parameters, all non-empty parameters must have a match to return a record. Parameters can
appear in the URI in any order. Multiple values given for caller or callee will be concatenated.
The following table shows the parameter list used in the CDR API.
Table 3: CDR API URL Parameters
Field Value Details
format csv, xml, json
Determines the format for output of matching CDR
rows. Default is csv (comma separated values).
numRecords Number: 0-1000
Number of records to return. Default is 1000, which is
also the maximum allowed value.
offset Number
Number of matching records to skip. This will be
combined with numRecords to receive all matches
over multiple responses. Default is 0.