Docs

listMessages

Retrieves a list of Message you’ve previously created. The messages are returned in sorted order, with the most recent appearing first. The list can be filtered using Tags.

GET/v1/chat/messages

Authorization

AuthorizationBearer
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Header parameters

x-bp-authenticated-principalstring
Authenticated principal. Injected by the authentication middleware.
x-bot-idstring
Bot id
x-integration-id?string
Integration id
x-integration-alias?string
Integration alias

Query parameters

nextToken?string
Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
pageSize?integer
Number of items to return per page (default 20, max 100)
conversationId?string
Conversation id
tags?object
Filter by tags
afterDate?string
Date in ISO 8601 string with UTC timezone after which the message was created (inclusive)
beforeDate?string
Date in ISO 8601 string with UTC timezone before which the message was created (inclusive)

Response

Returns a list of Message objects.

messagesobject[]
metaobject