Documentation API-SMS: SMS Transactionnel

Définition

Cette option est dédiée aux envois NON COMMERCIAUX.

Exemples :

One Time Password OTP, confirmations d’inscriptions, de paiement, d’expédition de commande. Envoi d’alertes, de rappels de rendez-vous, etc…

Avec cette option, vous pouvez donc envoyer vos SMS 24h/24, et 7j/7. Aussi, la mention « STOP au 30101 » n’est pas obligatoire dans ce type de message.

ATTENTION : Toute erreur, toute fraude constatée par l’envoi de publicité avec l’option « SMS transactionnel » est passible d’une amende décrite dans conditions générales.
Nous vous prions d’utiliser cette option avec précaution et en connaissance de cause.

URL

POST

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

Encodage : UTF-8

Paramètres particuliers

Nom	Type	Description
text	string	Message texte (de 1 à 1224 caractères non unicodes).
recipients	array	Liste 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" } ]
type	string	Type de la campagne : [« sms_premium », »sms_low_cost »]
sender	string	Expéditeur du message (si l’opérateur le permet), 3-11 caractères alphanumeriques et espace (a-zA-Z0-9 ).
send_at	string	Date à laquelle vous voulez envoyer la campagne. Format: DateTime ISO8601 (par ex: « 2018-10-03T07:42:39-07:00 »).’
purpose	string	But de la campagne (transactionnel/alerte ou marketing) : [« alert », »wholesale »]
with_replies	boolean	« True » pour recevoir les réponses de vos destinataires
simulation_mode	boolean	(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_id	string	(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_text	boolean	(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"}],
  "text": "Voici un SMS Premium avec mention STOP. STOP au 30101",
  "type": "sms_premium",
  "purpose": "alert",
  "sender": "Entreprise X"
}'

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"}], "text": "Voici un SMS Premium avec mention STOP. STOP au 30101", "type": "sms_premium", "purpose": "alert", "sender": "Entreprise X"}'

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.