List conversation messages

List conversation messages

get

Lists conversation messages. This will return a maximum of 100 messages per page, with 10 as default. You can use the limit and pageToken query parameters to paginate the results. Learn more about pagination in the Common API Usage pagination section.

Authorizations

MessageBird_userMessageBird_accessKey

Path parameters

workspaceIdstring · uuidrequired

The workspace ID

Example: b4e02c85-c6d2-4b15-8885-e09671799c61

conversationIdstring · uuidrequired

The conversation ID

Example: 67e4d358-ca94-421e-98b7-448860df9d33

Query parameters

limitinteger · min: 1 · max: 100 · default: 10optional

Limits the number of results to return

Example: 10

pageTokenstring · max: 8000optional

Pagination token that keeps of track of the current position in the list

Example: WyIyMDI0LTExLTE1VDEzOjM0OjQ1Ljc3NTYzMDE0OVoiLCJhMGEwM2IxOS03NTQ5LTRlZmUtOTBjZS1jNzdlYzI0ZjZmN2YiXQ==

reverseboolean · default: falseoptional

Order in which to retrieve the results

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.bird.com/workspaces/{workspaceId}/conversations/{conversationId}/messages' \
  --header 'Authorization: Bearer JWT'

200

403

404

200

{
  "results": [
    null
  ],
  "nextPageToken": "WyIyMDI0LTExLTE1VDEzOjM0OjQ1Ljc3NTYzMDE0OVoiLCJhMGEwM2IxOS03NTQ5LTRlZmUtOTBjZS1jNzdlYzI0ZjZmN2YiXQ=="
}

OK

Examples

Request

curl "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/conversations/16e1df9e-c6ac-406b-b1ce-13f34d0dea08/messages" \
-H "Authorization: AccessKey abcd"

Response (200 - OK)

{
  "results": [
    {
      "id": "0c854061-6026-48c7-a2e8-bffb6458727b",
      "conversationId": "16e1df9e-c6ac-406b-b1ce-13f34d0dea08",
      "reference": "",
      "sender": {
        "id": "68b80b8d-8060-42df-bda3-73505a8fdb84",
        "type": "accessKey",
        "status": "active",
        "displayName": "My first email key",
        "avatarUrl": ""
      },
      "draft": false,
      "recipients": [
        {
          "type": "to",
          "id": "8f0b5377-2edc-4116-a8e8-6a475f245a04",
          "identifierKey": "emailaddress",
          "identifierValue": "[e-mail]",
          "platformAddress": "[e-mail]",
          "contactAnnotation": {
            "name": "John Doe"
          }
        }
      ],
      "status": "delivered",
      "source": "conversations",
      "body": {
        "type": "text",
        "text": {
          "text": "Hey, listen!"
        }
      },
      "interactions": null,
      "createdAt": "2024-11-25T20:12:10.514Z",
      "updatedAt": "2024-11-25T20:12:35.281Z"
    },
    {
      "id": "3e75a9d2-2a54-45ac-856a-bbe02f874332",
      "conversationId": "16e1df9e-c6ac-406b-b1ce-13f34d0dea08",
      "reference": "3e75a9d2-2a54-45ac-856a-bbe02f874332",
      "sender": {
        "id": "8f0b5377-2edc-4116-a8e8-6a475f245a04",
        "type": "contact",
        "status": "active",
        "displayName": "John Doe",
        "avatarUrl": "",
        "contact": {
          "identifierKey": "emailaddress",
          "identifierValue": "[e-mail]",
          "platformAddress": "[e-mail]",
        }
      },
      "draft": false,
      "status": "delivered",
      "source": "channels",
      "body": {
        "type": "html",
        "html": {
          "text": "test\r\n",
          "html": "<p>test</p>"
        }
      },
      "interactions": null,
      "createdAt": "2024-11-25T19:31:47.264Z",
      "updatedAt": "2024-11-25T19:31:47.264Z",
      "meta": {
        "extraInformation": {
          "email_headers": "eyJTdWJqZWN0IjpbInRlc3QiXX0="
        }
      },
      "receiverTypes": [
        "to"
      ]
    }
  ]
}

Note: if the conversation has more than 10 messages, the results may be paginated. Please refer to Pagination on how to use nextPageToken.