Documentation API-SMS: Statut de SMS sur liste

GET

https://api.octopush.com/v1/public/sms-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 Texte sur liste. Ce service web n’est utile que si votre campagne, créée via le service
https://api.octopush.com/v1/public/sms-campaign-on-list/create , est en cours de calcul et n’est pas encore envoyée.

Paramètres

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/sms-campaign-on-list/status?ticket_number=sms_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/sms-campaign-on-list/status?ticket_number=sms_xxxX0000xxxxx0000' -H 'api-login: ******@email.org' -H 'api-key: ************' -H 'cache-control: no-cache'

Retour Server JSON

Succès : 200 OK

{
  "number_of_contacts": 20,
  "cost": 2.58,
  "status": "ready_to_be_send"
}

Échec : 400 BAD REQUEST

Cette erreur sera retournée tant que la campagne n’est pas prête.

Valeurs possibles pour le champ « status »

ready_to_be_sent
under_computation
failed