Jump to Content
Home
Documentation
API Reference
<> API Reference
✓ Status Page
Log In
Request Live Demo
API Reference
Log In
Request Live Demo
Home
Documentation
API Reference
<> API Reference
✓ Status Page
Reset Token
JUMP TO
Dialer API v2.0.0
Overview
Core API Concepts
Common and Useful API Examples
Dispatch Automation (Recomended)
Dispatch Leads
get
Dispatch Statuses
get
Calls
Get all calls
get
Get aggregated call stats
get
Get specific call
get
Get specific call's record file
get
Campaigns
Get specific campaign
get
Update specific campaign
put
Delete specific campaign
delete
Get all campaigns
get
Clone campaign (Create)
post
Delete Leads
get
CampaignLeads
Get campaign leads
get
Mass assign leads
put
Mass delete
put
Move to campaign
put
Update Campaign leads
put
Mass unassign leads
put
Click2Call
Call
get
Comments
Get comments
get
Create comment
post
Create mass comments
post
DNC
Get DNC
get
Delete DNC
delete
Approve DNC phone
get
UnApprove DNC phone
get
Get DNC list
get
Create DNC
post
Get DNC by phone
get
Mass Approve/Unapprove DNC numbers
post
Leads
Get all leads
get
Delete Leads
put
Update Leads
put
Create Lead
post
Update Lead
put
Delete Lead
delete
Get Extended information about lead(s)
put
LeadFiles
Get all lead files
get
Get all lead files by params
get
Statuses
Get all statuses
get
Get specific status
get
Users
Get all users
get
Create User
post
Get user
get
Update User
put
Delete User
delete
Get Breaks
get
Get Users Breaks
get
User Desks
Get desks
get
Create desk
post
Update desk
put
User Groups
Get all groups
get
Get assigned users
get
Get assigned campaigns
get
Get group
get
Update group
put
Delete group
delete
Get priority groups
get
Get skill group by priority group id
get
Update priority group
put
User Skill Groups
Get skill groups
get
Create skill group
post
User Roles
Get List Of Roles
get
Get User role
get
Update User role
put
Logs
Get all logs
get
Get logs object types
put
Get api logs
get
Speech Recognition
Send Speech with callback URL
get
Send to speech recognition
post
Get Speech for call id
get
Get all language
get
Dynamic Caller IDs (DID)
Get dynamic caller ids by params
get
Get all dynamic caller ids
get
Update dynamic caller ids
post
Route Caller IDs (DID)
Get Route Caller IDs
get
Enable/Disable Route CallerID
put
Create Route CallerID
post
Get Route CallerID
get
Delete Route CallerID
delete
Timezones
Get all timezones
get
CDRs
Get all CDRs
get
Devices
Get devices list
get
Update device
put
Create Device
post
Get device
get
Delete device
delete
Call Center Regions
Get Call Center Regions
get
TextPeak API V1.0.0
Streams
Get Messages
get
Get All Streams
get
Add Streams
post
Get Streams
get
Update Streams
put
Delete Streams
delete
Get Stream Token
get
Reset Token
get
Stream Event Templates
Get All Stream Event Templates
get
Create Stream Event Template
post
Get Stream Event Template
get
Update Stream Event Template
put
Delete stream event template
delete
Webhooks Management
Get All Webhooks
get
Create Webhook
post
Get Webhook
get
Update Webhook
put
Delete Webhook
delete
Senders
Get All Senders
get
Add Sender
post
Get Sender
get
Update Sender Name
put
Delete Sender
delete
Domains
Get All Domains
get
Add Domain
post
Get Domain
get
Delete Domain
delete
Archive/Unarchive Domain
put
Webhooks
Message Delivery
post
Message EDR Information
post
Incoming Message
post
Short URL Click
post
Cloud PBX API v2.0.0
Overview
Core API Concepts
Calls
Get all calls
get
Get specific call
get
Get specific call's record file
get
Click2Call
Call
get
User
Get all users
get
Create User
post
Get user
get
Update User
put
Delete User
delete
Get Breaks
get
Get Users Breaks
get
User Desks
Get desks
get
Create desk
post
Update desk
put
User Roles
Get User roles
get
Get User role
get
Update User role
put
Logs
Get all logs
get
Get logs object types
put
Get api logs
get
Speech Recognition
Send Speech with callback URL
get
Send to speech recognition
post
Get Speech for call id
get
Get all language
get
Route Caller IDs (DID)
Get Route Caller IDs
get
Enable/Disable Route CallerID
put
Create Route CallerID
post
Get Route CallerID
get
Delete Route CallerID
delete
CDRs
Get all CDRs
get
Devices
Get devices list
get
Update device
put
Create Device
post
Get device
get
Delete device
delete
Call Center Regions
Get Call Center Regions
get
PBX Stats API
Overview
CDRs
Ongoing CDRs
post
Search CDRs
post
Management
Whisper Call
post
Hangup Call
post
List Prefixes
post
List Pause Types
post
List Desks
post
List Desks With IDs
post
Manage Agents
List Agents
post
Agent Statistics
post
Add Agent
post
Edit Agent
post
Pause Agent
post
UnPause Agent
post
Delete Agent
post
Add Device
post
CommPeak Billing API
Overview
Customer
Customer Details
get
Rates
Current Rates
get
Search Current Rates by Prefix
get
Download Current Rates
get
Lookup API
Overview
Token Info
Get Token Info
get
Requests
Sync Request
get
Async Request
post
Async Upload
post
Get Result
get
Get Metadata
get
Download Result
get
Search Results
post
SMS API Gateway
SMS
Send message
post
Event send
post
message status
post
SMS OTP
Send OTP - with code generation
post
Verify OTP (Code generated by CommPeak)
post
Reset Token
get
https://textpeak.commpeak.com/api/v1/streams/
{id}
/token/reset
Reset token
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
RESPONSE
Click
Try It!
to start a request and see the response here!