WhatsApp API

createWhatsAppMessage

Используется для отправки сообщений WhatsApp пользователям

POST https://api.pushwoosh.com/json/1.3/createWhatsAppMessage

Тело запроса

Имя	Обязательный	Тип	Описание
auth*	Да	string	Токен доступа к API из Панели управления Pushwoosh.
application*	Да	string	Код приложения Pushwoosh
notifications*	Да	array	Настройки контента. JSON-массив параметров сообщения. Подробности см. ниже.

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

Имя	Обязательный	Тип	Описание
send_date*	Да	string	Дата и время отправки уведомления. Используйте формат `YYYY-MM-DD HH:mm` или `'now'` для немедленной отправки.
content	Обязателен, если не указан `content_id`.	string	Текстовое содержимое сообщения WhatsApp.
content_id	Обязателен, если не указан `content`.	string	Идентификатор предварительно одобренного шаблона WhatsApp из вашего аккаунта Meta.
devices*	Да	array	Номер телефона клиента (должен быть связан с UserId с помощью `/registerDevice` и указан в параметре `hwid`, либо используйте `use_auto_registration`). Здесь можно указать только один номер.
use_auto_registration	Нет	boolean	Если установлено значение `true`, номер телефона, указанный в параметре `devices`, будет зарегистрирован автоматически.
content_variables	Нет	object	Переменные для кастомизации содержимого сообщения. Каждый плейсхолдер будет заменен соответствующими динамическими значениями.
button_url_variables	Нет	object	Динамические переменные URL для кнопок. Каждый ключ представляет индекс кнопки, а его значение — это динамическая переменная для замены в URL кнопки. Примечание: Индексация кнопок начинается с 0: первая кнопка — 0, вторая — 1 и так далее.
header_variables	Нет	object	Переменные для заголовка в шаблонном сообщении WhatsApp. Укажите `type` (например, `text`, `image`, `video`, `document`) и соответствующее значение. Пример: `"header_variables": {"image": "https://image-url.png"}`
preset	Нет	string	Код пресета WhatsApp из вашей Панели управления.
language	Нет	string	Языковая локаль шаблона WhatsApp (должна совпадать с локалью в редакторе шаблонов Meta WhatsApp). По умолчанию: `"en_US"`. Пример: `"en_GB"`.

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

{
  "request": {
    "application": "12XXX-67XXX",           // обязательно. Код приложения Pushwoosh.
    "auth": "yxoPUlwqm…………pIyEX4H",         // обязательно. Токен доступа к API из Панели управления Pushwoosh.
    "notifications": [{
      "send_date": "now",                   // обязательно. ГГГГ-ММ-ДД ЧЧ:мм ИЛИ "now".
      "content": "Hello! {{1}}",            // обязательно, если не указан content_id. Текст сообщения.
      "content_id": "hello_world",          // обязательно, если не указан content. Идентификатор шаблона WhatsApp.
      "devices": ["whatsapp:+1234567890"],  // обязательно. Номер телефона клиента в WhatsApp (должен быть связан
                                            //           с UserId с помощью /registerDevice и указан в
                                            //           параметре "hwid" или используйте "use_auto_registration").
                                            //           Здесь можно указать только один номер WhatsApp.
      "preset": "XXXXX-XXXXX",              // опционально. Код пресета WhatsApp из вашей Панели управления.
      "content_variables": {                // опционально. Переменные для кастомизации содержимого сообщения.
        "1": "John"
      },
      "header_variables": {                 // опционально. Переменные для заголовка сообщения WhatsApp.
        "image": "https://image-url.png"
      },
      "language": "en_GB",                  // опционально. Языковая локаль шаблона WhatsApp (должна совпадать с локалью в редакторе шаблонов Meta WhatsApp). По умолчанию: "en_US".
      "use_auto_registration": true         // опционально. Автоматически зарегистрировать номер WhatsApp, указанный
                                            //           в параметре "devices".
    }]
  }
}

Пример: Отправка кода двухфакторной аутентификации через WhatsApp

{
    "request": {
        "application":"APP_CODE", "auth":"AUTH_TOKEN",
        "notifications":[{
            "send_date":"now",
            "content_id":"replace_with_your_meta_two_factor_template_name",
            "content_variables":{"1":"AUTH_CODE"},
            "button_url_variables":{"0":"AUTH_CODE"},
            "devices":["whatsapp:REPLACE_WITH_YOUR_PHONE_NO"]
        }]
    }
}

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

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "Messages": [
      "9648-0B10EXXX-0D9F2XXX"
    ]
  }
}

Ответ с ошибкой

{
  "status_code": 210,
  "status_message": "Invalid devices list. \"devices\" must be an array.",
  "response": {
    "Messages": []
  }
}