Облачный API

Отправка шаблонов категории "Аутентификация"

В этом документе рассказывается, как отправлять утвержденные шаблоны категории "Аутентификация" с кнопками одноразового пароля.

Запрос

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

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

POST /<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>/messages

Тело публикации

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "<CUSTOMER_PHONE_NUMBER>",
  "type": "template",
  "template": {
    "name": "<TEMPLATE_NAME>",
    "language": {
      "code": "<TEMPLATE_LANGUAGE_CODE>"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "<ONE-TIME PASSWORD>"
          }
        ]
      },
      {
        "type": "button",
        "sub_type": "url",
        "index": "0",
        "parameters": [
          {
            "type": "text",
            "text": "<ONE-TIME PASSWORD>"
          }
        ]
      }
    ]
  }
}

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

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

<CUSTOMER_PHONE_NUMBER>

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

12015553931

<ONE-TIME PASSWORD>

Отправляемый одноразовый пароль или код подтверждения.


Примечание. Это значение нужно указать в полезных данных дважды.


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

J$FpnYnP

<TEMPLATE_LANGUAGE_CODE>

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

en_US

<TEMPLATE_NAME>

Имя шаблона.

verification_code

Ответ

В случае успеха ответ API будет выглядеть так:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "<INPUT>",
      "wa_id": "<WA_ID>"
    }
  ],
  "messages": [
    {
      "id": "<ID>"
    }
  ]
}

Содержимое ответа

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

<INPUT>

Строка

Номер телефона клиента, на который было отправлено сообщение. Может не соответствовать wa_id.

+16315551234

<WA_ID>

Строка

Идентификатор WhatsApp клиента, которому было отправлено сообщение. Может не соответствовать input.

+16315551234

<ID>

Строка

ID сообщения WhatsApp. Вы можете использовать ID, указанный после "wamid", чтобы отслеживать статус сообщения.

wamid.HBgLMTY1MDM4Nzk0MzkVAgARGBI3N0EyQUJDMjFEQzZCQUMzODMA

Пример

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

curl -L 'https://graph.facebook.com/v19.0/105954558954427/messages' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '{
      "messaging_product": "whatsapp",
      "recipient_type": "individual",
      "to": "12015553931",
      "type": "template",
      "template": {
        "name": "verification_code",
        "language": {
          "code": "en_US"
      },
      "components": [
        {
          "type": "body",
          "parameters": [
            {
              "type": "text",
              "text": "J$FpnYnP"
            }
          ]
        },
        {
          "type": "button",
          "sub_type": "url",
          "index": "0",
          "parameters": [
            {
              "type": "text",
              "text": "J$FpnYnP"
            }
          ]
        }
      ]
    }
  }'

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

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