getConversation

Retrieves the Conversation object for a valid identifier.

GET /v1/chat/conversations/{id}

cURL

cURL

curl --request GET \
  --url https://api.botpress.cloud/v1/chat/conversations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-bot-id: <x-bot-id>' \
  --header 'x-bp-authenticated-principal: <x-bp-authenticated-principal>'

200

{
  "conversation": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "channel": "<string>",
    "integration": "<string>",
    "tags": {},
    "messageCount": 123,
    "currentTaskId": "<string>",
    "properties": {}
  }
}

Authorizations

Authorization · string · header · required

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

Headers

x-bp-authenticated-principal · string · required

Authenticated principal. Injected by the authentication middleware.

x-bot-id · string · required

Bot id

x-integration-id · string

Integration id

x-integration-alias · string

Integration alias

x-real-ip · string

Caller's IP address. Injected by the edge proxy.

Path Parameters

id · string · required

Conversation id

Response

200

application/json

Returns a Conversation object if a valid identifier was provided. Returns an error otherwise

conversation · object · required

The Conversation object represents an exchange of messages between one or more users. A Conversation is always linked to an integration's channels. For example, a Slack channel represents a conversation.

Show child attributes