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

Входящее сообщение с изображением #

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

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

typeWebhook = incomingMessageReceived

messageData.typeMessage = imageMessage

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

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

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

  2. Через метод SetSettings включить настройку incomingWebhook

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

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

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

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

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

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

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

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

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
      "idInstance": 4100000000,
      "wid": "79876543210@c.us",
      "typeInstance": "tgm"
  },
  "timestamp": 1763115112,
  "idMessage": "1763115112345",
  "senderData": {
      "chatId": "10000000",
      "sender": "10000000",
      "chatName": "Василиса Премудрая",
      "senderName": "Василиса Премудрая",
      "senderContactName": "Василиса Премудрая",
      "senderPhoneNumber": 79876543210
  },
  "messageData": {
    "typeMessage": "imageMessage",
    "fileMessageData": {
        "downloadUrl": "https://4100.api.green-api.com/download/4100/15697d2c-397c-4fd0-8e1a-8be95f753aae.webp",
        "caption": "",
        "fileName": "1769056990000.jpg",
        "jpegThumbnail": "UklGRjoAAABXRUJQVlA4IC4AAACwAwCdASoyADIAPm0skkYkIqGhLggAgA2JaQAAZAEm0xUUDzF5wAD++yGAAAAA",
        "isAnimated": false,
        "mimeType": "image/jpg",
        "forwardingScore": 0,
        "isForwarded": false
    }
  }
}

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

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
      "idInstance": 4100000000,
      "wid": "79876543210@c.us",
      "typeInstance": "tgm"
  },
  "timestamp": 1763115112,
  "idMessage": "1763115112345",
  "senderData": {
      "chatId": "-10000000000000",
      "sender": "10000000",
      "chatName": "Тридесятое царство",
      "senderName": "Василиса",
      "senderContactName": "",
      "senderPhoneNumber": 0
  },
  "messageData": {
    "typeMessage": "imageMessage",
    "fileMessageData": {
        "downloadUrl": "https://4100.api.green-api.com/download/4100/15697d2c-397c-4fd0-8e1a-8be95f753aae.webp",
        "caption": "",
        "fileName": "1769056990000.jpg",
        "jpegThumbnail": "UklGRjoAAABXRUJQVlA4IC4AAACwAwCdASoyADIAPm0skkYkIqGhLggAgA2JaQAAZAEm0xUUDzF5wAD++yGAAAAA",
        "isAnimated": false,
        "mimeType": "image/jpg",
        "forwardingScore": 0,
        "isForwarded": false
    }
  }
}