API Management in Cloud PBX

In Settings > API Management, you can:

create API users for integrations that call your Cloud PBX directly
view the API documentation
monitor API logs.

API users

📘
NOTE
To call the PBX API through https://api.commpeak.com, use a Portal API key instead of an API user. See Authentication and API Keys. API users are only for integrations that still call your subdomain directly at https://{subdomain}.td.commpeak.com/api. That address will be deprecated.

Follow these steps to create an API user.

Open API Management

Navigate to API Management in Settings.

Screenshot of API Management in the Settings menu — **API Management** in the **Settings** menu

Create an API user

Click Create New API User.

Enter the user details

Enter data for the new user and configure settings as needed:

Username: Authorized individuals will use this username to authenticate and access the PBX API. You will be able to generate a password in the next step
Realm: This option is pre-set and should remain as API
API User IP ACL:

❗️
IMPORTANT
You must enter one or more IP addresses from which the user will make API calls. Use the provided example for IP formats.

Mask Phone Number: Select the checkbox to apply Phone Number Masking for the user to limit their access to phone number data according to the main settings
HLRLookup: Choose this option to enable the HLR LookUp when the user runs POST requests to add leads to the Dialer
Activate the user by selecting the Active? option.

API user settings

Create the user

Click Create.

Copy the password

Copy the password that will appear at the top of the page for a few seconds.

Screenshot of the password of the API user — Password of the API user

To modify settings for existing users, click the Edit button in Actions for the user you wish to change. To remove a user, click Delete.

API documentation

When you navigate to Settings > API Management > API Documentation, the system redirects you to the CommPeak PBX API Reference.

API logs

You can monitor API usage and performance in the API Logs tab in Settings > API Management. Run the search filters at the top of the table to find the needed records using the date, username, and other filter parameters. Then, you can view the records on the screen or export them as a file.