Preview: The API is still being rolled out and details may change before launch. Follow progress in the changelog.
Message types
When you send with POST /v1/chats/{chat_id}/messages, put your messages in messages, an array of up to 5. Each message has a type that says what kind it is.
type |
Status | Description |
|---|---|---|
text |
Available | Text |
image |
Coming soon | An image, uploaded through POST /v1/uploads and referenced by upload_id |
sticker |
Coming soon | A sticker |
video |
Coming soon | A video |
audio |
Coming soon | Audio |
file |
Coming soon | A file |
template |
Coming soon | Buttons and cards (buttons, confirm, carousel); a tap sends the bot a postback event |
quickReply |
Coming soon | Quick reply buttons, attachable to any type |
Sending a type that isn’t available yet gets 422 UNSUPPORTED_MESSAGE_TYPE. Details of the “coming soon” types may change before they ship; follow the changelog.
{ "type": "text", "text": "Hi! How can I help today?" }| Field | Type | Rules |
|---|---|---|
type |
string | "text" |
text |
string | Not empty or whitespace only; at most 4,096 characters |
- Text is checked against the chat’s list of blocked terms. A match gets
422 BANNED_TERM.
Messages your bot receives
Section titled “Messages your bot receives”In a message event, message.kind tells you what kind of message the member sent. The bot gets message.text for text messages only. For images, videos or files it gets the kind only (downloading content through GET /v1/messages/{message_id}/content comes in a later version).