getMessage

Retrieves the Message object for a valid identifier.

GET /messages/{id}

Get Message

cURL

curl --request GET \
  --url https://chat.botpress.cloud/{webhookUrl}/messages/{id} \
  --header 'x-user-key: <x-user-key>'

200

{
  "message": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "payload": {
      "audioUrl": "<string>"
    },
    "userId": "<string>",
    "conversationId": "<string>"
  }
}

Headers

x-user-key · string · required

Authentication Key

Path Parameters

id · string · required

ID of the Message

Response

200

application/json

Returns a Message object if a valid identifier was provided

message · object · required

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

Show child attributes