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

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

В данном разделе приводится описание общего формата входящих уведомлений с типом 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	Тип мессенджера для инстанса - `telegram` для Telegram - `whatsapp` - для WhatsApp - `v3` - для MAX

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

Параметр	Тип	Описание
`chatId`	string	Идентификатор чата, в котором получено сообщение или файл
`chatType`	string	Тип чата. Возможные значения: `"user"`, `"group"`, `"supergroup"`, `"channel"`,`"bot"`
`sender`	string	Идентификатор отправителя сообщения или файла
`chatName`	string	Имя чата
`senderName`	string	Имя отправителя
`senderType`	string	Тип отправителя. Возможные значения: `"user"`, `"group"`, `"supergroup"`, `"channel"`, `"bot"`
`senderContactName`	string	Имя отправителя из списка контактов телефонной книги
`senderPhoneNumber`	integer	Номер телефона отправителя Если номер телефона скрыт, или контакт является группой, принимает значение `0`

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

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

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

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

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 4100000000,
    "wid": "79876543210@c.us",
    "typeInstance": "telegram"
  },
  "timestamp": 1763115112,
  "idMessage": "1763115112345",
  "senderData": {
    "chatId": "10000000",
    "chatType": "user",
    "sender": "10000000",
    "chatName": "Василиса Премудрая",
    "senderName": "Василиса Премудрая",
    "senderType": "user",
    "senderContactName": "Василиса Премудрая",
    "senderPhoneNumber": 79998887766
  },
  "messageData": {
    "typeMessage": "textMessage",
    "textMessageData": {
      "textMessage": "Я использую GREEN-API для отправки этого сообщения!"
    }
  }
}

Пример тела уведомления из группового чата#

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 4100000000,
    "wid": "79876543210@c.us",
    "typeInstance": "telegram"
  },
  "timestamp": 1763115112,
  "idMessage": "1763115112345",
  "senderData": {
    "chatId": "-10000000000000",
    "chatType": "channel",
    "sender": "10000000",
    "chatName": "Тридесятое царство",
    "senderName": "Василиса",
    "senderType": "user",
    "senderContactName": "",
    "senderPhoneNumber": 0
  },
  "messageData": {
    "typeMessage": "textMessage",
    "textMessageData": {
      "textMessage": "Я использую GREEN-API для отправки этого сообщения!"
    }
  }
}