Voici la liste des paramètres disponibles pour utiliser notre API SMS.
ATTENTION : lorsque ceux-ci ne sont pas obligatoires, c’est qu’ils ont une valeur par défaut.
Authentification
La api-key et le api-login doivent être ajoutés dans les Headers
| Nom | Type | Description |
|---|---|---|
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 »).’ |
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",
}
] |
type | string | Type de la campagne : [« sms_premium », »sms_low_cost »] |
purpose | string | But de la campagne (transactionnel/alerte ou marketing) : [« alert », »wholesale »] |
with_replies | boolean | « True » pour recevoir les réponses de vos destinataires |
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_optimize_text | boolean | (optionnel) Si ce champ est transmis et qu’il a la valeur false, votre texte ne sera pas optimisé par le robot de Octopush (votre message pourrait contenir des caractères unicodes, ou des espaces inutiles qui pourraient augmenter le nombre de SMS nécessaires pour chacun de vos contacts). |
Spécifique au SMS Vocal | ||
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’] |
voice_gender | string | Genre de la voix [« male », « female »] |
Spécifiques à la consultation de crédit | ||
with_details | boolean | (optionnel) Ajoute le détail de tous les packs de votre portefeuille. |
product_name | string | (optionnel) Nom du produit dans lequel vous voulez obtenir votre solde (sms_low_cost, sms_premium, vocal_sms, hlr). Vous devez également renseigner le country_code. |
Spécifiques à la gestion des contacts | ||
Spécifiques à la gestion des sous-comptes | ||
Nomenclature des codes SHA1
| Clés | Champs correspondants |
|---|---|
| T | sms_text |
| R | sms_recipients |
| M | sms_mode |
| Y | sms_type |
| S | sms_sender |
| D | sending_date |
| a | recipients_first_names |
| b | recipients_last_names |
| c | sms_fields_1 |
| d | sms_fields_2 |
| e | sms_fields_3 |
| W | with_replies |
| N | transactional |
| Q | request_id |