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

Envoi de SMS Vocal

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

Encodage : UTF-8

Authentification

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

Définition

Il s’agit du service d’envoi de SMS Vocal, en mode :

  • simple (1 contact)
  • campagne (jusqu’à 500 contacts)

Vous devez indiquer vos numéros de téléphone dans le paramètre « recipients », qui est un tableau contenant des objets de type « contact ».

Paramètres particuliers

NomTypeDescription
textstringMessage texte (de 1 à 1224 caractères non unicodes).
recipientsarrayListe d’objets Contact (array d’objets) :
[
  {
    "phone_number": "+111222233334444"
  },
  ...,
  {
    "phone_number": "+2222333334444555"
  }
]
senderstringExpéditeur du message (si l’opérateur le permet), 3-11 caractères alphanumeriques et espace (a-zA-Z0-9 ).
send_atstring(optionnel) Date à laquelle vous voulez envoyer la campagne. Format: DateTime ISO8601 (par ex: « 2018-10-03T07:42:39-07:00 »).’
purposestring(optionnel) But 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/send' \ 
-H 'Content-Type: application/json' \ 
-H 'api-login: *****@email.org' \ 
-H 'api-key: ******' \ 
-H 'cache-control: no-cache' \ 
-d '{
  "recipients": 
  [
    {
      "phone_number": "+37379967255"
    }
  ],
  "text": "Voici un SMS Vocal à écouter",
  "purpose": "alert",
  "sender": "12345",
  "voice_gender": "female",
  "voice_language": "fr-FR"
 }'

Code à copier-coller

curl -X POST 'https://api.octopush.com/v1/public/voice-campaign/send'-H 'Content-Type: application/json' -H 'api-login: *****@email.org' -H 'api-key: ******' -H 'cache-control: no-cache' -d '{"recipients": [{"phone_number":"+37379967255"}], "text": "Voici un SMS Vocal à écouter", "purpose": "alert", "sender": "12345", "voice_gender": "female", "voice_language": "fr-FR"}'

Retour Server en json

Succès : 201 CREATED

{
  "ticket_number": "voice_5f44ebf9e47b7",
  "number_of_contacts": 1,
  "total_cost": 0.05,
  "estimated_duration": 30,
  "residual_credit": 149.95
}

Échec : 400 BAD REQUEST

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