beautypg.com

Table 106: cdr api uri parameters – Grandstream UCM6510 User Manual User Manual

Page 292

background image

Firmware Version 1.0.2.5

UCM6510 IP PBX User Manual

Page 291 of 313

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.

Table 106: CDR API URI Parameters

Field

Value

Details

format

csv, xml, json

Define 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.

caller

Comma separated extensions,

ranges of extensions, or regular

expressions.

Example:

caller=5300,5302-5304,_4@

-OR-

caller=5300&caller=5302-5304&

caller=_4@

(Matches extensions 5300, 5302,

5303, 5304, and any extension

containing 4 as the second

digit/character).

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

'_' matches any single character. Otherwise, patterns

containing a single hyphen will be matching a range of

numerical extensions, with non-numerical characters

ignored, while patterns containing multiple hyphens will

be ignored. (The pattern "0-0" will match all

non-numerical and empty strings).

callee

startTime

Date and/or time of day in any of

the following formats:

Filters based on the start (call start time) value. Calls

which start within this period (inclusive of boundaries) will