getOrCreateMessage

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

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

Try it

cURL

cURL

curl --request POST \
  --url https://api.botpress.cloud/v1/chat/messages/get-or-create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-bot-id: <x-bot-id>' \
  --data '
{
  "payload": {},
  "userId": "<string>",
  "conversationId": "<string>",
  "type": "<string>",
  "tags": {},
  "schedule": {
    "dateTime": "<string>",
    "delay": 123
  },
  "origin": "synthetic",
  "discriminateByTags": [
    "<string>"
  ]
}
'

200

{
  "message": {
    "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"
  }
}

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

Message data

payload · object · required

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

userId · string · required

ID of the User

Required string length: 28 - 36

conversationId · string · required

ID of the Conversation

Required string length: 28 - 36

type · string · required

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

Maximum string length: 200

tags · object · required

Set of Tags that you can attach to a Message. The set of Tags available on a Message 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

tags. {key} · string

Maximum string length: 500

schedule · object

Schedule the Message to be sent at a specific time. Either dateTime or delay must be provided.

Show child attributes

schedule. dateTime · string

When the Message will be sent, in the ISO 8601 format

Required string length: 24 - 28

schedule. delay · number

Delay in milliseconds before sending the Message

origin · enum<string>

Available options: synthetic

discriminateByTags · string[]

Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message 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 Message object if a valid identifier was provided. Returns an Error otherwise

message · object · required

The Message object represents a message in a Conversation for a specific User.

Show child attributes

message. id · string · required

Id of the Message

Required string length: 28 - 36

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

Creation date of the Message in ISO 8601 format

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

Update date of the Message in ISO 8601 format

message. type · string · required

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

Maximum string length: 200

message. payload · object · required

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

message. direction · enum<string> · required

Direction of the message (incoming or outgoing).

Available options: incoming, outgoing

message. userId · string · required

ID of the User

Required string length: 28 - 36

message. conversationId · string · required

ID of the Conversation

Required string length: 28 - 36

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

message.tags. {key} · string

message. origin · enum<string>

Origin of the message (synthetic).

Available options: synthetic