WhatsApp Business Management API

Шаблоны с кодами купонов

Шаблоны с кодами купонов — это шаблоны категории "Маркетинг", в которых отображается одна кнопка копирования кода. При ее нажатии код копируется в буфер обмена на устройстве пользователя.

Ограничения

  • В настоящее время шаблоны с кодами купонов не поддерживаются в веб-клиенте WhatsApp.
  • Максимальная длина кода: 15 символов.
  • Текст кнопки нельзя настраивать.
  • В шаблоне может быть только одна кнопка копирования кода.

Создание шаблонов с кодами купонов

Для создания шаблонов с кодами купонов используйте конечную точку Аккаунт WhatsApp Business > Шаблоны сообщений.

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

POST /<WHATSAPP_BUSINESS_ACCOUNT_ID>/message_templates

Тело

{
  "name": "<NAME>",
  "language": "<LANGUAGE>",
  "category": "MARKETING",
  "components": [
    ... // Additional components, if using
    {
      "type":"BUTTONS",
      "buttons": [
        {
          "type":"COPY_CODE",
          "example": "<EXAMPLE>"
        },
        ... // Additional buttons, if using
      ]
    }
  ]
}

Свойства

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

<NAME>

Строка

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


Название шаблона.


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

fall2023_promotion

<LANGUAGE>

Перечисление

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


Язык и код региона, используемые в шаблоне.

en_US

<EXAMPLE>

Строка

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


Код купона, который копируется при нажатии.


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

25OFF

Ответ

В случае успеха API вернет следующий ответ:

{
   "category" : "<CATEGORY>",
   "id" : "<ID>",
   "status" : "<STATUS>"
}

Свойства ответа

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

<CATEGORY>

Перечисление

Категория шаблона.

MARKETING

<ID>

Строка цифр

ID шаблона.

1924084211297547

<STATUS>

Перечисление

Статус шаблона.

PENDING

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

curl 'https://graph.facebook.com/v21.0/102290129340398/message_templates' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
{
  "name": "coupon_code_fall2023_25off",
  "language": "en_US",
  "category": "MARKETING",
  "components": [
    {
      "type": "HEADER",
      "format": "TEXT",
      "text": "Our Fall Sale is on!"
    },
    {
      "type": "BODY",
      "text": "Shop now through November and use code {{1}} to get {{2}} off of all merchandise!",
      "example": {
        "body_text": [
          [
            "25OFF",
            "25%"
          ]
        ]
      }
    },
    {
      "type": "BUTTONS",
      "buttons": [
        {
          "type": "QUICK_REPLY",
          "text": "Unsubscribe"
        },
        {
          "type": "COPY_CODE",
          "example": "250FF"
        }
      ]
    }
  ]
}'

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

{
  "category" : "MARKETING",
  "id" : "1924084211297547",
  "status" : "PENDING"
}

Отправка шаблонов с купонами

Для отправки утвержденных шаблонов с кодами купонов в шаблонах сообщений используйте облачный API. См. статью Отправка шаблонов с кодами купонов.