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

Отправленное сообщение с изображением, видео, аудио, документом#

В данном разделе описывается формат входящего уведомления объекта messageData для отправленного сообщения с изображением, видео, аудио или документом. Для получения описания общего формата входящих уведомлений обратитесь к разделу Отправленные сообщения.

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

typeWebhook = outgoingMessageReceived || outgoingAPIMessageReceived

messageData.typeMessage = imageMessage || videoMessage || documentMessage || audioMessage

Настройка инстанса

Чтобы получать входящие уведомления об отправленных сообщениях с изображением, видео, аудио или документом, необходимо включить настройки одним из представленных вариантов:

  1. Через личный кабинет включить настройки Получать уведомления о сообщениях, отправленных с телефона и Получать уведомления о сообщениях, отправленных через API
    (дополнительно Получать уведомления о статусах отправленных сообщений для получения уведомлений о статусах отправленного сообщения)

  2. Через метод SetSettings включить настройки outgoingMessageWebhook и outgoingAPIMessageWebhook
    (дополнительно outgoingWebhook для получения уведомлений о статусах отправленного сообщения)

Уведомление#

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

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

Параметр Тип Описание
typeMessage string Тип отправленного сообщения. Для сообщений данного типа поле принимает значение: imageMessage, videoMessage, documentMessage, audioMessage
fileMessageData object Объект данных об отправленном файле

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

Параметр Тип Описание
downloadUrl string Ссылка для скачивания файла
caption string Описание под картинкой или видео
fileName string Название файла. Поле заполняется корректно только для typeMessage = documentMessage, в остальных случаях название файла генерируется автоматически
jpegThumbnail string Предпросмотр изображения в base64
mimeType string Тип файла, согласно классификации Media Types
isForwarded boolean Является ли сообщение пересланным, принимает значения true/false
forwardingScore integer Количество пересылок сообщения
videoNote boolean Поле не используется. Поле для видео сообщений. Принимает значение true - для мгновенного видео сообщения и false для обычного видео сообщения

При отправке изображений через API с разрешением свыше 3000х3000, не будет формироваться превью. Поле jpegThumbnail в сообщениях и получаемых уведомлениях будет пустым.

Остальные поля идентичны полям отправленных сообщений описанных в разделе Отправленные сообщения

Пример тела уведомления отправленного сообщения с изображением#

{
  "typeWebhook": "outgoingAPIMessageReceived",
  "instanceData": {
    "idInstance": 1101111111,
    "wid": "79876543210@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1732268220,
  "idMessage": "BAE5FE9D7433CC21",
  "senderData": {
    "chatId": "120363369140947676@g.us",
    "chatName": "GREEN-API",
    "sender": "79876543210@c.us",
    "senderName": "GREEN-API",
    "senderContactName": "GREEN-API"
  },
  "messageData": {
    "typeMessage": "imageMessage",
    "fileMessageData": {
      "fileName": "69e5.jpg",
      "mimeType": "image/jpeg",
      "jpegThumbnail": "",
      "isForwarded": true,
      "forwardingScore": 4,
      "isAnimated": false,
      "caption": "Картинка",
      "downloadUrl": "{{FileUrl}}"
    }
  }
}

Пример тела уведомления отправленного сообщения с аудио#

{
  "typeWebhook": "outgoingAPIMessageReceived",
  "instanceData": {
    "idInstance": 1101111111,
    "wid": "79876543210@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1732268220,
  "idMessage": "BAE5FE9D7433CC21",
  "senderData": {
    "chatId": "120363369140947676@g.us",
    "chatName": "GREEN-API",
    "sender": "79876543210@c.us",
    "senderName": "GREEN-API",
    "senderContactName": "GREEN-API"
  },
  "messageData": {
    "typeMessage": "audioMessage",
    "fileMessageData": {
      "fileName": "69e5.ogg",
      "mimeType": "audio/ogg; codecs=opus",
      "jpegThumbnail": "",
      "isForwarded": false,
      "forwardingScore": 0,
      "isAnimated": false,
      "caption": "",
      "downloadUrl": "{{FileUrl}}"
    }
  }
}

Пример тела уведомления отправленного сообщения с видео#

{
  "typeWebhook": "outgoingAPIMessageReceived",
  "instanceData": {
    "idInstance": 1101111111,
    "wid": "79876543210@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1732268220,
  "idMessage": "BAE5FE9D7433CC21",
  "senderData": {
    "chatId": "120363369140947676@g.us",
    "chatName": "GREEN-API",
    "sender": "79876543210@c.us",
    "senderName": "GREEN-API",
    "senderContactName": "GREEN-API"
  },
  "messageData": {
    "typeMessage": "videoMessage",
    "fileMessageData": {
      "fileName": "69e5.mp4",
      "mimeType": "video/mp4",
      "jpegThumbnail": "",
      "isForwarded": false,
      "forwardingScore": 0,
      "isAnimated": false,
      "caption": "Входящее с видео",
      "downloadUrl": "{{FileUrl}}"
    }
  }
}

Пример тела уведомления отправленного сообщения с документом#

{
  "typeWebhook": "outgoingAPIMessageReceived",
  "instanceData": {
    "idInstance": 1101111111,
    "wid": "79876543210@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1732268220,
  "idMessage": "BAE5FE9D7433CC21",
  "senderData": {
    "chatId": "120363369140947676@g.us",
    "chatName": "GREEN-API",
    "sender": "79876543210@c.us",
    "senderName": "GREEN-API",
    "senderContactName": "GREEN-API"
  },
  "messageData": {
    "typeMessage": "documentMessage",
    "fileMessageData": {
      "fileName": "69e5.pdf",
      "mimeType": "application/pdf",
      "jpegThumbnail": "",
      "isForwarded": false,
      "forwardingScore": 0,
      "isAnimated": false,
      "caption": "",
      "downloadUrl": "{{FileUrl}}"
    }
  }
}