Отправленные сообщения#
В данном разделе приводится описание общего формата входящих уведомлений с типом outgoingMessageReceived и outgoingAPIMessageReceived. Описание всех типов входящих уведомлений представлено в разделе Типы входящих уведомлений.
Система предусматривает получение уведомлений об исходящих сообщениях следующих видов:
- Статус отправленного сообщения
- Отправленное сообщение через API
- Отправленное текстовое сообщение
- Отправленное сообщение с изображением, видео, аудио, документом
- Отправленное шаблонное сообщение
Поля уведомления outgoingMessageReceived#
| Параметр | Тип | Описание |
|---|---|---|
typeWebhook | string | Тип входящего уведомления. Для уведомления данного типа поле принимает значение outgoingMessageReceived |
instanceData | object | Данные об инстансе |
timestamp | integer | Время наступления события в UNIX-формате |
idMessage | string | Идентификатор отправленного сообщения |
senderData | object | Данные об отправителе сообщения или файла |
messageData | object | Данные об отправленном сообщении или файле |
Поля объекта instanceData
| Параметр | Тип | Описание |
|---|---|---|
idInstance | integer | Идентификатор инстанса. Размер integer равен int64. Значения лежат в диапазоне от 1 до 10 разрядов |
wid | string | Идентификатор аккаунта в формате WhatsApp* |
typeInstance | string | Тип мессенджера для инстанса |
Поля объекта senderData
| Параметр | Тип | Описание |
|---|---|---|
chatId | string | Идентификатор чата, в который отправлено сообщение или файл |
sender | string | Идентификатор отправителя сообщения или файла |
chatName | string | Имя чата |
senderName | string | Имя отправителя |
senderContactName | string | Имя отправителя из списка контактов телефонной книги |
Поля объекта messageData#
Объект messageData имеет разные поля в зависимости от типа отправленного сообщения:
- Отправленное сообщение через API
- Отправленное текстовое сообщение
- Отправленное сообщение с изображением, видео, аудио, документом
- Отправленное шаблонное сообщение
Пример тела уведомления#
{
"typeWebhook": "outgoingMessageReceived",
"instanceData": {
"idInstance": 1101111111,
"wid": "79876543210@c.us",
"typeInstance": "whatsapp"
},
"timestamp": 1588091580,
"idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
"senderData": {
"chatId": "79001234567@c.us",
"sender": "79876543210@c.us",
"chatName": "GREEN-API",
"senderName": "GREEN-API",
"senderContactName": "GREEN-API"
},
"messageData":{
// В зависимости от typeMessage = textMessage || imageMessage || videoMessage || documentMessage || audioMessage || locationMessage || contactMessage
...
...
...
}
}