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

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

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

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

typeWebhook = outgoingMessageReceived || outgoingAPIMessageReceived

messageData.typeMessage = productMessage

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

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

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

  2. Через метод SetSettings включить настройки outgoingMessageWebhook, outgoingAPIMessageWebhook и catalogWebhook

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

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

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

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

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

Параметр Тип Описание
productId string Уникальный идентификатор товара в WhatsApp
title string Название товара
description string Описание товара
currencyCode string Код валюты в формате ISO 4217 (например, RUB)
price string Цена товара
url string Ссылка на страницу товара
productImageCount integer Количество изображений товара
fileMessageData object Объект данных об изображении товара

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

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

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

{
  "typeWebhook": "outgoingAPIMessageReceived",
  "instanceData": {
    "idInstance": 1101111111,
    "wid": "79876543210@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1784017443,
  "idMessage": "3EB0AB5229B7284B80281E",
  "senderData": {
    "chatId": "79001234567@c.us",
    "chatName": "Иван",
    "sender": "79876543210@c.us",
    "senderName": "Продавец",
    "senderContactName": "Продавец"
  },
  "messageData": {
    "typeMessage": "productMessage",
    "productMessage": {
      "productId": "37389763923955288",
      "title": "Кружка керамическая",
      "description": "Ручная роспись, 350 мл",
      "currencyCode": "RUB",
      "price": "999.00",
      "url": "https://example.com/",
      "productImageCount": 1,
      "fileMessageData": {
        "downloadUrl": "https://media.whatsapp.net/v/t45.5328-4/709782393_1036145568744364_7226933118843139210_n.jpg",
        "jpegThumbnail": "/9j/2wCEAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEB",
        "isAnimated": false,
        "mimeType": "image/jpeg",
        "caption": "",
        "forwardingScore": 0,
        "isForwarded": false
      }
    }
  }
}