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

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

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 · int64Optional

pageTokenstringOptional

reversebooleanOptional

dateFromstring · date-timeOptional

Filter by created date after this date.

Responses

200

OK

application/json

Responseall of

403

User has no access to the requested resource

application/json

404

The resource specified in the URL was not found

application/json

409

The resource is in a conflicting state

application/json

get

/workspaces/{workspaceId}/conversations/{conversationId}/messages

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/conversations/{conversationId}/messages HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

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

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)

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