Messages
Send and read individual messages on any channel.
The message object
As returned by GET /messages/{id}. Every endpoint below that returns this resource returns exactly these fields.
| Name | Type | Description |
|---|---|---|
idrequired | string (uuid) | UUID |
conversation_idrequired | string (uuid) | UUID |
directionrequired | string (enum) | inbound = from the customerinboundoutbound |
sender_typerequired | string (enum) | bot = the assistant or an API key; agent = a member in the inboxcustomeragentbot |
typerequired | string (enum) | Content typetextimagedocumentaudiovideolocationtemplateinteractive |
textrequired | string | null | Body text, or the caption of a media message |
media_urlrequired | string | null | URL of the attached image, video, document or audio |
template_namerequired | string | null | The template this message was sent from, for template sends |
statusrequired | string (enum) | Delivery status as reported by the channelsendingsentdeliveredreadfailed |
channel_message_idrequired | string | null | The channel’s own id (a WhatsApp wamid, a Messenger mid) |
reply_to_message_idrequired | string (uuid) | null | The message this one replies to, when the customer quoted one |
created_atrequired | string (date-time) | ISO 8601 timestamp |
Endpoints
2 endpoints, each on its own page with its parameters, responses, error codes and samples in curl, Node and Python.