Overview
Send an SMS
Receive an SMS
SMS actions
Action: Forward
Action: Reply
SMS delivery reports
SMS history
Get SMS by ID
Send an MMS
Receive an MMS
MMS history
Get MMS by ID
Make a phone call
Receive a phone call
Call actions
Action: Connect
Action: Connect to SIP
Action: Play
Action: IVR
Action: Record
Action: Hangup
Option: Recordcall
Call history
Get phone call by ID
Call from client
Voice streaming
WebSocket messages
Message: sync
Message: interrupt
Audio formats
Allocate a number
Deallocate a number
Configure a number
Get number by ID
List all numbers
Activate Conversations
Send a question
Receive a reply
Conversation history
Get conversation by ID
MMS image history
Get MMS image by ID
Get MMS image file
Recording history
Get recording by ID
Get recording .wav file
Get account details
Update account
Create a subaccount
Update a subaccount
Get subaccount details
Get all subaccounts
VOIP SIP
WebRTC SIP
SIP server IP addresses
Using GET requests instead of POST
Verify callback origin
OpenAPI Specification
Audio Formats
Audio payloads are Base64-encoded raw audio in the negotiated format.
The format is defined by the sending or listening message and may differ
between directions. The API allows up to 30 MB of queued outbound audio
at any time.
Codec
Sending
Listening
Description
pcm_8000✓ ✓ 16-bit PCM, 8 kHz, mono
pcm_16000✓ ✓ 16-bit PCM, 16 kHz, mono
pcm_24000✓ ✓ 16-bit PCM, 24 kHz, mono
alaw✓ ✓ G.711 A-law, 8 kHz
ulaw✓ ✓ G.711 µ-law, 8 kHz
g722✓ ✓ G.722, 16 kHz
ogg✓ ✓ Opus in Ogg container
wav✓ — WAV container
mp3✓ — MP3