Docs

getConversation

Retrieves the Conversation object for a valid identifier.

GET/v1/chat/conversations/{id}

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

Path parameters

idstring
Conversation id

Response

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

conversationobject
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.