Accueil » API SMS Octopush » Vocal SMS API » Envoi de SMS Vocal sur liste

Envoi de SMS Vocal sur liste

POST
https://api.octopush.com/v1/public/voice-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 Vocal 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 SMS Vocal sur une liste de contacts.
  • Obtention du statut de la campagne (en calcul, prêt à l’envoi, échec)
  • Supprimer une campagne SMS Vocal sur liste
  • Valider l’envoi d’une campagne SMS Vocal sur liste

Paramètres particuliers

NomTypeDescription
list_namestringNom de la liste à utiliser pour la campagne.
textstringMessage texte (de 1 à 1224 caractères non unicodes).
recipientsarrayListe d’objets Contact (array d’objets) :
[
  {
    "phone_number": "+111222233334444",
    "first_name": "Alex",
    "last_name": "Konnor",
    "param1": null,
    "param2": null,
    "param3": null,
    "param4": null,
    "param5": null,
  },
  ...,
  {
    "phone_number": "+2222333334444555",
    "first_name": "Connor",
    "last_name": "Arquet",
  }
]
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 »]
voice_genderstringGenre de la voix [‘male’, ‘female’]
voice_languagestringLangue de la voix [‘en-US’, ‘en-GB’, ‘el-GR’, ‘pl-PL’, ‘hu-HU’, ‘sv-SE’, ‘de-DE’, ‘es-ES’, ‘es-LA’, ‘fr-FR’, ‘it-IT’, ‘pt-BR’, ‘ru-RU’]
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.

Exemple Curl

curl -X POST \ 
'https://api.octopush.com/v1/public/voice-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 Vocal à écouter",
  "recipients": [
   {
     "phone_number": "+336000123",
            "first_name" : "Alex"
    }
  ],
  "sender": "12345",
  "voice_gender": "female",
  "voice_language": "fr-FR"
}'

Code à copier-coller

curl -X POST 'https://api.octopush.com/v1/public/voice-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 Vocal à écouter", "recipients": [{"phone_number": "+336000123", "first_name" : "Alex"}], "sender": "12345", "voice_gender": "female", "voice_language": "fr-FR"}'

Retour Server JSON

Succès : 201 CREATED

{
   "ticket_number": "voice_5f44ebf9e47b7"
}

Échec : 400 BAD REQUEST

{
   "code": 400,
   "message": "Payload validation error.",
   "errors":
   {
      "voice_language": 
      {
         "code": 442,
         "message": "Voice language not supported."
      }
   }
}