Documentation API-SMS: 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

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" }, ..., { "phone_number": "+2222333334444555" } ]
`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	(optionnel) 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 »]. Here is availability of gender for each available country (F for female, M for male : ‘pl-PL’ => [F, M], ‘sv-SE’ => [F], ‘de-DE’ => [F, M], ‘en-GB’ => [F, M], ‘en-US’ => [F, M], ‘es-ES’ => [F, M], ‘fr-FR’ => [F, M], ‘it-IT’ => [F, M], ‘pt-BR’ => [F, M], ‘ru-RU’ => [F, M], ‘arb’ => [F], ‘ca-ES’ => [F], ‘zh-HK’ => [F, M], ‘mn-CN’ => [F], ‘da-DK’ => [F, M], ‘nl-NL’ => [F, M], ‘en-AU’ => [F, M], ‘en-IN’ => [F], ‘en-NZ’ => [F], ‘en-ZA’ => [F], ‘il-PH’ => [F, M], ‘fr-CA’ => [F, M], ‘de-AT’ => [F], ‘hi-IN’ => [F], ‘is-IS’ => [F, M], ‘id-ID’ => [F, M], ‘ja-JP’ => [F, M], ‘ko-KR’ => [F], ‘ms-MY’ => [F, M], ‘nb-NO’ => [F], ‘pt-PT’ => [F, M], ‘ro-RO’ => [F], ‘es-MX’ => [F], ‘es-US’ => [F, M], ‘th-TH’ => [F, M], ‘tr-TR’ => [F], ‘uz-UZ’ => [F, M], ‘vi-VN’ => [F, M], ‘cy-GB’ => [F])
`voice_language`	string	Langue de la voix. Valeurs possibles : [‘en-US’, ‘en-GB’, ‘pl-PL’, ‘sv-SE’, ‘de-DE’, ‘es-ES’, ‘fr-FR’, ‘it-IT’, ‘pt-BR’, ‘ru-RU’, ‘arb’, ‘ca-ES’, ‘zh-HK’, ‘mn-CN’, ‘da-DK’, ‘nl-NL’, ‘en-AU’, ‘en-IN’, ‘en-NZ’, ‘en-ZA’, ‘il-PH’, ‘fr-CA’, ‘de-AT’, ‘hi-IN’, ‘is-IS’, ‘id-ID’, ‘ja-JP’, ‘ko-KR’, ‘ms-MY’, ‘nb-NO’, ‘pt-PT’, ‘ro-RO’, ‘es-MX’, ‘es-US’, ‘th-TH’, ‘tr-TR’, ‘uz-UZ’, ‘vi-VN’, ‘cy-GB’]
`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.
`get_back_pressed_keys`	boolean	(optionnel) Si ce champ est transmis et qu’il a la valeur true, votre appel permettra à votre interlocuteur de presser une ou plusieurs touches de son clavier téléphonique. Au bout de 2 secondes, la séquence sera considérée comme achevée (6 touches maximum).

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