Api Configuration - Grandstream Networks UCM6100 Series Cdr And Rec Api Manual

The UCM6100 supports third party billing interface API for external billing software to access CDR and
call recording files on the PBX. The API uses HTTPS to request the CDR data and call recording data
matching given parameters as configured on the third party application.

API CONFIGURATION

Before accessing the CDR API (to access call detail records) and REC API (to access call recording files),
the administrators need enable API and configure the access/authentication information on the UCM6100
first.
Enable Enable/Disable API. The default setting is disabled.
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
TLS Bind Address
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.
Upload TLS private key. The size of the key file must be under 2MB. This file will
TLS Private Key
be renamed as 'private.pem' automatically.
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
TLS Cert
"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
Name will be skipped.
TLS Authentication
Configure the password for TLS authentication. This is optional.
Password
Specify a list of IP addresses permitted by CDR and REC API. This creates an API-
specific access control list. Multiple entries are allowed.
Permitted IP(s) For example, "192.168.40.3/255.255.255.255" denies access from all IP addresses
except 192.168.40.3.
The default setting is blank, meaning all IP addresses will be denied.
API CONFIGURATION
Table 2: API Configuration Parameters
UCM6100 Series CDR and REC API Guide Page 8 of 17