List messages
Load the message history of a conversation. Call the message service that matches the conversation's channel.
Endpoint
GET/conversation-messages-whatsapp
Same request for every channel:
GET /conversation-messages-instagramGET /conversation-messages-messengerGET /conversation-messages-webchatGET /conversation-messages-smsGET /conversation-messages-playground
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
conversation_id | integer | Yes | Conversation to load. Always send it. |
message_type[$ne] | string | No | message_type[$ne]=reaction hides reaction rows, like the inbox does. |
destination | string | No | incoming, outgoing, internal or system. |
created_at[$gte] / created_at[$lte] | string (date-time) | No | Date range. |
$limit | integer | No | Page size. Default 10, maximum 50. |
$skip | integer | No | Records to skip. |
$sort[created_at] | 1 | -1 | No | -1 = newest first (reverse it for chronological display). |
Any other message field can be used as a filter.
Request
Response
json
Fields are described in The message object.
Notes
- Deleted messages are not returned.
- Members restricted to some channel accounts get
403 Forbiddenfor conversations of accounts they cannot see.
Report an issue with this documentation
Please log in to report issues with our documentation.