List messages

Get a paginated list of messages in a conversation.

Get a paginated list of messages in a conversation. Results are ordered newest-first. Use direction to filter to inbound or outbound messages only. Messages the account owner sends from the native app (e.g. the Instagram app) are not stored or listed here; they are relayed by the message.sent webhook with source: native_app.

Permissions: Requires conversations:read. Access is limited by the API key creator's current organization membership and stored key ceiling. See Organization permissions.

GET
/v1/conversations/{id}/messages

Path Parameters

id*string

Query Parameters

direction?string
Value in"inbound""outbound"
cursor?string
limit?integer
Range1 <= value <= 200
Default50

Response Body

Messages retrieved successfully

application/json
  1. response

List of messages in a conversation

success*boolean
data*array<>
pagination*
Example Request
curl -X GET 'https://api.outstand.so/v1/conversations/string/messages'
Example Response
{  "success": true,  "data": [    {      "id": "string",      "conversationId": "string",      "platformMessageId": "string",      "direction": "inbound",      "source": "api",      "senderId": "string",      "content": "string",      "mediaUrls": [        "string"      ],      "quickReplies": [        {          "title": "string",          "id": "string"        }      ],      "buttons": [        {          "type": "postback",          "title": "string",          "id": "string"        }      ],      "interaction": {        "type": "quick_reply",        "id": "string"      },      "story": {        "type": "reply",        "id": "string",        "url": "string"      },      "replyTo": {        "messageId": "string"      },      "reaction": "string",      "status": "pending",      "error": "string",      "scheduledAt": "2019-08-24T14:15:22Z",      "platformSentAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "pagination": {    "hasMore": true,    "nextCursor": 0,    "limit": 0  }}