Skip to content
Home » Octopush Gateway SMS API » SMS API » Confirm SMS on contacts

Confirm SMS on contacts

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

POST
https://api.octopush.com/v1/public/sms-campaign-on-tag/send

Encoding : UTF-8

Authentication

Your “api-key” and “api-login” must be added in the headers.

Definition

This service allows you to confirm the sending of a campaign whose status is “ready_to_be_sent”.

Special parameters

FieldTypeDescription
ticket_numberstringThis is the ticket_number transmitted by Octopush after the call to the creation function

Example Curl

curl -X POST \ 
'https://api.octopush.com/v1/public/sms-campaign/send' \ 
-H 'Content-Type: application/json' \ 
-H 'api-login: ******@email.org' \ 
-H 'api-key: ************' \ 
-H 'cache-control: no-cache' \ 
-d '{
  "ticket_number": "sms0000xx0000xx"
}'

Command to copy/paste

curl -X POST 'https://api.octopush.com/v1/public/sms-campaign/send' -H 'Content-Type: application/json' -H 'api-login: ******@email.org' -H 'api-key: ************' -H 'cache-control: no-cache' -d '{"ticket_number": "sms0000xx0000xx"}'

JSON Server Response

Success : 200 OK

{
  "sending_date": "2021-06-01T12:00:00+03:00"
}

Failure : 400 Bad Request

This error will be returned as long as the campaign is not ready.