Accueil » API SMS Octopush » Envoi de SMS sur liste

Envoi de SMS sur liste

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

Encodage : UTF-8

Authentification

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

Définition

Ce service vous permet de créer une campagne de SMS sur une liste de contacts.

C’est un processus asynchrone. Ceci vous permet de donner des ordres d’envoi sans subir de timeout. 4 services vous permettent d’opérer ce type d’envoi :

  • Création de la campagne sur une liste de contacts.
  • Obtention du statut de la campagne (en calcul, prêt à l’envoi, échec)
  • Supprimer une campagne sur liste
  • Valider l’envoi d’une campagne sur liste

Paramètres particuliers

ChampTypeDescription
textstringMessage texte (de 1 à 1224 caractères non unicodes).
list_namestringNom de la liste à utiliser pour la campagne.
typestringType de la campagne : [« sms_vocal »]
senderstringExpéditeur du message (si l’opérateur le permet), 3-11 caractères alphanumeriques et espace (a-zA-Z0-9 ).
send_atstringDate à laquelle vous voulez envoyer la campagne. Format: DateTime ISO8601 (par ex: « 2018-10-03T07:42:39-07:00 »).’
purposestringBut de la campagne (transactionnel/alerte ou marketing) : [« alert », »wholesale »]
with_repliesboolean« True » pour recevoir les réponses de vos destinataires
auto_optimize_textboolean(optionnel) Si ce champ est transmis et qu’il a la valeur false, votre texte ne sera pas optimisé par le robot de Octopush (votre message pourrait contenir des caractères unicodes, ou des espaces inutiles qui pourraient augmenter le nombre de SMS nécessaires pour chacun de vos contacts).

Exemple CURL

curl -X POST \ 
'https://api.octopush.com/v1/public/sms-campaign-on-list/create' \ 
-H 'Content-Type: application/json' \ 
-H 'api-login: ******@email.org' \ 
-H 'api-key: ************' \ 
-H 'cache-control: no-cache' \ 
-d '{
  "list_name": "my_list",
  "text": "Voici un SMS Premium avec mention STOP. STOP au 30101",
  "type": "sms_premium",
  "purpose": "wholesale",
  "sender": "Entreprise"
}'

Code à copier-coller

curl -X POST 'https://api.octopush.com/v1/public/sms-campaign-on-list/create'
-H 'Content-Type: application/json' -H 'api-login: ******@email.org' -H 'api-key: ************' -H 'cache-control: no-cache' -d '{"list_name": "my_list", "text": "Voici un SMS Premium avec mention STOP. STOP au 30101", "type": "sms_premium", "purpose": "wholesale", "sender": "Entreprise"}'

Retour Server en json

Succès : 201 CREATED

{
  "ticket_number": "sms_5f3fbce61266e" 
}

Échec : 400 BAD REQUEST

{
  "code": 121,
  "message": "Mention STOP is missing."
}