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

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

В данном разделе приводится описание общего формата входящих уведомлений с типом incomingMessageReceived. Описание всех типов входящих уведомлений представлено в разделе Типы входящих уведомлений.

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

Поля уведомления incomingMessageReceived#

Параметр Тип Описание
typeWebhook string Тип входящего уведомления. Для уведомления данного типа поле принимает значение incomingMessageReceived
instanceData object Данные об инстансе
timestamp integer Время наступления события в UNIX-формате
idMessage string Идентификатор входящего сообщения
senderData object Данные об отправителе сообщения или файла
messageData object Данные о принятом сообщении или файле

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

Параметр Тип Описание
idInstance integer Идентификатор инстанса. Значение типа uint64, 10 разрядов
wid string Идентификатор аккаунта
typeInstance string Тип мессенджера для инстанса
Поле принимает значение v3 для мессенджера MAX
Поле принимает значение whatsapp - для мессенджера WhatsApp

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

Параметр Тип Описание
chatId string Идентификатор чата, в котором получено сообщение или файл
sender string Идентификатор отправителя сообщения или файла
chatName string Имя чата
senderName string Имя отправителя
senderContactName string Имя отправителя из списка контактов телефонной книги
senderPhoneNumber integer Номер телефона отправителя

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

Объект messageData имеет разные поля в зависимости от типа входящего сообщения:

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

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