SMS API
createSMSMessage
Used to send SMS notifications to users
POST https://api.pushwoosh.com/json/1.3/createSMSMessage
Request Body
Name | Required | Type | Description |
---|---|---|---|
auth* | Yes | string | API access token from Pushwoosh Control Panel. |
application* | Yes | string | Pushwoosh application code. |
notifications* | Yes | array | Content settings. JSON array of message parameters. See details below. |
Notification parameters
Name | Required | Type | Description |
---|---|---|---|
send_date* | Yes | string | Date and time to send the notification. Use format YYYY-MM-DD HH:mm or now to send immediately. |
content* | Yes | string | Text content of the SMS message. |
devices* | Yes | array | Customer phone number (must be associated with a UserId using /registerDevice and specified in the hwid parameter or use use_auto_registration ). Only one number can be specified here. |
use_auto_registration | No | boolean | If set to true the phone number specified in the devices parameter will be automatically registered. |
dynamic_content_placeholders | No | object | Dynamic content placeholders to customize the message content. Each placeholder will be replaced with corresponding dynamic values. |
preset | No | string | SMS Preset Code from your Control Panel. |
Request example
{ "request": { "application": "12345-67891", // required. Pushwoosh application code. "auth": "yxoPUlwqm…………pIyEX4H", // required. API access token from Pushwoosh Control Panel. "notifications": [{ "send_date": "now", // required. YYYY-MM-DD HH:mm OR "now". "content": "Hello!", // required. SMS text (string). "devices": ["+1234567890"], // required. Customer phone number (must be associated with // a UserId using. /registerDevice and specified in // the "hwid" parameter or use "use_auto_registration"). // Only one number can be specified here. "preset": "XXXXX-XXXXX", // optional. SMS Preset Code from your Control Panel. "use_auto_registration": true // optional. Automatically register phone number specified // in "devices" parameter. }] }}
Response example
{ "status_code": 200, "status_message": "OK", "response": { "Messages": [ "9648-0B10ECB6-0D9F214D" ] }}
Error response
{ "status_code": 210, "status_message": "Invalid devices list. \"devices\" must be an array.", "response": { "Messages": [] }}
To get SMS statistics, use the totalsByIntervals method.
You can also view statistics for each message in the Message History section.