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

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

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

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

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

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

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

Параметр Тип Описание
idInstance integer Идентификатор аккаунта
wid string Идентификатор аккаунта в формате WhatsApp
typeInstance string Тип мессенджера для аккаунта

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

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

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

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

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

{
    "typeWebhook": "incomingMessageReceived",
    "instanceData": {
        "idInstance": 1234,
        "wid": "79001234567@c.us",
        "typeInstance": "whatsapp"
    },
    "timestamp": 1588091580,
    "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
    "senderData": {
        "chatId": "79001234568@c.us",
        "sender": "79001234568@c.us",
        "senderName": "Green API"
    },
    "messageData":{
       // В зависимости от typeMessage = textMessage || imageMessage || videoMessage || documentMessage || audioMessage || locationMessage || contactMessage || extendedTextMessage
       ...
       ...
       ...
        }
    }
}