Documentation Portal
REST
Java
REST
Java
REST
Get SDK
OpenAPI
API Spec
Search
Ctrl + K
Pagination Metadata
Getting started
API portal overview
Base URL
Authentication
Error codes
API overview
User management
Overview
Users
Deleted users
Teams
Voice
Overview
Start call
Stop call
SMS
Send SMS
Digital messages
Overview
Message templates
Send messages
Campaigns
Overview
List campaigns
Add contacts
CDR
How to retrieve CDRs
Contact center management
Contact center balance
Agent application
Overview
Agent status
Wrap-up codes
Inbound routing
Overview
Queues
Number management
Overview
Numbers
Conversations
Overview
Messages
API Endpoints
CDR
GET
CDR
SMS
POST
Send SMS
Campaigns
POST
Add Contacts
GET
List Campaigns
Whats App
GET
List Templates
POST
Send Messages
Voice
POST
Stopcall
POST
Startcall
User Management
GET
Deleted Users
GET
Teams
GET
Users
Agent Application
GET
Wrap-Up Codes
GET
Agents Status
Inbound Routing
GET
Queues
Contact Center Balance
GET
Balance Request
Number Management
GET
List Numbers
Conversations
GET
Messages
Webhooks
Webhooks overview
Call Notify
Call notify overview
Call notify
Call outcome logging
Call outcome logging overview
Call outcome logging
Data transfer services
Data transfer services
Raw data streaming to SQS
Security log streaming to SQS
Call recordings replication to S3
Raw data streaming to SQS
Security log streaming to SQS
Call recordings replication to S3
Models
Structures
Validation Error Error
Campaign Contact
Phone Number
Flow
Pagination Metadata
Whatsapp Message
Recipient
Standard Response
Conversations Messages Response
Metadata
Success Agent Status Response
Click 2 Call Response
Whatsapp Template
Whatsapp Error
Success Response
Participant
Whatsapp Templates Error
Content Data
Campaigns Contacts 403 Error
Contact Center Balance
Message
Cdr Example Response
Success SMS Response
Campaign Contact List
Click 2 Call Hangup
Cdr Response
Errors
Wrapup Codes Entity
Numbers Response
Enumerations
Agentstatuses
Messages Content Type
Events
Type
Agent Status List
End Reason
Messages Participant Type
First Seen
Messages Status
Messages Activity Type
Whatsapp Templates Error Messages
Disposition Code
Content Type
Messages Activity
Whatsapp Error Messages
Exceptions
Whatsapp Error Error
Campaigns Contacts 403 Error Error
Whatsapp Templates Error Error
API Docs by
APIMATIC
Models
Structures
Pagination Metadata
#
Fields
Name
Description
limit
Number
offset
Number
total
Number
REST
Java
REST
Java
REST
{
"limit"
:
1
,
"offset"
:
0
,
"total"
:
1
}