Grandstream Networks UCM6510 User manual

Grandstream Networks, Inc.
UCM6510 IP PBX Appliance
CDR Report and CDR API Guide

UCM6510 CDR Report and CDR API Guide
Page 1 of 13
Index
INTRODUCTION ........................................................................................3
CDR FILTER..........................................................................................................................................3
CDR REPORT DATA FIELDS................................................................................................................4
CDR REPORT OPERATIONS...............................................................................................................5
CDR CSV FILE...........................................................................................6
CDR API CONFIGURATION FILES ...........................................................8
CDR API CONFIGURATION..................................................................................................................8
CDR API URL FORMAT AND PARAMETERS ......................................................................................9
EXAMPLE QUERIES...........................................................................................................................10
EXAMPLE OUTPUT............................................................................................................................12
CSV...............................................................................................................................................12
XML...............................................................................................................................................13
JSON ............................................................................................................................................13

UCM6510 CDR Report and CDR API Guide
Page 2 of 13
Table of Figures
Figure 1: CDR Filter ......................................................................................................................................3
Figure 2: CDR Report ...................................................................................................................................5
Figure 3: Downloaded CDR File Sample - Call To Shows "s" ......................................................................6
Figure 4: Downloaded CDR File Sample - Source Channel and Dest Channel 1........................................6
Figure 5: Downloaded CDR File Sample - Source Channel and Dest Channel 2........................................7
Figure 6: Downloaded CDR File Sample - Source Channel and Dest Channel 3........................................7

UCM6510 CDR Report and CDR API Guide
Page 3 of 13
INTRODUCTION
CDR (Call Detail Record) is a data record produced by the PBX that contains attributes specific to a
single instance of phone call handled by the PBX. It has several data fields to provide detailed description
for the call, such as phone number of the calling party, phone number of the receiving party, start time,
call duration, and etc.
CDR FILTER
On the UCM6510, the CDR can be accessed under web UI->Status->CDR->CDR. Users could filter the
call report by specifying the date range and criteria, depending on how the users would like to include the
logs to the report. Then click on "View Report" button to display the generated report.
Figure 1: CDR Filter
Table 1: CDR Filter Criteria
Inbound calls
Inbound calls are calls originated from a non-internal source (like a VoIP trunk) and
sent to an internal extension.
Outbound calls
Outbound calls are calls sent to a non-internal source (like a VoIP trunk) from an
internal extension.
Internal calls
Internal calls are calls from one internal extension to another extension, which are
not sent over a trunk.
External calls
External calls are calls sent from one trunk to another trunk, which are not sent to
any internal extension.
Caller Number
Enter the caller number to be filtered in the CDR report.

UCM6510 CDR Report and CDR API Guide
Page 4 of 13
Caller Name
Enter the caller name to be filtered in the CDR report.
From Date
Specify "From" date and time to be filtered for the CDR report. Click on the field
and the calendar will show for users to select the exact date and time.
To Date
Specify "To" date and time to be filtered for the CDR report. Click on the field and
the calendar will show for users to select the exact date and time.
CDR REPORT DATA FIELDS
The CDR report has the following data fields:
Start Time
Format: 2013-03-27 16:47:03
Call From
Example format:
"John Doe"<6012>
"WIRELESS CALLER"<123456789> [Trunk: CallCenterTrunk]
Call To
Example format:
6005
*97
7080 [Trunk: CallCenterTrunk]
Answered By
Example format:
6005
trunk_16
Call Time
Format: 0:13:45
Talk Time
Format: 0:13:41
Status
No answer, Busy, Answered, or Failed.
The following figure shows CDR record produced by the UCM6510.

UCM6510 CDR Report and CDR API Guide
Page 5 of 13
Figure 2: CDR Report
CDR REPORT OPERATIONS
Users could perform the following operations on the above CDR report.
Sort
Click on the header of the column to sort by this category. For example, clicking on "Start Time" will
sort the report according to start time. Clicking on "Start Time" again will reverse the order.
Download Records
On the bottom of the page, click on "Download Records" button to export the report in .csv format.
Delete All
On the bottom of the page, click on "Delete All" button to remove all the call report information.
Options
There are three buttons for each CDR entry. If the call is recorded, the three buttons will be available
(shown in blue) for users to click on.
: Download the voice recording for the call
: Play the voice recording for the call
: Delete the voice recording for the call

UCM6510 CDR Report and CDR API Guide
Page 6 of 13
CDR CSV FILE
The downloaded CDR .csv file has different format from the web UI CDR. Here are some descriptions.
Call From, Call To
"Call From": the caller ID.
"Call To": the callee ID.
If "Call From" shows empty, "Call To" shows "s" (see highlight part in the picture below) and the "Source
Channel" contains "DAHDI", this means the call is from FXO/PSTN line. For FXO/PSTN line, we only
know there is an incoming request when there is incoming call but we don't know the number being called.
So we are using "s" to match it where "s" means "start".
Figure 3: Downloaded CDR File Sample - Call To Shows "s"
Context
There are different context values that might show up in the downloaded CDR file. The actual value can
vary case by case. Here are some sample values and their descriptions.
from-internal: internal extension makes outbound calls.
ext-did-XXXXX: inbound calls. It starts with "ext-did", and "XXXXX" content varies case by case, which
also relate to the order when the trunk is created.
ext-local: internal calls between local extensions.
Source Channel, Dest Channel
Sample 1:
Figure 4: Downloaded CDR File Sample - Source Channel and Dest Channel 1
DAHDI means it is an analog call, FXO or FXS. DAHDI/(1-2) are FXO ports, and DAHDI(3-4) are FXS

UCM6510 CDR Report and CDR API Guide
Page 7 of 13
ports.
Sample 2:
Figure 5: Downloaded CDR File Sample - Source Channel and Dest Channel 2
"SIP" means it's a SIP call. There are three possible format:
(a) SIP/NUM-XXXXXX, where NUM is the local SIP extension number. The last XXXXX is a random
string and can be ignored.
(c) SIP/trunk_X/NUM, where trunk_X is the internal trunk name, and NUM is the number to dial out
through the trunk.
(c) SIP/trunk_X-XXXXXX, where trunk_X is the internal trunk name and it is an inbound call from this
trunk. The last XXXXX is a random string and can be ignored.
Sample 3:
Figure 6: Downloaded CDR File Sample - Source Channel and Dest Channel 3
This is a very special channel name. If it shows up, most likely it means a conference call.
There are some other possible values, but these values are almost the application name which are used
by the dialplan.
IAX2/NUM-XXXXXXX: it means this is an IAX call.
Local/@from-internal-XXXXX: it is used internally to do some special feature procedure. We can simply
ignore it.
Hangup: the call is hung up from the dialplan. This indicates there are some errors or it has run into
abnormal cases.
Playback: play some prompts to you, such as 183 response or run into an IVR.
ReadExten: collect numbers from user. It may occur when you input PIN codes or run into DISA

UCM6510 CDR Report and CDR API Guide
Page 8 of 13
CDR API CONFIGURATION FILES
The UCM6510 supports third party billing interface API for external billing software to access CDR on the
PBX starting from firmware version 1.0.6.x. The API uses HTTPS to request the CDR data matching
given parameters as configured on the third party application.
CDR API CONFIGURATION
Before accessing the API, the administrators need enable API and configure the access/authentication
information on the UCM6510 first.
Table 2: CDR API Configuration Files
Enable
Enable/Disable CDR API. The default setting is disabled.
TLS Bind Address
Configure the IP address for TLS server to bind to. "0.0.0.0" means binding to all
interfaces. The port number is optional and the default port number is 8443. The IP
address must match the common name (host name) in the certificate so that the
TLS socket won't bind to multiple IP addresses. The default setting is 0.0.0.0:8443.
TLS Private Key
Upload TLS private key. The size of the key file must be under 2MB. This file will
be renamed as 'private.pem' automatically.
TLS Cert
Upload TLS cert. The size of the certificate must be under 2MB. This is the
certificate file (*.pem format only) for TLS connection. This file will be renamed as
"certificate.pem" automatically. It contains private key for the client and signed
certificate for the server.
TLS Authentication
Name
Configure the user name for TLS authentication. If not configured, authentication
will be skipped.
TLS Authentication
Password
Configure the password for TLS authentication. This is optional.
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.

UCM6510 CDR Report and CDR API Guide
Page 9 of 13
CDR API URL FORMAT AND PARAMETERS
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.
Table 3: 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