Manage Cloud PBX calls, users, devices, caller IDs, and logs through the PBX API.
The PBX API gives you programmatic access to Cloud PBX: calls and call records, users, devices, caller IDs, logs, and speech recognition. Use it to bring PBX call data into your own tools or to manage users and devices without opening the PBX.
Send requests to https://api.commpeak.com/pbx/{sub_domain}/api with your Portal API key in the Authorization header. The key needs Full access (all services). Click2Call is the exception: you call it on your own subdomain. For authentication, paging, filtering, and rate limits, see Core API Concepts. For your first request, see Getting Started with CommPeak APIs.
Call management
Get all calls or a specific call, and download a call's recording.
Click2Call
Click2Call starts a call by first ringing an agent's extension. Once the agent answers, CommPeak connects the agent to the target number. This endpoint runs on your own subdomain, not through api.commpeak.com. See Click2Call Integrations Overview.
User management
Get all users or a specific user, and create, update, or delete users. You can also get the break types and users' break sessions.
Logs
Get the audit logs to see system usage and activity within a time frame, and filter them by object type. To audit or troubleshoot your API requests, use Get API logs.
Speech recognition
Send a completed call to speech recognition, get the result for a call, or send the result to a callback URL. To see which languages you can use, get the supported languages.
Route caller IDs (DID)
Manage the caller IDs assigned to your routes: get all route caller IDs or a specific one, create one, enable or disable it, or delete it.
Call detail records
Get all CDRs for calls made in your PBX, or aggregate them for reporting.
Device management
Get all devices connected to your PBX or a specific device, and create, update, or delete devices.
Reference data
Get a reference dataset to map the codes in call data to readable labels, for example Q.850 cause codes, SIP response codes, or call statuses.
Call center regions
Get the call center regions to see which PBX domains are available.