getOrCreateConversation

Retrieves the Conversation object for a valid identifier. If the conversation does not exist, it will be created.

POST /v1/chat/conversations/get-or-create

Try it

cURL

cURL

curl --request POST \
  --url https://api.botpress.cloud/v1/chat/conversations/get-or-create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-bot-id: <x-bot-id>' \
  --data '
{
  "channel": "<string>",
  "tags": {},
  "integrationName": "<string>",
  "discriminateByTags": [
    "<string>"
  ]
}
'

200

{
  "conversation": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "channel": "<string>",
    "integration": "<string>",
    "tags": {},
    "currentTaskId": "<string>",
    "currentWorkflowId": "<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

Body

application/json

Conversation data

channel · string · required

Channel name

Maximum string length: 200

tags · object · required

Tags for the Conversation

Show child attributes

tags. {key} · string

Maximum string length: 500

integrationName · string · deprecated

[DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.

Maximum string length: 200

discriminateByTags · string[]

Optional list of tag names to use for strict matching when looking up existing conversations. If provided, all specified tags must match exactly for a conversation to be considered a match. For example, with an existing conversation whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.

Maximum string length: 500

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

conversation. id · string · required

Id of the Conversation

Required string length: 28 - 36

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

Creation date of the Conversation in ISO 8601 format

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

Updating date of the Conversation in ISO 8601 format

conversation. channel · string · required

Name of the channel where the Conversation is happening

conversation. integration · string · required

Name of the integration that created the Conversation

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

conversation.tags. {key} · string

conversation. currentTaskId · string

Id of the current Task

Required string length: 28 - 36

conversation. currentWorkflowId · string

Id of the current Workflow

Required string length: 28 - 36