To Next Page

To Previous Page

P a g e | 324

UCM6200 Series User Manual

API Configuration

The UCM6200 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.

Before accessing the API, the administrators need enable API and configure the access/authentication

information on the UCM6200 first. The API configuration parameters are listed in the table below.

Table 113: API Configuration Files

Enable

Enable/Disable 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.

Username

Configure the Username for API Authentication.

Password

Configure the Password for API Authentication.

Permitted IPs

Specify a list of IP addresses permitted by API. This creates an AIP-specific access

control list. Multiple entries are allowed.

For example, "192.168.5.20/255.255.255.255" denies access from all IP addresses

except 192.168.5.20.

The default setting is blank, meaning all IPs will be denied. Users must set permitted

IP address before connecting to the API.

For more details on CDR API (Access to Call Detail Records) and REC API (Access to Call Recording Files),

please refer the document in the link here:

http://www.grandstream.com/sites/default/files/Resources/ucm6xxx_cdr_rec_api_guide.pdf

Grandstream Networks UCM6204 User Manual

Other manuals for Grandstream Networks UCM6204