Documentation API-SMS: Envoi de SMS personnalisés

POST

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

Définition

Cette option vous permet de personnaliser vos SMS pour chacun de vos destinataires.
Vous pouvez faire cette personnalisation de votre côté, mais cela vous oblige à nous transmettre autant de requêtes qu’il y a de numéros de téléphones, ce qui peut prendre plusieurs minutes selon la taille de vos listes.
Grâce à l’option de publipostage de Octopush, votre envoi ne durera que quelques secondes pour l’ensemble de vos contacts.

Champs dynamiques :

{first_name} : String, [50 caractère max]
{last_name} : String, [50 caractère max]
{param1} : String, [50 caractère max]
{param2} : String, [50 caractère max]
{param3} : String, [50 caractère max]
{param4} : String, [50 caractère max]
{param5} : String, [50 caractère max]

Encodage : UTF-8

Paramètres particuliers

Nom	Type	Description
`text`	string	Texte du message (de 1 à 1224 caractères).
`recipients`	array	Object array liste d’objects de Contacts : [ { "phone_number": "+111222233334444", "first_name": "Alex", "last_name": "Smith", "param1": "M", "param2": null, "param3": null, "param4": null, "param5": null, }, ..., { "phone_number": "+2222333334444555", "param1": "John", } ]
`type`	string	Type de Campagne: [« sms_premium », »sms_low_cost »]
`sender`	string	Qui envoie le message (si l’usager le permis), 3-11 caractères alphanumeriques (a-zA-Z0-9).
`send_at`	string	‘Quand vous voulez envoyer le campagne. Format: DateTime ISO8601 (for ex: « 2018-10-03T07:42:39-07:00 »).’

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": "Alexandra",
      "last_name": "Robinson",
      "param1": "Mrs",
      "param2": "Dr Collins",
      "param3": "3:30 pm"
    },
    {
      "phone_number": "+336001234",
      "first_name": "Paul",
      "last_name": "McDonald",
      "param1": "Mr",
      "param2": "Dr Howard",
      "param3": "4:00 pm"
    }
  ],
  "text": "Bonjour{param1} {first_name} {last_name}, n oubliez pas votre consultation  avec {param2} à {param3}. STOP au 30101",
  "type": "sms_premium",
  "purpose": "alert",
  "sender": "Medic"
}'

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": "Alexandra", "last_name": "Robinson", "param1": "Mrs", "param2": "Dr Collins", "param3": "3:30 pm"}, {"phone_number": "+336001234", "first_name": "Paul", "last_name": "McDonald", "param1": "Mr", "param2": "Dr Howard", "param3": "4:00 pm"}], "text": "Bonjour{param1} {first_name} {last_name}, n oubliez pas votre consultation  avec {param2} à {param3}. STOP au 30101", "type": "sms_premium", "purpose": "alert", "sender": "Medic"}'

Retour Server en json

Succès : 201 CREATED

{
  "sms_ticket": "sms_5f3fbce61266e",
  "number_of_contacts": 2,
  "total_cost": 0.30 
}

Échec : 400 Bad Request

{
  "code": 121,
  "message": "Mention STOP est manquante."
}

Envoi de sms personnalisés (Publipostage)