Skip to main content
Send a media message by URL or by direct file upload. Requires an open 24-hour session, same as free-form text.

Endpoint

Required ability: messages.send.

Headers

Use multipart/form-data when uploading via media_file. Use application/json when referencing media_url.

Path parameters

string
required
Your workspace subdomain.

Body parameters

string
required
Recipient phone number. 10–15 characters.
string
required
One of image, document, video, audio. Stickers are not supported via API.
string
Public URL of the media asset. Required if media_file is not supplied.
file
Uploaded media file. Required if media_url is not supplied.
string
Caption for image, video, or document. Max 1024 characters.
string
Display filename for document messages. Max 255 characters.
object
Optional contact payload for creating or updating the contact behind this send.

Example request

Example response

200 OK

Error responses