Cdr Api Configuration Files - Grandstream Networks UCM6510 User Manual

To sort the recording file, click on the title "Caller", "Callee" or "Call Time" for the corresponding column.
Click on the title again can switch the sorting mode between ascending order and descending order.
CDR A PI C ONFIGURATION F ILES
The UCM6510 supports third party billing interface API for external billing software to access CDR on the
PBX. The A PI uses HTTPS to request the CDR data matching given parameters as configured on the third
party application. Before accessing the API, the administrators need enable API and configure the
access/authentication information on the UCM6510 first.
Enable Enable/Disable CDR A PI. The default setting is disabled.
TLS Bind A ddress 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 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 A PI is as below.
https://[UCM IP]:[Port]/cdrapi?[option1]=[value]&[option2]=[value]&...
By default, the port number for the A PI 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
Firmware Version 1.0.2.5
Table 107: CDR API Configuration Files
UCM6510 IP PBX User Manual Page 294 of 317