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

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

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

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

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

Параметр Тип Описание
typeWebhook string Тип входящего уведомления. Для уведомления данного типа поле принимает значение incomingMessageReceived
instanceData object Данные об аккаунте

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

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

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

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

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

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

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

{
    "typeWebhook": "incomingMessageReceived",
    "instanceData": {
        "idInstance": 1234,
        "wid": "11001234567@c.us",
        "typeInstance": "whatsapp"
    },
    "timestamp": 1790141455,
    "idMessage": "3EB0A3191C8BB8437537",
    "senderData": {
        "chatId": "79001234568@c.us",
        "chatName": "GREEN-API",
        "sender": "79001234568@c.us",
        "senderName": "GREEN-API"
    },
    "messageData": {
        "typeMessage": "textMessage",
        "textMessageData": {
            "textMessage": "Hello"
        }
    }
}