Accueil » API SMS Octopush » Liste des paramètres

Liste des paramètres

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

NomTypeDescription
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 »).’
textstringMessage texte (de 1 à 1224 caractères non unicodes).
recipientsarrayListe d’objets Contact (array d’objets) :
[
  {
    "phone_number": "+111222233334444",
    "param1": "Alex",
    "param2": null,
    "param3": null,
    "param4": null,
    "param5": null,
  },
  ...,
  {
    "phone_number": "+2222333334444555",
    "param1": "John",
  }
]
typestringType de la campagne : [« sms_premium », »sms_low_cost »]
purposestringBut de la campagne (transactionnel/alerte ou marketing) : [« alert », »wholesale »]
with_repliesboolean« True » pour recevoir les réponses de vos destinataires
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.
auto_optimize_textboolean(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_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’]
voice_genderstringGenre de la voix [« male », « female »]

Spécifiques à la consultation de crédit

with_detailsboolean(optionnel) Ajoute le détail de tous les packs de votre portefeuille.
product_namestring(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ésChamps correspondants
Tsms_text
Rsms_recipients
Msms_mode
Ysms_type
Ssms_sender
Dsending_date
arecipients_first_names
brecipients_last_names
csms_fields_1
dsms_fields_2
esms_fields_3
Wwith_replies
Ntransactional
Qrequest_id