createMessage

Creates a new Message. When creating a new Message, the required tags must be provided. See the specific integration for more details.

POST /v1/chat/messages

cURL

cURL

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

201

{
  "message": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "type": "<string>",
    "payload": {},
    "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-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.

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

schedule · object

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

Show child attributes

origin · enum<string>

Available options: synthetic

Response

201

application/json

Returns a Message object if creation succeeds.

message · object · required

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

Show child attributes