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-instagram
  • GET /conversation-messages-messenger
  • GET /conversation-messages-webchat
  • GET /conversation-messages-sms
  • GET /conversation-messages-playground

Query parameters

NameTypeRequiredDescription
conversation_idintegerYesConversation to load. Always send it.
message_type[$ne]stringNomessage_type[$ne]=reaction hides reaction rows, like the inbox does.
destinationstringNoincoming, outgoing, internal or system.
created_at[$gte] / created_at[$lte]string (date-time)NoDate range.
$limitintegerNoPage size. Default 10, maximum 50.
$skipintegerNoRecords to skip.
$sort[created_at]1 | -1No-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 Forbidden for conversations of accounts they cannot see.

Report an issue with this documentation

Please log in to report issues with our documentation.