SMS API

createSMSMessage

Используется для отправки SMS-уведомлений пользователям.

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

Тело запроса

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

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

Имя	Обязательно	Тип	Описание
send_date*	Да	string	Дата и время отправки уведомления. Используйте формат `YYYY-MM-DD HH:mm` или `now` для немедленной отправки.
content*	Да	string	Текстовое содержимое SMS-сообщения.
devices*	Да	array	Номер телефона клиента (должен быть связан с UserId с помощью `/registerDevice` и указан в параметре `hwid`, либо используйте `use_auto_registration`). Здесь можно указать только один номер.
use_auto_registration	Нет	boolean	Если установлено значение `true`, номер телефона, указанный в параметре `devices`, будет зарегистрирован автоматически.
dynamic_content_placeholders	Нет	object	Плейсхолдеры динамического контента для персонализации содержимого сообщения. Каждый плейсхолдер будет заменен соответствующим динамическим значением.
preset	Нет	string	SMS Preset Code из вашей Панели управления.

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

{
  "request": {
    "application": "12345-67891",    // обязательно. Код приложения Pushwoosh.
    "auth": "yxoPUlwqm…………pIyEX4H",  // обязательно. API access token из Панели управления Pushwoosh.
    "notifications": [{
      "send_date": "now",            // обязательно. YYYY-MM-DD HH:mm ИЛИ "now".
      "content": "Hello!",           // обязательно. Текст SMS (строка).
      "devices": ["+1234567890"],    // обязательно. Номер телефона клиента (должен быть связан с
                                     //           UserId с помощью /registerDevice и указан в
                                     //           параметре "hwid" или используйте "use_auto_registration").
                                     //           Здесь можно указать только один номер.
      "preset": "XXXXX-XXXXX",       // необязательно. SMS Preset Code из вашей Панели управления.
      "use_auto_registration": true  // необязательно. Автоматически регистрирует номер телефона, указанный
                                     //           в параметре "devices".
    }]
  }
}

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

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

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

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

Для получения статистики по SMS используйте метод totalsByIntervals.

Вы также можете просматривать статистику по каждому сообщению в разделе Message History.