Входящее сообщение с кнопками#
В данном разделе описывается формат входящего уведомления объекта messageData для входящего сообщения с кнопками. Для получения описания общего формата входящих уведомлений обратитесь к разделу Входящие сообщения.
Для получения входящих уведомлений данного вида требуется выполнение двух условий:
typeWebhook = incomingMessageReceived
messageData.typeMessage = buttonsMessage
Настройка инстанса
Чтобы получать входящие уведомления о сообщениях с кнопками, необходимо включить настройки одним из представленных вариантов:
-
Через личный кабинет включить настройку
Получать уведомления о входящих сообщениях и файлах -
Через метод SetSettings включить настройку
incomingWebhook
Уведомление#
Формат уведомления#
Поля объекта messageData
| Параметр | Тип | Описание |
|---|---|---|
typeMessage | string | Тип принятого сообщения. Для сообщений данного типа поле принимает значение buttonsMessage |
buttonsMessage | object | Объект данных с кнопками |
quotedMessage | object | Объект данных о цитируемом сообщении. Присутствует только, если само сообщение является цитатой |
Поля объекта buttonsMessage
| Параметр | Тип | Описание |
|---|---|---|
contentText | string | Текстовое сообщение тела кнопок |
buttons | object | Объект данных с кнопками |
isForwarded | boolean | Является ли сообщение пересланным, принимает значения true/false |
forwardingScore | integer | Количество пересылок сообщения |
Поля объекта buttons
| Параметр | Тип | Описание |
|---|---|---|
buttonId | string | id кнопки |
buttonText | string | Текст кнопки |
Поля объекта quotedMessage
| Параметр | Тип | Описание |
|---|---|---|
stanzaId | string | id цитируемого сообщения |
participant | string | id отправителя цитируемого сообщения |
Остальные поля заполняются в зависимости от типа цитируемого сообщения и идентичны полям входящих сообщений описанных в разделе Входящие сообщения
Пример тела уведомления#
{
"typeWebhook": "incomingMessageReceived",
"instanceData": {
"idInstance": 310022693586,
"wid": "79991234567@c.us",
"typeInstance": "v3"
},
"timestamp": 1787561850,
"idMessage": "117149653456795542",
"senderData": {
"chatId": "10000000",
"chatName": "GREEN-API MAX:BOT",
"chatType": "bot",
"sender": "10000000",
"senderName": "GREEN-API MAX:BOT",
"senderType": "bot",
"senderContactName": "",
"senderPhoneNumber": 0
},
"messageData": {
"typeMessage": "buttonsMessage",
"buttonsMessage": {
"contentText": "Please select your language: \nПожалуйста, выберите язык:",
"buttons": [
{
"type": "reply",
"buttonId": "1",
"buttonText": "English"
},
{
"type": "reply",
"buttonId": "2",
"buttonText": "Русский"
}
],
"forwardingScore": 0,
"isForwarded": false
}
}
},
{
"typeWebhook": "incomingMessageReceived",
"instanceData": {
"idInstance": 310022693586,
"wid": "79991234567@c.us",
"typeInstance": "v3"
},
"timestamp": 1787558136,
"idMessage": "117149410064560990",
"senderData": {
"chatId": "10000000",
"chatName": "GREEN-API MAX:BOT",
"chatType": "bot",
"sender": "10000000",
"senderName": "GREEN-API MAX:BOT",
"senderType": "bot",
"senderContactName": "",
"senderPhoneNumber": 0
},
"messageData": {
"typeMessage": "buttonsMessage",
"buttonsMessage": {
"contentText": "Это видео отправлено методом *UploadFile*.\n\nДокументация:\n\nhttps://green-api.com/max-bot-api/docs/api/upload/UploadFile/",
"buttons": [
{
"type": "reply",
"buttonId": "1",
"buttonText": "Меню"
},
{
"type": "reply",
"buttonId": "2",
"buttonText": "Стоп"
}
],
"isForwarded": false,
"forwardingScore": 0,
"messageData": {
"typeMessage": "videoMessage",
"fileMessageData": {
"downloadUrl": "https://sw-media.storage.yandexcloud.net/310022693586/10ee3f36-3123-4985-9358-5491e82a02c5.mp4",
"fileName": "10ee3f36-3123-4985-9358-5491e82a02c5.mp4",
"jpegThumbnail": "UklGRjQAAABXRUJQVlA4ICgAAAAQAwCdASoyABwAP3G41WM0ryqmJAgCkC4JaQAAH2A8tGAA/uuuAAAA",
"isAnimated": false,
"mimeType": "video/mp4",
"videoNote": false
}
}
}
}
}