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

Предоставление клиентам информации о товарах

Компании могут предоставлять клиентам информацию о товарах несколькими способами:

Сообщения с каталогом

Сообщения с каталогом — это сообщения в свободной форме, которые позволяют вам демонстрировать весь ваш каталог товаров в WhatsApp.

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

Когда клиент нажимает кнопку Просмотр каталога, ваш каталог товаров отображается в WhatsApp.

Требования

Ваш ассортимент должен быть загружен в Meta в каталог электронной коммерции, связанный с вашим аккаунтом WhatsApp Business.

Синтаксис запроса

Чтобы отправлять сообщения с каталогом, используйте конечную точку Номер телефона WhatsApp Business > Сообщения.

POST /<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>/messages

Основной текст

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "<TO>",
  "type": "interactive",
  "interactive" : {
    "type" : "catalog_message",
    "body" : {
      "text": "<BODY_TEXT>"
    },
    "action": {
      "name": "catalog_message",
      "parameters": {
        "thumbnail_product_retailer_id": "<THUMBNAIL_PRODUCT_RETAILER_ID>"
      }
    },

    /* Footer object is optional */
    "footer": {
      "text": "<FOOTER_TEXT>"
  }
}

Свойства

ЗаполнительОписаниеПример значения

<BODY_TEXT>

Строка

Обязательный параметр.


Текст, который будет отображаться в теле сообщения.


Максимальное количество символов: 1 024.

Hello! Thanks for your interest. Ordering is easy. Just visit our catalog and add items to purchase.

<FOOTER_TEXT>

Строка

Необязательный.


Текст, который будет отображаться в нижнем колонтитуле сообщения.


Максимальное количество символов: 60.

Best grocery deals on WhatsApp!

<THUMBNAIL_PRODUCT_RETAILER_ID>

Строка

Обязательный параметр.


SKU товара. Отмечается в Commerce Manager как ID контента.


В качестве изображения заголовка в этом сообщения будет использоваться миниатюра этого товара.


Если объект parameters отсутствует, будет использоваться изображение товара первого элемента каталога.

2lc20305pt

<TO>

Строка

Номер телефона клиента.

16505551234

Пример запроса

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "16505551234",
  "type": "interactive",
  "interactive": {
    "type": "catalog_message",
    "body": {
      "text": "Hello! Thanks for your interest. Ordering is easy. Just visit our catalog and add items to purchase."
    },
    "action": {
      "name": "catalog_message",
      "parameters": {
        "thumbnail_product_retailer_id": "2lc20305pt"
      }
    },
    "footer": {
      "text": "Best grocery deals on WhatsApp!"
    }
  }
}'

Пример ответа

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "16505551234",
      "wa_id": "16505551234"
    }
  ],
  "messages": [
    {
      "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgARGBI0ODVEREUwQzEzQkVBRjQ1RUUA"
    }
  ]
}

Шаблоны сообщений с каталогом

Шаблоны сообщений с каталогом — это шаблоны сообщений, содержащие кнопку, при нажатии которой открывается ваш каталог товаров в WhatsApp.

Чтобы отправлять сообщения на основе шаблона с каталогом, сначала нужно создать шаблон каталога. Узнать больше о том, как создавать эти шаблоны и отправлять их в шаблонах сообщений, можно в документе Шаблоны с каталогом.

Сообщения со ссылками на каталог товаров

Компании могут отправить ссылку на весь каталог своих товаров, создав ссылку wa.me и добавив ее в стандартное текстовое сообщение. При отправке текстового сообщения компании могут использовать необязательный параметр preview_url со значением true, чтобы в сообщении отображался набор миниатюр каталога товаров для любого URL-адреса в строке сообщения body.

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

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

https://wa.me/c/

Пример:

https://wa.me/c/15555455657

Сообщения о товарах

Сообщения об одном или нескольких товарах являются сообщениями типа interactive.

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

Обзор

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

  1. Просмотр товаров: покупатели могут просмотреть список товаров или только один товар. Всякий раз, когда пользователь нажимает на определенный товар, мы получаем актуальную информацию о товаре и показываем товар в формате страницы сведений о продукте. В настоящее время страницы сведений о товаре поддерживают только изображения товаров — файлы видео или GIF, прикрепленные к товару, на этой странице отображаться не будут.
  2. Добавление товаров в корзину: пользователь может добавить товары в свою корзину или изменить их количество напрямую из списка или на странице сведений о продукте. Всякий раз, когда пользователь добавляет товар в корзину для покупок, мы получаем последнюю информацию об этом товаре. Если статус какого-либо товара изменился, мы показываем сообщение "Один или несколько товаров в вашей корзине были обновлены". Подробнее см. в разделе Обновления товаров. Корзина сохраняется в переписке между компанией и покупателем до тех пор, пока она не будет отправлена компании. Подробнее см. в разделе Корзина для покупок.
  3. Отправка корзины в компанию: после добавления необходимых товаров покупатели могут отправить свою корзину той компании, с которой они переписываются. После этого компании могут определить следующие действия, например запрос информации о доставке или предоставление информации о вариантах оплаты.

Если у покупателя есть несколько устройств, связанных с одной и той же учетной записью WhatsApp, сообщения с информацией об одном или нескольких товарах будут синхронизированы между этими устройствами. Однако корзина остается локальной для каждого конкретного устройства. Подробнее.

В настоящее время сообщения таких типов можно получать на следующих платформах:

  • iOS: 2.21.100 (сообщения о нескольких товарах) и 2.21.210 (сообщения об одном товаре).
  • Android: 2.21.9.15 (сообщения о нескольких товарах) и 2.21.19 (сообщения об одном товаре).
  • Веб: запущен веб-клиент, поддерживающий эти функции.

Если версия приложения получателя не поддерживает сообщения о нескольких товарах или сообщения с одним товаром, вместо этого он получит сообщение, объясняющее, что ему не удалось получить сообщение, поскольку он использует устаревшую версию WhatsApp. Компания также получит уведомление Webhooks с информацией о том, что сообщение не удается доставить, потому что получатель использует устаревшую версию WhatsApp.

Ожидаемое поведение для сообщений

Сообщения об одном или нескольких товарах можно:

  • пересылать от одного пользователя другому;
  • открывать повторно в рамках одного чата.

Сообщения с информацией о каталоге, сообщения с информацией об одном или нескольких товарах нельзя:

  • отправлять в виде уведомлений (их можно отправлять только как часть существующего чата).

Обновления товаров

У компаний может возникнуть необходимость обновить свойства товаров в своем каталоге. В зависимости от обновленного свойства, мы обрабатываем все сообщения, в которых упоминается этот товар, следующим образом:

Обновленное свойствоПроцесс обновления

Цена товара, его название, описание и изображение.

  1. Компания отправляет сообщение об одном или нескольких товарах, в котором указан товар А.
  2. Компания обновляет свойства товара А в своем каталоге.
  3. Экраны, на которых отображается этот товар, обновляются сразу же, как только приложение клиента получает от сервера информацию об изменении.

Изменение доступности

  1. Компания отправляет покупателю сообщение об одном или нескольких товарах, в котором указан товар Б.
  2. Компания продает все доступные единицы товара B. Затем компания обновляет свой каталог и указывает, что товар Б более не доступен.
  3. Если покупатель уже добавил товар B в корзину, он будет оттуда удален. В корзине показывается диалог с сообщением "Один или несколько товаров в вашей корзине были обновлены".
  4. Если покупатель не добавлял товар Б в корзину, в сообщении об одном или нескольких товарах теперь указывается, что этот товар недоступен.

Корзина для покупок

После просмотра товаров покупатель может добавить их в свою корзину и отправить ее компании. В контексте торговли в WhatsApp корзина покупок:

  • Используется только для той переписки между человеком и компанией, которая ведется на конкретном устройстве: только одна корзина создается для каждой переписки между покупателем и компанией, и при этом корзины не переносятся с одного устройства на другое. После отправки корзины покупатель может открыть другую корзину для компании и снова начать весь процесс.
  • Не имеет даты истечения срока действия: корзина сохраняется в чате до тех пор, пока не будет отправлена компании. После отправки корзина очищается.

Покупатели могут добавить в корзину до 99 единиц каждого отдельного товара из каталога, но количество отдельных товаров, которые можно добавить в корзину, не ограничено.

После отправки корзины какие-либо изменения невозможны. Покупатели могут отправить новую корзину, если им нужны новые товары или они хотят изменить свой заказ. Компании не могут отправлять корзины покупателям.

Пример использования корзины для покупок и стандартный алгоритм изменения состояния товара.

Преимущества

Сообщения с информацией об одном или нескольких товарах больше всего подходят для простого и персонализированного взаимодействия с пользователем, при котором лучше направить покупателя к группе наиболее актуальных для него товаров, чем показывать ему весь ассортимент компании.

Просто и эффективно

Сочетание этих функций с инструментами навигации, такими как NLP (обработка естественного языка), текстовый поиск или сообщения со списком и кнопки ответа, позволяет быстро найти то, что ищет клиент.

Индивидуальный подход

Сообщения заполняются динамически, что позволяет персонализировать их для каждого отдельного покупателя или в зависимости от ситуации. Например, вы можете показать сообщение о нескольких товарах, содержащее позиции, наиболее часто заказываемые покупателем.

Повышение эффективности компании

Эффективный канал для стимулирования продаж: тестирование показало, что у компаний, использовавших сообщения о нескольких товарах, показатель конверсии этих продуктов в товары, которые затем были добавлены в отправленные корзины, в среднем составил 7 %.

Никаких шаблонов

Интерактивным сообщениям не требуются шаблоны или предварительные подтверждения. Они генерируются в режиме реального времени и всегда будут отражать последние сведения о товарах, ценах и количестве имеющихся у вас запасов.

Когда это следует использовать

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

  • Покупки в форме общения. Например, использование функции поиска позволяет покупателям вводить список покупок, а компании — отправлять им в ответ сообщение о нескольких товарах.
  • Переход к определенной категории, Например, к одежде для фитнеса.
  • Персонализированные предложения или рекомендации.
  • Повторный заказ ранее приобретенных товаров. Например, пользователь может ещё раз оформить заказ товаров, которые обычно покупает. В заказе может быть не более 30 позиций.

Сообщения об одном товаре лучше всего подходят для направления клиентов к одной конкретной позиции в ассортименте компании, предлагая быстрые ответы из ограниченного набора вариантов, таких как:

  • Ответ на конкретный запрос покупателя.
  • Предоставление рекомендации.
  • Повторный заказ ранее купленного товара.

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

Начало работы

Перед отправкой каждого сообщения вам необходимо получить ID WhatsApp получателя, выполнив вызов к узлу /contacts.

Рекомендуем настроить Webhooks для получения статуса сообщений и уведомлений о входящих сообщениях. Это позволит вам отслеживать как отправку сообщений, так и ответы от покупателей.

Шаг 1. Создайте интерактивный объект

Сообщения об одном товаре

Для отправки сообщения об одном товаре создайте объект interactive типа product с использованием следующих компонентов:

ОбъектОписание

body

Необязательный.

Объект body. См. все варианты для объекта body.

footer

Необязательный.

Объект footer. См. все варианты для объекта footer.

action

Обязательный параметр.

Поле действия должно содержать:

  • catalog_id: ID каталога, который вы хотите использовать для этого сообщения. Этот ID можно получить с помощью Commerce Manager.
  • product_retailer_id: уникальный идентификатор товара.

См. все варианты для объекта action.

В итоге интерактивный объект должен выглядеть примерно так:

"interactive": {
    "type": "product",
    "body": {
      "text": "text-body-content"
    },
    "footer": {
      "text": "text-footer-content"
    },
    "action": {
      "catalog_id": "catalog-id",
      "product_retailer_id": "product-SKU-in-catalog"
    }
}

Сообщения с несколькими товарами

Для отправки сообщения о нескольких товарах создайте объект interactive типа product_list с приведенными ниже компонентами:

ОбъектОписание

header

Обязательный параметр.

Для параметра type заголовка необходимо указать значение text. Не забудьте добавить объект text с желаемым контентом. См. все доступные поля объекта header.

body

Обязательный параметр.

Объект body. См. все варианты для объекта body.

footer

Необязательный.

Объект footer. См. все варианты для объекта footer.

action

Обязательный параметр.

Поле действия должно содержать:

  • catalog_id: ID каталога, который вы хотите использовать для этого сообщения. Этот ID можно получить с помощью Commerce Manager.
  • sections: массив объектов раздела. Необходимо добавить хотя бы один раздел.

Внутри каждого раздела можно указать следующее:

  • title: укажите заголовок для каждого раздела, если планируете использовать более одного.
  • product_items: массив объектов товаров, которые должны быть отображены.

Каждый объект товара содержит product_retailer_id, который соответствует уникальному идентификатору товара. Этот ID можно получить с помощью Commerce Manager. См. все варианты для объекта action.

В итоге объект interactive должен выглядеть примерно так:

"interactive": 
    {
    "type": "product_list",
    "header":{
       "type": "text",
        "text": "text-header-content"
     },
     "body":{
        "text": "text-body-content"
      },
     "footer":{
        "text":"text-footer-content"
     },
     "action":{
        "catalog_id":"catalog-id",
        "sections": [
             {
             "title": "the-section-title",             
             "product_items": [
                  { "product_retailer_id": "product-SKU-in-catalog" },
                  { "product_retailer_id": "product-SKU-in-catalog" },
                            ...
              ]},
              {
              "title": "the-section-title",
              "product_items": [
                 { "product_retailer_id": "product-SKU-in-catalog" }
                           ...
              ]},
               ...
       ]
     },  
    }

Отсутствующие элементы

Если ни один из элементов, указанных в вызовах API выше, не соответствует товару из принадлежащего компании каталога Facebook, то отправляется сообщение об ошибке, а сообщение об одном или нескольких товарах пользователю не отправляется.

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

  • сообщения отправляются;
  • элементы, не имеющие совпадений, исключаются; и
  • компания получает сообщение об ошибке с просьбой обновить каталог.

Шаг 2. Добавьте общие параметры сообщений

После завершения создания интерактивного объекта добавьте другие параметры, которые являются частью сообщения: recipient_type, to и type. Не забудьте установить для параметра type значение interactive.

{
  "recipient_type": "individual",
  "to" : "whatsapp-id", // WhatsApp ID of the recipient
  "type": "interactive",
  "interactive":{
    // The interactive object  
   }
  }

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

Шаг 3. Выполните вызов POST к /messages

Выполните вызов POST к конечной точке /messages с использованием объекта JSON, созданного на шагах 1 и 2. В случае успешной отправки сообщения вы получите следующий ответ:

{
  "messages": [{
    "id": "{message-id}"
  }]
  }

Шаблоны сообщений о нескольких товарах

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