Documentation API-SMS: Envoi de SMS Vocal différé

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.

Description

Vous permet d’envoyer un SMS Vocal différé en indiquant votre date d’envoi au format ISO.

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", "param1": "Alex", "param2": null, "param3": null, "param4": null, "param5": null, }, ..., { "phone_number": "+2222333334444555", "param1": "John", } ]
`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	(optionnel) But de la campagne (transactionnel/alerte ou marketing) : [« alert », »wholesale »]
`voice_gender`	string	Genre de la voix [‘male’, ‘female’]
`voice_language`	string	Langue 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_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_remove_blacklisted_numbers`	boolean	(optionnel) Si ce champ est transmis et qu’il a la valeur true, les numéros blacklistés seront automatiquement supprimés de votre liste de numéros. Ce service rajoute un coût de 0.01€ par requête.

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": "+336000123",
         "param1": "Alex"
      }
   ],
   "text": "Voici un SMS Vocal.",
   "purpose": "alert",
   "sender": "12345",
   "send_at": "2018-10-03T07:42:39-07:00",
   "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": "+336000123", "param1": "Alex"}], "text": "Voici un SMS Vocal.", "purpose": "alert", "sender": "12345", "send_at": "2018-10-03T07:42:39-07:00", "voice_gender": "female", "voice_language": "fr-FR"}'

Retour Server 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."
      }
   }
}