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

Входящее текстовое сообщение#

Postman Apidog

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

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

typeWebhook = incomingMessageReceived

messageData.typeMessage = textMessage

Настройка инстанса

Чтобы получать входящие уведомления о входящих сообщениях, необходимо включить настройки одним из представленных вариантов:

  1. Через личный кабинет включить настройку Получать уведомления о входящих сообщениях и файлах

  2. Через метод SetSettings включить настройку incomingWebhook

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

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

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

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

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

Параметр Тип Описание
textMessage string Текстовое сообщение
isForwarded boolean Является ли сообщение пересланным, принимает значения true/false
forwardingScore integer Количество пересылок сообщения

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

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

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

  {
    "typeWebhook": "incomingMessageReceived",
    "instanceData": {
      "idInstance": 3100000000,
      "wid": "79991234567@c.us",
      "typeInstance": "v3"
    },
    "timestamp": 1588091580,
    "idMessage": "115206687571465794",
    "senderData": {
      "chatId": "10000000",
      "sender": "10000000",
      "chatName": "Ходабрыш Пробешёлов",
      "senderName": "Ходабрыш Пробешёлов",
      "senderContactName": "Ходабрыш Пробешёлов"
    },
    "messageData": {
      "typeMessage": "textMessage",
      "textMessageData": {
      "textMessage": "Я использую GREEN-API для отправки этого сообщения!"
      }
    }
}

{
    "typeWebhook": "incomingMessageReceived",
    "instanceData": {
        "idInstance": 3100000000,
        "wid": "79991234567@c.us",
        "typeInstance": "whatsapp"
    },
    "timestamp": 1588091580,
    "idMessage": "115206687571465794",
    "senderData": {
        "chatId": "10000000",
        "sender": "10000000",
        "senderName": "Иван",
        "senderContactName": "Иван Царевич"
    },
    "messageData": {
          "typeMessage": "quotedMessage",
          "extendedTextMessageData": {
            "text": "Цитируем это",
            "stanzaId": "115206612341443214",
            "participant": "10000000"
        }
    }
}