Accueil » API SMS Octopush » SMS avec réponse

SMS avec réponse

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

Encodage : UTF-8

Authentification

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

Définition

Pour les envois vers la France Métropolitaine (pour les autres destinations, nous demander), vous pouvez activer l’option « SMS réponse ».
L’émetteur est alors remplacé par un numéro court non surtaxé auquel vos destinataires peuvent répondre.

Réception des réponses

3 manières de recevoir les réponses :

  • Sur l’interface : vous avez accès à vos réponses soit par campagne, soit par date.
  • Par Email : transmettez nous une adresse email à laquelle nous vous enverrons les réponses au fur et à mesure qu’elles nous arrivent.
  • Par Callback : transmettez nous une URL à laquelle nous vous transmettrons les réponses. > En savoir plus

Paramètres particuliers

NomTypeDescription
textstringMessage texte (de 1 à 1224 caractères non unicodes).
recipientsarrayListe d’objets Contact (array d’objets) :
[
  {
    "phone_number": "+111222233334444",
    "first_name": "Axelle",
    "last_name": "Durand",
    "param1": null,
    "param2": null,
    "param3": Mme,
    "param4": null,
    "param5": null
  },
  ...,
  {
    "phone_number": "+2222333334444555",
    "first_name": "John",
    "last_name": "Smith",
    "param3": "M"
  }
]
typestringType de la campagne : [« sms_premium », »sms_low_cost »]
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
simulation_modeboolean(optionnel) Si ce champ est à “true”, votre requête sera simulée, et vous recevrez un faux résultat. Seulement quelques validations seront effectuées.
request_idstring(optionnel) Pour éviter d’envoyer la même demande plusieurs fois, configurez un ID de demande. Dans le cas où la duplication serait détectée, une erreur de validation sera renvoyée.
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/send' \ 
-H 'Content-Type: application/json' \ 
-H 'api-login: ******@email.org' \ 
-H 'api-key: ************' \ 
-H 'cache-control: no-cache' \ 
-d '{
  "recipients": [
    {
      "phone_number": "+336000123",
      "first_name": "Axelle",
      "last_name": "Durand",
      "param3": "Mme"
    }
  ],
  "text": "Voici un SMS Premium avec mention STOP. STOP au 30101",
  "type": "sms_premium",
  "purpose": "wholesale",
  "sender": "12345",
  "with_replies": true
}'

Code à copier-coller

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 '{"recipients": [{"phone_number": "+336000123", "first_name": "Axelle", "last_name": "Durand", "param3": "Mme"}], "text": "Voici un SMS Premium avec mention STOP. STOP au 30101", "type": "sms_premium", "purpose": "wholesale", "sender": "12345", "with_replies": true}'

Retour Server en json

Succès : 201 CREATED

{
  "sms_ticket": "sms_5f3fbce61266e",
  "number_of_contacts": 1,
  "number_of_sms_needed": 1,
  "residual_credit": 94.995,
  "total_cost": 5.00502839 
}

Échec : 400 BAD REQUEST

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

* Pour certains utilisateurs ovh, l’utilisation de curl_setopt($ch, CURLOPT_FRESH_CONNECT, true); dans leur séquence d’envoi en CUrl pourrait être utile.