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

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

Postman Apidog

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

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

typeWebhook = outgoingMessageReceived || outgoingAPIMessageReceived

messageData.typeMessage = imageMessage

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{
  "typeWebhook": "outgoingMessageReceived",
  "instanceData": {
    "idInstance": 3100000000,
    "wid": "79991234567@c.us",
    "typeInstance": "v3"
  },
  "timestamp": 1763115112,
  "idMessage": "1763115112345",
  "senderData": {
    "chatId": "10000000",
    "chatName": "Ходабрыш Пробешёлов",
    "chatType": "user",
    "sender": "10000000",
    "senderName": "Ходабрыш Пробешёлов",
    "senderType": "user",
    "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": "outgoingMessageReceived",
  "instanceData": {
    "idInstance": 3100000000,
    "wid": "79991234567@c.us",
    "typeInstance": "v3"
  },
  "timestamp": 1763115112,
  "idMessage": "1763468266381",
  "senderData": {
      "chatId": "-69876543210123",
      "chatName": "Название группы",
      "chatType": "group",
      "sender": "10000000",
      "senderName": "Ходабрыш",
      "senderType": "user",
      "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": "outgoingMessageReceived",
  "instanceData": {
    "idInstance": 3100000000,
    "wid": "79991234567@c.us",
    "typeInstance": "v3"
  },
  "timestamp": 1763115112,
  "idMessage": "1763115112345",
  "senderData": {
    "chatId": "10000000",
    "chatName": "Ходабрыш Пробешёлов",
    "chatType": "user",
    "sender": "10000000",
    "senderName": "Ходабрыш Пробешёлов",
    "senderType": "user",
    "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
    }
  }
}