Jump to Content
JaaS
Chapi
Contact Center
Home
Guides
API Reference
v1
JaaS
Chapi
Contact Center
v1
Home
Guides
API Reference
Search
JUMP TO
SMS API
Getting started with SMS API
Send API
Send SMS
post
Send SMS batch
post
Cancel batch of scheduled SMS
delete
SMS Success Feedback
post
Cancel the scheduled message
delete
Engage API
Send SMS Engage survey
post
Send SMS Engage surveys as batch
post
Reporting API
Start SMS log export job
post
Get log export job result
get
Cancel the log export job
delete
Retrieve SMS details
get
Remove Personally Identifiable Information (PII)
delete
Get SMS price list
get
Get account balance
get
Webhook Configuration API
Get all Webhooks for Account
get
Create or Replace webhooks
post
Delete webhooks
delete
SMS Callbacks Reference
Inbound SMS
Delivery receipts for outbound SMS
SMS Engage response webhook
SMS Delivery receipts error codes
Verification API
Getting started with Verification API
Verification API
Code generation
post
Code validation
get
Chatapps API
Getting started with Chat Apps API
Send API
Send message
post
Send message batch
post
Supported Chat Apps channels
Supported Chat Apps Content Types
Management API
Mark message as read
post
Get WhatsApp templates
get
Add WhatsApp template
post
Remove WhatsApp template
delete
Reporting API
Download Chat Apps Logs
Start log export job
post
Get log export job result
get
Cancel the log export job
delete
Retrieve message details
get
Webhook Configuration API
Get all Webhooks for Account
get
Create or Replace webhooks
post
Delete webhooks
delete
Chat Apps Callbacks Reference
Inbound Chat Apps message
Delivery receipts for outbound Chat Apps
Chat Apps Fallback management
Delivery Error Codes
Voice V1 API
Voice Messaging API
Send Single Voice Message
post
Send Many Voice Messages
post
Retrieve Voice Message Status
get
Voice Languages and Profiles
DTMF Callback
Number Masking API
How to implement 8x8 Number Masking?
Getting started with Number Masking
Number Masking API
Get My Virtual Numbers
get
Check Virtual Number
get
Webhooks
Get webhook information for your account
get
Create a new webhook
post
Delete a specific type of webhook
delete
Call Handle
Call Actions
Call Status
Session Status
Call Recordings
Virtual Number Updated
Voice IVR
Getting started with 8x8 IVR services
Voice IVR Call Handle
Say
Say&Capture
MakeCall
Hangup
Call Status
Session Status
Video Interaction API
Introduction
Management API
Token creation
post
Getting Started
Reporting API
Call Logs
get
Detail call
get
Retrieve Image
get
Token example creation
iframe integration
Number Lookup API
Getting started with Number Lookup API
Number Lookup API
Get phone number lookup data
get
Number Lookup Error Codes
Automation API
Getting started with Automation API
Triggers & Steps
Branches
Context & Scripting
Time zone & Onboarding
Examples
Workflow Definition Management
Retrieve a list of active workflow definitions.
get
Create a new workflow definition
post
Retrieve the version history of a workflow definition.
get
Update workflow definition
put
Delete workflow definition
delete
Test workflow definition
post
Workflow Instance Management
Retrieve a list of workflow instances
get
Retrieve workflow instance status
get
Update workflow instance status
patch
Retrieve a list of errors for a workflow instance
get
Workflow Triggers
Trigger workflows using an external event
post
Miscellaneous
Retrieve a list of supported time zones
get
Retrieve a list of supported JavaScript functions
get
Retrieve the allowed workflow counts and current usage
get
Retrieve a list of executed workflow counts by yearly
get
Contacts API
Getting started with Contacts API
Contacts API
Search contacts
get
Create contact
post
Get contact information by id
get
Delete single contact
delete
Update contact information
patch
Groups API
Search for groups
get
Create a group
post
Get group information by id
get
Delete group
delete
Update group information
patch
Add a contact to a group
post
Remove contacts from a group
delete
Batch API
Batch create contacts
post
Batch delete contacts
post
Copy contacts between groups
post
Move contacts between groups
post
Batch delete groups
post
Get batch information by id
get
Get batch job list
get
General API information
API Error codes
Message status reference
Price object reference
Webhook object structure
Security
IP address list
SMPP
SMPP - Connection
SMPP TLVs
SMPP - Delivery receipts
SMPP - Data encoding
Programmable Voice
Callflows API
MakeCall
Say
SayAndCapture
playFile
hangup
Use Cases (Sample Callflows)
Voice Message
Simple IVR
Session Status of Calls API
