post
https://api.octopush.com/v1/public/sms-campaign-on-list/create
Encoding : UTF-8
Authentication
Your "api-key" and "api-login" identifiers must be added in the headers.
Definition
This web service allows you to prepare a SMS campaign that will be sent to one of your contacts list/tag.
Special parameters
| Name | Type | Description |
|---|---|---|
| text | string | Message text (from 1 to 1224 characters). |
| list_name | string | This is the value representing to list name you want to create. |
| tag_name | string | This is the value representing to tag name you want to create. |
| segmentation | string | ["filter", "group"] |
| send_at | string | When you want to send the sms campaign. Format: DateTime ISO8601 (for ex: "2018-10-03T07:42:39-07:00"). |
| type | string | Campaign Type: ["sms_premium","sms_low_cost"] |
| purpose | string | Campaign purpose: (transactional/alert or marketing) : ["alert","wholesale"] |
| with_replies | boolean | "True" for getting back recipient replies |
| sender | string | Sender of the message (if the user allows it), 3-11 alphanumeric characters (a-zA-Z0-9). |
| simulation_mode | boolean | If this value is "true", your request will be simulated, and you will receive a fake result. Only some minimal validations will be executed. |
| auto_remove_blacklisted_numbers | boolean | This value is "true" when you want to send with ignore blacklisted numbers. |
| auto_optimize_text | boolean | By transmitting this field with "false" value, your text will not be optimized by Octopush robot (your message could contain unicode characters, or useless spaces that could increase the number of needed SMS for each contact). |
| recipient_tracking | boolean | "True" for getting back recipient tracking. |
| request_id | string | (optional) To avoid sending same request multiple times, setup an request ID. In case the duplication will be detected, a validation error will be returned. A request_id will expire after 24 hours. |
How Our API Deals With Incorrect Data
The API we provide will try to interpret your request as best it can. If a parameter has the wrong value, we will try to understand it anyway. If the parameter has the wrong type, we will try to format it as best we can. Thus, we have determined default values, which are indicated in our documentation. If a parameter could not be recognized or "fixed", we will ignore it, but your request will be sent.
If one of your parameters does not have the right value, or does not have the right type, we will try to:
- "cast" (convert) it so that it can be understood.
- format it (delete prohibited characters for example)
Server Response Example in JSON
Success
{
"ticket_number: "**********"
}