Перейти к содержанию

Входящее сообщение с шаблонным кнопками#

В данном разделе описывается формат входящего уведомления объекта messageData для входящего шаблонного сообщения с кнопками. Для получения описания общего формата входящих уведомлений обратитесь к разделу Входящие сообщения.

Для получения входящих уведомлений данного вида требуется выполнение двух условий:

typeWebhook = incomingMessageReceived

messageData.typeMessage = templateMessage

Уведомление#

Формат уведомления#

Поля объекта messageData

Параметр Тип Описание
typeMessage string Тип принятого сообщения. Для сообщений данного типа поле принимает значение templateMessage
templateMessage object Объект данных с кнопками
quotedMessage object Объект данных о цитируемом сообщении. Присутствует только, если само сообщение является цитатой

Поля объекта templateMessage

Параметр Тип Описание
namespace string Пространство имен организации
elementName string Имя шаблонного сообщения
contentText string Текстовое сообщение тела кнопок
footer string Текстовое сообщение подвала кнопок
buttons object Объект данных с кнопками

Поля объекта buttons

Параметр Тип Описание
index string Порядок кнопки
urlButton object Объект данных url кнопки
callButton object Объект данных кнопки обратного звонка
quickReplyButton object Объект данных кнопки быстрого ответа

Поля объекта urlButton

Параметр Тип Описание
displayText string Текст url кнопки
url string Ссылка

Поля объекта callButton

Параметр Тип Описание
displayText string Текст кнопки обратного звонка
phoneNumber string Номер телефона

Поля объекта quickReplyButton

Параметр Тип Описание
displayText string Текст кнопки быстрого ответа
id string id кнопки быстрого ответа

Поля объекта quotedMessage

Параметр Тип Описание
stanzaId string id цитируемого сообщения
participant string id отправителя цитируемого сообщения
typeMessage string Тип цитируемого сообщения

Остальные поля заполняются в зависимости от типа цитируемого сообщения и идентичны полям входящих сообщений описаннных в разделе Входящие сообщения

Пример тела уведомления#

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1234,
    "wid": "11001234567@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1588091580,
  "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
  "senderData": {
    "chatId": "79001234568@c.us",
    "sender": "79001234568@c.us",
    "senderName": "Green API"
  },
    "messageData": {
        "typeMessage": "templateMessage",
        "templateMessage": {
            "contentText": "Hello",
            "footer": "Hello",
            "buttons": [
                {
                    "urlButton": {
                        "displayText": "⭐ Star us on GitHub!",
                        "url": "https://github.com/green-api/docs"
                    },
                    "index": 1
                },
                {
                    "callButton": {
                        "displayText": "Call us",
                        "phoneNumber": "+1 (234) 5678-901"
                    },
                    "index": 2
                },
                {
                    "quickReplyButton": {
                        "displayText": "Hello",
                        "id": "plainButtonId"
                    },
                    "index": 3
                }
            ]
        }
    }
}