Send SMS to a list

POST
https://api.octopush.com/v1/public/sms-campaign-on-list/create

Encoding : 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.

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.
  • Getting the status of the campaign (calculating, ready to send, failed)
  • Deleting a list campaign
  • Validating sending a list campaign

Special parameters

FieldTypeDescription
list_namestringName of the list to be used for the campaign.
textstringMessage text (from 1 to 1224 characters non unicode).
typestringCampaign Type : [“sms_vocal”]
senderstringSender of the message (if the user allows it), 3-11 alphanumeric characters (a-zA-Z0-9).
send_atstring‘When you want to send the sms campaign. Format: DateTime ISO8601 (for ex: “2018-10-03T07:42:39-07:00”).’
purposestringCampaign purpose: “alert” or “wholesale”: [“alert”,”wholesale”]
with_repliesboolean“True” for getting back recipient replies
auto_optimize_textboolean(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).

Example Curl

curl -X POST \ 
'https://api.octopush.com/v1/public/sms-campaign-on-list/create' \ 
-H 'Content-Type: application/json' \ 
-H 'api-key: ************' \ 
-H 'api-login: ******@email.org' \ 
-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."
}