SMS API
createSMSMessage Устарел
Anchor link toИспользуется для отправки SMS-уведомлений пользователям
POST https://api.pushwoosh.com/json/1.3/createSMSMessage
Тело запроса
Anchor link to| Название | Обязательно | Тип | Описание |
|---|---|---|---|
| auth* | Да | string | Токен доступа API из Control Panel Pushwoosh. |
| application* | Да | string | Код приложения Pushwoosh |
| notifications* | Да | array | Настройки контента. JSON-массив параметров сообщения. Подробности см. ниже. |
Параметры уведомления
| Название | Обязательно | Тип | Описание |
|---|---|---|---|
| send_date* | Да | string | Дата и время отправки уведомления. Используйте формат ГГГГ-ММ-ДД ЧЧ:мм или now для немедленной отправки. |
| content* | Да | string | Текстовое содержимое SMS-сообщения. |
| devices* | Да | array | Номер телефона клиента (должен быть связан с User ID с помощью /registerDevice и указан в параметре hwid или используйте use_auto_registration). Здесь можно указать только один номер. |
| use_auto_registration | Нет | boolean | Если установлено значение true, номер телефона, указанный в параметре devices, будет зарегистрирован автоматически. |
| dynamic_content_placeholders | Нет | object | Плейсхолдеры для динамического контента для кастомизации содержимого сообщения. Каждый плейсхолдер будет заменен соответствующими динамическими значениями. |
| preset | Нет | string | Код пресета SMS из вашей Control Panel. |
Пример запроса
Anchor link to{ "request": { "application": "12345-67891", // обязательно. Код приложения Pushwoosh. "auth": "yxoPUlwqm…………pIyEX4H", // обязательно. Токен доступа API из Control Panel Pushwoosh. "notifications": [{ "send_date": "now", // обязательно. ГГГГ-ММ-ДД ЧЧ:мм ИЛИ "now". "content": "Hello!", // обязательно. Текст SMS (строка). "devices": ["+1234567890"], // обязательно. Номер телефона клиента (должен быть связан с // User ID с помощью /registerDevice и указан в // параметре "hwid" или используйте "use_auto_registration"). // Здесь можно указать только один номер. "preset": "XXXXX-XXXXX", // опционально. Код пресета SMS из вашей Control Panel. "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.
Вы также можете просмотреть статистику по каждому сообщению в разделе Message History.