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

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

Postman Apidog

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

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

typeWebhook = incomingMessageReceived

messageData.typeMessage = imageMessage

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

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

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

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

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

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

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

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

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

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

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

Параметр Тип Описание
stanzaId string id цитируемого сообщения
participant string id отправителя цитируемого собщения

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

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

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
      "idInstance": 3100000000,
      "wid": "79991234567@c.us",
      "typeInstance": "v3"
  },
  "timestamp": 1763115112,
  "idMessage": "1763115112345",
  "senderData": {
      "chatId": "10000000",
      "sender": "10000000",
      "chatName": "Ходабрыш Пробешёлов",
      "senderName": "Ходабрыш Пробешёлов",
      "senderContactName": "Ходабрыш Пробешёлов",
      "senderPhoneNumber": 79876543210
  },
  "messageData": {
    "typeMessage": "imageMessage",
    "fileMessageData": {
        "downloadUrl": "https://sw-media-3100.storage.yandexcloud.net/3100000000/15697d2c-397c-4fd0-8e1a-8be95f753aae.webp",
        "caption": "",
        "fileName": "15697d2c-397c-4fd0-8e1a-8be95f753aae.webp",
        "jpegThumbnail": "UklGRjoAAABXRUJQVlA4IC4AAACwAwCdASoyADIAPm0skkYkIqGhLggAgA2JaQAAZAEm0xUUDzF5wAD++yGAAAAA",
        "isAnimated": false,
        "mimeType": "image/webp",
        "forwardingScore": 0,
        "isForwarded": false
    }
  }
}

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

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
      "idInstance": 3100000000,
      "wid": "79991234567@c.us",
      "typeInstance": "v3"
  },
  "timestamp": 1763115112,
  "idMessage": "1763115112345",
  "senderData": {
      "chatId": "-69876543210123",
      "sender": "10000000",
      "chatName": "Название группы",
      "senderName": "Ходабрыш",
      "senderContactName": "",
      "senderPhoneNumber": 0
  },
  "messageData": {
    "typeMessage": "imageMessage",
    "fileMessageData": {
        "downloadUrl": "https://sw-media-3100.storage.yandexcloud.net/3100000000/15697d2c-397c-4fd0-8e1a-8be95f753aae.webp",
        "caption": "",
        "fileName": "15697d2c-397c-4fd0-8e1a-8be95f753aae.webp",
        "jpegThumbnail": "UklGRjoAAABXRUJQVlA4IC4AAACwAwCdASoyADIAPm0skkYkIqGhLggAgA2JaQAAZAEm0xUUDzF5wAD++yGAAAAA",
        "isAnimated": false,
        "mimeType": "image/webp",
        "forwardingScore": 0,
        "isForwarded": false
    }
  }
}

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

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
      "idInstance": 3100000000,
      "wid": "79991234567@c.us",
      "typeInstance": "v3"
  },
  "timestamp": 1763115112,
  "idMessage": "1763115112345",
  "senderData": {
      "chatId": "10000000",
      "sender": "10000000",
      "chatName": "Ходабрыш Пробешёлов",
      "senderName": "Ходабрыш Пробешёлов",
      "senderContactName": "Ходабрыш Пробешёлов",
      "senderPhoneNumber": 79876543210
  },
  "messageData": {
    "typeMessage": "imageMessage",
    "fileMessageData": {
        "downloadUrl": "https://sw-media-3100.storage.yandexcloud.net/3100000000/15697d2c-397c-4fd0-8e1a-8be95f753aae.webp",
        "downloadUrlJpeg": "https://sw-media-3100.storage.yandexcloud.net/3100000000/90076cf2-897d-4aa5-b08c-59cf2978c76f.jpg",
        "caption": "",
        "fileName": "15697d2c-397c-4fd0-8e1a-8be95f753aae.webp",
        "jpegThumbnail": "UklGRjoAAABXRUJQVlA4IC4AAACwAwCdASoyADIAPm0skkYkIqGhLggAgA2JaQAAZAEm0xUUDzF5wAD++yGAAAAA",
        "isAnimated": false,
        "mimeType": "image/webp",
        "forwardingScore": 0,
        "isForwarded": false
    }
  }
}