Chat API
- Introduction
- Endpoints
Admin API
- Getting started
- Concepts
- Endpoints
Files API
Tables API
- Getting Started
- Endpoints
Runtime API
- Getting Started
- Concepts
- Endpoints
- POSTcreateConversation
- GETlistConversations
- GETgetConversation
- PUTupdateConversation
- DELdeleteConversation
- POSTgetOrCreateConversation
- GETlistParticipants
- POSTaddParticipant
- GETgetParticipant
- DELremoveParticipant
- POSTcreateEvent
- GETlistEvents
- GETgetEvent
- POSTcreateMessage
- GETlistMessages
- POSTgetOrCreateMessage
- GETgetMessage
- PUTupdateMessage
- DELdeleteMessage
- POSTcreateUser
- GETlistUsers
- GETgetUser
- PUTupdateUser
- DELdeleteUser
- POSTgetOrCreateUser
- POSTsetStateExpiry
- GETgetState
- POSTsetState
- PATCHpatchState
- POSTgetOrSetState
- POSTcallAction
- POSTconfigureIntegration
- GETlistTagValues
- POST
getMessage
Retrieves the Message object for a valid identifier.
GET
/
v1
/
chat
/
messages
/
{id}
curl --request GET \
--url https://api.botpress.cloud/v1/chat/messages/{id}
{
"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": {}
}
}
Path Parameters
Id of the Message
Response
200
application/json
Returns a [Message](#schema_message) object if a valid identifier was provided. Returns an [Error](#errors) otherwise
The Message object represents a message in a Conversation for a specific User.
Type of the Message represents the resource type that the message is related to
Maximum length:
200
Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location
Direction of the message (incoming
or outgoing
).
Available options:
incoming
, outgoing
ID of the Conversation
Required string length:
28 - 36
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.
Was this page helpful?
curl --request GET \
--url https://api.botpress.cloud/v1/chat/messages/{id}
{
"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": {}
}
}