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

Try it

cURL

cURL

curl --request GET \
  --url https://api.botpress.cloud/v1/chat/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'x-bot-id: <x-bot-id>'

200

{
  "messages": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "type": "<string>",
      "payload": {},
      "direction": "incoming",
      "userId": "<string>",
      "conversationId": "<string>",
      "tags": {},
      "origin": "synthetic"
    }
  ],
  "meta": {
    "nextToken": "<string>"
  }
}

Authorizations

Authorization · string · header · required

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

Headers

x-bot-id · string · required

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

conversationId · string

Conversation id

tags · object

Filter by tags

Show child attributes

tags. {key} · string

Response

200

application/json

Returns a list of Message objects.

messages · object[] · required

Show child attributes

messages. id · string · required

Id of the Message

Required string length: 28 - 36

messages. createdAt · string<date-time> · required

Creation date of the Message in ISO 8601 format

messages. updatedAt · string<date-time> · required

Update date of the Message in ISO 8601 format

messages. type · string · required

Type of the Message represents the resource type that the message is related to

Maximum string length: 200

messages. payload · object · required

Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location

messages. direction · enum<string> · required

Direction of the message (incoming or outgoing).

Available options: incoming, outgoing

messages. userId · string · required

ID of the User

Required string length: 28 - 36

messages. conversationId · string · required

ID of the Conversation

Required string length: 28 - 36

messages. tags · object · required

Set of Tags that you can attach to a Conversation. The set of Tags available on a Conversation is restricted by the list of Tags defined previously by the Bot. Individual keys can be unset by posting an empty value to them.

Show child attributes

messages.tags. {key} · string

messages. origin · enum<string>

Origin of the message (synthetic).

Available options: synthetic

meta · object · required

Show child attributes

meta. nextToken · string

The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint.