Documentation API-SMS : Statut de SMS Vocal

GET

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

Encodage : UTF-8

Authentification

Vos identifiants « api-key » et « api-login » doivent être ajoutés dans les headers.

Définition

Ce service permet d’obtenir le statut d’une campagne SMS Vocal sur liste ou en utilisant un tag.

Paramètres particuliers

Champs	Type	Description
`ticket_number`	string	C’est le ticket transmis par Octopush après l’appel à la fonction de création

Exemple Curl

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

Code à copier-coller

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

Retour Server en json

Succès : 200 OK

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

Valeurs possibles pour le champ « status »

ready_to_be_sent
under_computation
failed

Statut de SMS Vocal sur liste