Status Voice SMS on a list

GET
https://api.octopush.com/v1/public/voice-campaign-on-list/status

Encodage : UTF-8

Authentification

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

Definition

This service allows you to obtain the status of a Voice SMS campaign on a list.

Special parameters

ChampsTypeDescription
ticket_numberstringThis is the ticket transmitted by Octopush after the calling the creation function

Curl Example

curl -X GET \ 
'https://api.octopush.com/v1/public/voice-campaign-on-list/status?ticket_number=voice_xxxX0000xxxxx0000' \ 
-H 'Content-Type: application/json' \ 
-H 'api-key: ************' \ 
-H 'api-login: ******@email.org' \ 
-H 'cache-control: no-cache'

JSON Server Response

Success : 201 CREATED

{
  "number_of_contacts": 147,
  "cost": 9.32,
  "estimated_duration": 3.50,
  "status": "ready_to_be_sent"
}

Possible values for the ‘status’ field

  • ready_to_be_sent
  • under_computation
  • failed