Перейти к содержанию
Руководства пользователяПоддержка Запросить демо Войти
Pushwoosh.com

SMS API

createSMSMessage

Anchor link to

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

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

Тело запроса

Anchor link to
ИмяОбязательныйТипОписание
auth*ДаstringAPI-токен доступа из Панели управления Pushwoosh.
application*ДаstringКод приложения Pushwoosh
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-пресета из вашей Панели управления.

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

Anchor link to
{
  "request": {
    "application": "12345-67891",    // обязательно. Код приложения Pushwoosh.
    "auth": "yxoPUlwqm…………pIyEX4H",  // обязательно. API-токен доступа из Панели управления 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-пресета из вашей Панели управления.
      "use_auto_registration": true  // опционально. Автоматически регистрировать номер телефона, указанный
                                     //           в параметре "devices".
    }]
  }
}

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

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

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

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

Чтобы получить статистику по SMS, используйте метод totalsByIntervals.

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