Перейти к основному содержимому

Шаблоны промокодов | Документация для разработчиков

Шаблоны промокодов

Обновлено: 3 декабря 2025 г
Шаблоны купонов — это маркетинговые шаблоны, отображающие одну кнопку для копирования кода. При нажатии на нее код копируется в буфер обмена клиента.

Ограничения

    В настоящее время веб-клиент WhatsApp не поддерживает шаблоны промокодов.Текст кнопки «Копировать код» изменить нельзя.В шаблонах доступна только одна кнопка для копирования кода.

    Создание шаблонов купонных кодов

    Используйте POST / /message_templates для создания шаблонов купонных кодов.

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

    curl 'https://graph.facebook.com/<API_VERSION> /<WHATSAPP_BUSINESS_ACCOUNT_ID> /message_templates' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer<ACCESS_TOKEN> ' \ -d ' { "name": "<TEMPLATE_NAME> ", "язык": "<TEMPLATE_LANGUAGE> ", "категория": "маркетинг", "компоненты": [<!-- Only if using a header component --> { "type": "header", "format": "text", "text": "<HEADER_TEXT> " }, { "type": "body", "text": "<BODY_TEXT> ",<!-- Only include if body text includes one or more parameters --> "пример": { "body_text": [ [ "<BODY_PARAMETER_EXAMPLE_VALUE> "<!-- Additional examples values would follow, if using multiple body parameters --> ] ] } }, { "type": "buttons", "buttons": [<!-- Only if using a quick-reply button --> { "type": "quick_reply", "text": "<QUICK_REPLY_BUTTON_LABEL_TEXT> " }, { "type": "copy_code", "example": "<COPY_CODE_BUTTON_EXAMPLE_CODE> " } ] } ] }'
    Параметры запроса
    
Заполнитель

Описание

Пример значения

    <ACCESS_TOKEN>
    Нить
    Необходимый.
    Токен доступа.
    EAAN...
    <API_VERSION>
    Нить
    Необязательный.
    Версия API. Если этот параметр опущен, по умолчанию используется самая новая версия API, доступная для вашего приложения.
    v23.0
    <BODY_PARAMETER_EXAMPLE_VALUE>
    Нить
    Обязательно, если используется строковый компонент тела документа, содержащий один или несколько параметров.
    Пример значения параметра. Необходимо указать пример для каждого параметра, определенного в строке компонента тела документа.
    0itCfer5xDB14SHWLACB
    <BODY_TEXT>
    Нить
    Необходимый.
    Шаблон основного текста. Поддерживаются переменные.
    Максимальное количество символов: 1024.
    Делайте покупки с сегодняшнего дня до конца декабря и используйте одноразовый код {{1}}, чтобы получить скидку {{2}} на весь ваш заказ!
    <COPY_CODE_BUTTON_EXAMPLE_CODE>
    Нить
    Необходимый.
    Код, который будет скопирован в буфер обмена устройства при нажатии.
    Максимум 20 символов.
    fLBponPDsqF0KQThzkrf
    <HEADER_TEXT>
    Нить
    Обязательно при использовании компонента текстового заголовка.
    Заголовочный текст.
    Максимум 60 символов.
    Наша зимняя распродажа началась!
    <QUICK_REPLY_BUTTON_LABEL_TEXT>
    Обязательно при использовании кнопки быстрого ответа.
    Текст надписи на кнопке. Максимум 25 символов. Только буквенно-цифровые символы.
    Отписаться
    <TEMPLATE_LANGUAGE>
    Нить
    Необходимый.
    Код языка шаблонов .
    en_US
    <TEMPLATE_NAME>
    Нить
    Необходимый.
    Название шаблона. Должно быть уникальным, за исключением случаев, когда существующие шаблоны с тем же именем имеют другой язык программирования.
    Максимум 512 символов. Только строчные буквы, буквы и цифры, а также символы подчеркивания.
    купон_одноразовый_зимний_2025
    <WHATSAPP_BUSINESS_ACCOUNT_ID>
    Нить
    Необходимый.
    Идентификатор бизнес-аккаунта WhatsApp.
    102290129340398
    Синтаксис ответа
    В случае успеха:
    { "идентификатор": "<TEMPLATE_ID> ", "статус": "<TEMPLATE_STATUS> ", "категория": "<TEMPLATE_CATEGORY> " }
    Параметры отклика
    
Заполнитель

Описание

Пример значения

    <TEMPLATE_CATEGORY>
    МАРКЕТИНГ
    <TEMPLATE_ID>
    Идентификатор шаблона.
    1627019861106475
    <TEMPLATE_STATUS>
    В ОЖИДАНИИ
    Пример запроса
    curl 'https://graph.facebook.com/ v25.0 /102290129340398/message_templates' \ - H 'Content-Type: application/json' \ - H 'Authorization: Bearer EAAJB...' \ - d ' { "name": "coupon_code_onetime_winter_2025", "language": "en_US", "category": "marketing", "components": [ { "type": "header", "format": "text", "text": "Наша зимняя распродажа началась!" }, { "type": "BODY", "text": "Покупайте сейчас до конца декабря и используйте одноразовый код {{1}}, чтобы получить скидку {{2}} на весь ваш заказ!", "example": { "body_text": [ [ "fLBponPDsqF0KQThzkrf", "30%" ] ] } }, { "type": "BUTTONS", "buttons": [ { "type": "QUICK_REPLY", "text": "Unsubscribe" }, { "type": "COPY_CODE", "example": "fLBponPDsqF0KQThzkrf" } ] } ] }'
    Пример ответа
    { "category" : "MARKETING", "id" : "1924084211297547", "status" : "PENDING" }
    Отправка шаблонов купонов
    Синтаксис запроса
    Используйте POST /  /messages для отправки утвержденного шаблона купона в шаблонном сообщении.
    curl -X POST "https://graph.facebook.com/<API_VERSION> /<BUSINESS_PHONE_NUMBER_ID> /messages" \ -H "Авторизация: Bearer"<ACCESS_TOKEN> " \ -H "Content-Type: application/json" \ -d ' { "messaging_product": "whatsapp", "to": "<USER_PHONE_NUMBDER> ", "type": "template", "template": { "name": "<TEMPLATE_NAME> ", "язык": { "код": "<TEMPLATE_LANGUAGE> " }, "components": [ { "type": "button", "sub_type": "copy_code", "index":<BUTTON_INDEX> , "параметры": [ { "тип": "код_купона", "код_купона": "<COUPON_CODE> " } ] }<!-- Additional components would follow, if templates requires them --> ] } }'
    Параметры запроса
    
Заполнитель

Описание

Пример значения

    <ACCESS_TOKEN>
    Нить
    Необходимый.
    Токен доступа.
    EAAN...
    <API_VERSION>
    Нить
    Необязательный.
    Версия API. Если этот параметр опущен, по умолчанию используется самая новая версия API, доступная для вашего приложения.
    v23.0
    <BUSINESS_PHONE_NUMBER_ID>
    Нить
    Необходимый.
    Идентификатор бизнес-телефона WhatsApp.
    106540352242922
    <BUTTON_INDEX>
    Целое число
    Необходимый.
    Указывает порядок отображения кнопок, если шаблон содержит несколько кнопок.
    Кнопки имеют нулевую индексацию, поэтому установка значения 0  затем — другая кнопка с индексом 1 
    0
    <COUPON_CODE>
    Нить
    Необходимый.
    Код купона, который будет скопирован при нажатии покупателем кнопки. Принимаются только буквенно-цифровые символы.
    Максимум 20 символов.
    25OFF
    <TEMPLATE_NAME>
    Нить
    Необходимый.
    Название шаблона, который необходимо отправить.
    купон_код_осень2023_25скидка
    <TEMPLATE_LANGUAGE>
    Нить
    Необходимый.
    Языковой и локализационный код шаблона.
    en_US
    <USER_PHONE_NUMBER>
    Нить
    Необходимый.
    Идентификатор WhatsApp или номер телефона клиента, которому нужно отправить сообщение. См. Форматы номеров телефонов .
    +16505551234
    Синтаксис ответа
    В случае успеха API ответит следующим образом:
    { "messaging_product": "whatsapp", "contacts": [ { "input": "<WHATSAPP_USER_PHONE_NUMBER> ", "wa_id": "<WHATSAPP_USER_ID> " } ], "messages": [ { "id": "<WHATSAPP_MESSAGE_ID> ", "group_id": "<GROUP_ID> ",<!-- Only included if messaging a group --> "message_status": "<PACING_STATUS> "<!-- Only included if sending a template --> } ] }
    Параметры отклика
    
Заполнитель

Описание

Пример значения

    <GROUP_ID>
    Нить
    Строковый идентификатор группы, созданной с помощью API групп.
    В этом поле отображается информация о том, когда сообщения были отправлены, получены или прочитаны из группы.
    Y2FwaV9ncm91cDoxNzA1NTU1MDEzOToxMjAzNjM0MDQ2OTQyMzM4MjAZD
    <PACING_STATUS>
    Нить
    Указывает на  регулирования темпа выполнения шаблона .  message_status включается в ответы только при отправке шаблонного сообщения , использующего шаблон, темп выполнения которого регулируется.
    wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI4MjZGRDA0OUE2OTQ3RkEyMzcA
    <WHATSAPP_USER_PHONE_NUMBER>
    Нить
    Номер телефона пользователя WhatsApp. Может не совпадать со  wa_id .
    +16505551234
    <WHATSAPP_USER_ID>
    Нить
    Идентификатор пользователя WhatsApp. Может не совпадать с введенным значением.
    16505551234
    <WHATSAPP_MESSAGE_ID>
    Нить
    Идентификатор сообщения WhatsApp. Этот идентификатор отображается в связанных  сообщений , таких как веб-хуки отправленных, прочитанных и доставленных сообщений.
    wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI4MjZGRDA0OUE2OTQ3RkEyMzcA
    Пример запроса
    curl 'https://graph.facebook.com/ v25.0 /106540352242922/messages' \ - H 'Content-Type: application/json' \ - H 'Authorization: Bearer EAAJB...' \ - d ' { "messaging_product": "whatsapp", "to": "16505551234", "type": "template", "template": { "name": "coupon_code_fall2023_25off", "language": { "code": "en_US" }, "components": [ { "type": "body", "parameters": [ { "type": "text", "text": "25OFF" }, { "type": "text", "text": "25%" } ] }, { "type": "button", "sub_type": "COPY_CODE", "index": 1, "параметры": [ { "тип": "код_купона", "код_купона": "25OFF" } ] } ] } }'
    Пример ответа
    { "messaging_product": "whatsapp", "contacts": [ { "input": "16505551234", "wa_id": "16505551234" } ], "messages": [ { "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgARGBIxRjk1REYzMDBERDE3RUI0RDYA" } ] }
    
    
            
    
    
    

            
    
        
    
    
    

    
    

    
    
    
        
    
             Вернуться наверх