Api Configuration; Api Configuration Parameters; Table 106: Api Configuration Parameters - Grandstream Networks UCM6100 Series User Manual

The UCM6100 supports third party billing interface API for external billing software to access CDR and call
recordings 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 Parameters

Before accessing the API, the administrators need enable API and configure the access/authentication
information on the UCM6100 first under Value-added Features→API Configuration. The API configuration
parameters are listed in the table below.
CDR HTTP API Settings
Basic Settings
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.
Configure the user name for TLS authentication. If not configured, authentication will
User Name
be skipped.
Password Configure the password for TLS authentication. This is optional.
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.
Other Settings
Upload TLS private key. The size of the key file must be under 2MB. This file will be
TLS Private Key
renamed as 'private.pem' automatically.

API Configuration

Table 106: API Configuration Parameters

UCM6100 Series User Manual
Version 1.0.18.13
P a g e | 336