Error
A valid request URL is required to generate request examples{
"data": {
"id": 123,
"sender_number_id": 123,
"recipient_user_id": 123,
"conversation_id": 123,
"message_id": 123,
"message_type": "text",
"content": "<string>",
"status": "sent",
"delivery_status": "read",
"request_payload": {},
"response_payload": {
"conversation_id": 123,
"message_id": 123,
"media_url": "<string>"
},
"sent_at": "2023-11-07T05:31:56Z"
}
}{
"message": "<string>",
"errors": {}
}Messages
Send a message
Send text as JSON, or send one image, document, uploaded audio file, or recorded voice note as multipart form data. Use audio for uploaded audio and reserve voice for recorded voice notes.
POST
/
messages
Error
A valid request URL is required to generate request examples{
"data": {
"id": 123,
"sender_number_id": 123,
"recipient_user_id": 123,
"conversation_id": 123,
"message_id": 123,
"message_type": "text",
"content": "<string>",
"status": "sent",
"delivery_status": "read",
"request_payload": {},
"response_payload": {
"conversation_id": 123,
"message_id": 123,
"media_url": "<string>"
},
"sent_at": "2023-11-07T05:31:56Z"
}
}{
"message": "<string>",
"errors": {}
}Authorizations
Body
application/jsonmultipart/form-data
Example:
"{recipient_phone}"
Use audio for uploaded audio files and voice for recorded voice notes.
Available options:
text, image, voice, audio, document Required when sender_phone is not provided.
Required when sender_number_id is not provided.
Example:
"{sender_phone}"
Message body for text; optional caption for image, document, and audio. Legacy voice captions are accepted for compatibility.
Required for voice and limited to 1–300 seconds. Optional for audio with a minimum of 1 and no 300-second limit. Omit for other types.
Required range:
x >= 1Response
Message accepted and logged.
Show child attributes
Show child attributes