POST
https://api.octopush.com/v1/public/sms-campaign-on-list/createPOST
https://api.octopush.com/v1/public/sms-campaign-on-tag/createEncoding : UTF-8
Authentication
Your “api-key” and “api-login” must be added in the headers.
Definition
This service allows you to create a SMS campaign on a contact list or on a tag
This is an asynchronous process. This allows you to give dispatch orders without suffering a timeout. 4 services allow you to operate this type of sending:
- Creating the campaign on a list of contacts or on your tagged contacts.
- Getting the status of the campaign (calculating, ready to send, failed)
- Deleting a list campaign
- Validating sending a list campaign
Special parameters
| Field | Type | Description |
|---|---|---|
| list_name | string | Name of the list to be used for the campaign. (you can use tag_name instead) |
| tag_name | string | Name of the tag to be used to filter your contacts for the campaign. (you can use list_name instead) |
| text | string | Message text (from 1 to 1224 characters non unicode). |
| type | string | Campaign Type : [“sms_vocal”] |
| sender | string | Sender of the message (if the user allows it), 3-11 alphanumeric characters (a-zA-Z0-9). |
| send_at | string | ‘When you want to send the sms campaign. Format: DateTime ISO8601 (for ex: “2018-10-03T07:42:39-07:00”).’ |
| purpose | string | Campaign purpose: “alert” or “wholesale”: [“alert”,”wholesale”] |
| with_replies | boolean | “True” for getting back recipient replies |
| auto_optimize_text | boolean | (optional) 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). |
auto_remove_blacklisted_numbers | boolean | (optional) By transmitting this field with “true” value, the blacklisted numbers will be automatically removed from your list of numbers. This service will add a charge of 0.01€ per request. |
Example Curl
curl -X POST \
'https://api.octopush.com/v1/public/sms-campaign-on-list/create' \
-H 'Content-Type: application/json' \
-H 'api-login: ******@email.org' \
-H 'api-key: ************' \
-H 'cache-control: no-cache' \
-d '{
"list_name": "my_list",
"text": "This is a Premium SMS with STOP. STOP at 30101",
"type": "sms_premium",
"purpose": "wholesale",
"sender": "Company X"
}'Command to copy/paste
curl -X POST 'https://api.octopush.com/v1/public/sms-campaign-on-list/create' -H 'Content-Type: application/json' -H 'api-login: ******@email.org' -H 'api-key: ************' -H 'cache-control: no-cache' -d '{"list_name": "my_list", "text": "This is a Premium SMS with STOP. STOP at 30101", "type": "sms_premium", "purpose": "wholesale", "sender": "Company X"}'JSON Server Response
Success : 201 CREATED
{
"ticket_number": "sms_5f3fbce61266e"
}Failure : 400 BAD REQUEST
{
"code": 121,
"message": "Mention STOP is missing."
}