Getting Started with CommPeak APIs

CommPeak APIs let you connect your own applications, CRMs, and back-office tools to CommPeak products. They are REST APIs served over HTTPS that accept and return JSON, so you can call them from any language or HTTP client.

Most CommPeak APIs now share one address, https://api.commpeak.com, and one credential: an API key you create in the CommPeak Portal. Start here to choose your API, get your key, and make your first request in a few minutes.

Choose your API

Every API except the deprecated PBX Stats API is served from https://api.commpeak.com. Add the path for your API to that address, and authenticate with the credential shown.

For the Dialer API and PBX API, replace {sub_domain} with your company subdomain, for example acme. For the deprecated PBX Stats API, replace {instance} with the name of your PBX Stats instance. If you are not sure which value to use, contact CommPeak support.

Before you begin

Make sure you have the following:

• An active CommPeak account with the products you want to integrate. You can create API keys only after your customer account is fully activated.
• Access to the CommPeak Portal, where you create your Portal API key under Settings > API Access.
• For the TextPeak APIs, access to Settings > API Keys in TextPeak.
• An HTTP client, such as curl, Postman, or your preferred programming language.

Getting your API key

The Portal API key authenticates the Portal, Dialer, PBX, and Lookup APIs. To create one:

Send the key in the Authorization header of every request as the raw value, without a Bearer prefix: Authorization: <API_KEY>.

For every key option, such as read-only access and IP restrictions, and for TextPeak tokens and the PBX Stats API key, see Authentication and API Keys.

Making your first request

Store your credentials in environment variables instead of pasting them into commands or code. This way, they do not end up in your shell history, logs, or source control.

export COMMPEAK_API_KEY="your-portal-api-key"
export TEXTPEAK_API_KEY="your-textpeak-api-key"

Then pick the tab for your API, replace acme or <STREAM_ID> where needed, and run the request. Each one is a read-only call that confirms your key and connection work.

curl https://api.commpeak.com/portal/customer \
  -H "Authorization: $COMMPEAK_API_KEY"

curl 'https://api.commpeak.com/dialer/acme/api/calls/limit/10' \
  -H "Authorization: $COMMPEAK_API_KEY"

curl 'https://api.commpeak.com/pbx/acme/api/calls/limit/10' \
  -H "Authorization: $COMMPEAK_API_KEY"

curl https://api.commpeak.com/lookup/info \
  -H "Authorization: $COMMPEAK_API_KEY"

curl https://api.commpeak.com/textpeak/streams/<STREAM_ID>/token \
  -H "Authorization: $TEXTPEAK_API_KEY"

Prefer to start in code? These examples make the Portal API request in Python and Node.js. The Python example uses the requests library (pip install requests), and the Node.js example uses the built-in fetch in Node.js 18 or later, saved as an .mjs file.

import os
import requests

headers = {"Authorization": os.environ["COMMPEAK_API_KEY"]}
response = requests.get("https://api.commpeak.com/portal/customer", headers=headers)
print(response.status_code, response.json())

const response = await fetch("https://api.commpeak.com/portal/customer", {
  headers: { Authorization: process.env.COMMPEAK_API_KEY },
});
console.log(response.status, await response.json());

If the request succeeds, you get 200 and a JSON body. For example, the Portal API returns your account email and balances. The balance is in USD and does not include temporary_credit:

{
  "customer": {
    "email": "[email protected]",
    "balance": 465.28,
    "temporary_credit": 0,
    "sms_balance": 99.68,
    "sms_currency": "USD",
    "sms_platform": 1001
  }
}

If you get an error instead, see Troubleshooting your first request.

Next steps