Table 87: Cdr Api Uri Parameters - Grandstream Networks UCM6510 IP PBX User Manual

TLS Authentication Configure the user name for TLS authentication. If not configured, authentication will
Name be skipped.
TLS Authentication
Configure the password for TLS authentication. This is optional.
Password
Permitted Specify a list of IP addresses permitted by CDR API. This creates an AIP-specific
access control list. Multiple entries are allowed.
For example, "192.168.40.3/255.255.255.255" denies access from all IP addresses
except 192.168.40.3.
The format of the HTTPS request for the CDR API is as below.
https://[UCM IP]:[Port]/cdrapi?[option1]=[value]&[option2]=[value]&...
By default, the port number for the API is 8443.
The options included in the 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.
Field Value
format csv, xml, json
numRecords Number: 0-1000
offset Number
Comma separated extensions,
caller
ranges of extensions, or regular
expressions.
Example:
callee
caller=5300,5302-5304,_4@
Firmware Version 1.0.1.12

Table 87: CDR API URI Parameters

Details
Define the format for output of matching CDR rows.
Default is csv (comma separated values).
Number of records to return. Default is 1000, which is
also the maximum allowed value.
Number of matching records to skip. This will be
combined with numRecords to receive all matches over
multiple responses. Default is 0.
Filters based on src (caller) or dst (callee) value,
matching any extension contained in the parameter input
string.
Patterns containing one or more wildcards ('@' or '_') will
match as a regular expression, and treat '-' as a literal
hyphen rather than a range signifier. The '@' wildcard
matches any number of characters (including zero), while
UCM6510 IP PBX User Manual Page 257 of 277