Documentation utilisateur

⌘K
  1. Accueil
  2. Documentation utilisateur
  3. Notification Pack
  4. Configuration initiale des notifications SMS

Configuration initiale des notifications SMS

Le module Notification Pack vous permet d’envoyer des notifications par SMS. Pour commencer à envoyer des SMS, vous devez choisir un fournisseur SMS et copier / coller vos clés API dans les réglages de Booking Activities.

  • Allez dans Booking Activities > Réglages > onglet “Notifications”.
  • Faites défiler jusqu’à la section “Paramètres des notifications SMS”.

 

Sélectionnez un fournisseur SMS

Choisissez simplement le fournisseur souhaité dans une boîte de sélection et saisissez vos clés d’authentification API.

Les champs des clés requises seront affichés dynamiquement lorsque vous sélectionnez le fournisseur, afin que vous sachiez quelles informations d’identification vous devez saisir. Vous trouverez généralement ces informations facilement depuis votre compte chez votre fournisseur de SMS, voyez ci-dessous comment les retrouver par fournisseur :

 

AllMySMS

Sender ID Un identifiant d’expéditeur de votre choix. Vous devez respecter les contraintes de formatage. Dans certains pays, vous devez le préenregistrer dans SMS > Mes expéditeurs > Ajouter une ligne
API login Identifiant de connexion à votre compte. Trouvez-le dans Mon compte > Mon profil > Login.
API key Trouvez votre clé API dans API & Modules > Clé d’api & Paramètres > Votre clé d’API.

 

Brevo (SendInBlue)

Sender ID Identifiant de l’expéditeur. Le nombre de caractères est limité à 11 pour les caractères alphanumériques et à 15 pour les caractères numériques.
Les destinataires de certains pays (y compris les États-Unis) ne peuvent pas voir la personnalisation de l’expéditeur. Au lieu de cela, l’expéditeur apparaît sous la forme d’un code court numérique.
API Key Trouvez votre clé API dans Votre compte > SMTP et API > onglet “Clés API” > Générez une nouvelle clé API > Donnez-lui un nom comme “bookingactivities-sms” > Générez > Copiez votre clé API (c’est le seul moment où vous pourrez la copier) (docs).

 

ClickSend

Sender ID Un identifiant d’expéditeur de votre choix. Vous devez respecter le formatage et les contraintes locales
Username Trouvez votre Username et votre API Key dans Developers > API Credentials > “Username” et “API Key”.
API Key

 

CM.com

Sender ID Le nom de l’expéditeur. La longueur maximale est de 11 caractères alphanumériques ou 16 chiffres. Il existe également des restrictions spécifiques à chaque pays (docs).
Product Token Trouvez votre Product Token dans votre compte cm.com > API > Messaging Gateway > Authentification > onglet « Product Tokens » > Product Token > Copy.

 

MessageBird

Originator L’expéditeur du message. Il peut s’agir d’un numéro de téléphone (y compris l’indicatif du pays) ou d’une chaîne alphanumérique. Dans le cas d’une chaîne alphanumérique, la longueur maximale est de 11 caractères. Dans certains pays, vous devez l’enregistrer dans SMS > Registered originators.
Access Key Pour trouver votre clé d’accès, connectez-vous à la “Connectivity Platform” > Developers > Onglet “API Access” > Show key (utilisez la clé “test” sur votre site de développement et la clé “live” sur votre site public).

 

Octopush

Sender ID Expéditeur du message (si l’utilisateur le permet), 3-11 caractères alphanumériques (a-zA-Z0-9).
Login Trouvez votre Login et votre clé API dans API et intégrations > API HTTP – Identifiants > Cliquez sur l’icône « œil » pour révéler la clé API.
API Key

 

PrimoTexto

Sender ID L’expéditeur personnalisé du message : “YourCompany”. Sans personnalisation, l’expéditeur sera un code numérique court de type XX XXX. Si vous personnalisez l’expéditeur, celui-ci doit contenir entre 3 et 11 caractères ALPHANUMÉRIQUES.
Clé API Trouvez votre clé API dans API > Gestion des clés.

 

SendPulse

Sender ID Identifiant de l’expéditeur sous forme de valeur alphanumérique, 11 symboles maximum.
API ID Trouvez votre API ID et votre API Secret dans le menu de votre compte > Paramètres du compte > Onglet “API” > Cliquez sur l’icône “œil” pour révéler l'”ID” et le “Secret”.
API Secret

 

Sinch

Sender ID Numéro de l’expéditeur. Doit être un numéro de téléphone valide, un code court ou alphanumérique. Obligatoire si l’expéditeur par défaut n’est pas configuré.
Service Plan ID Trouvez votre Service Plan ID et votre API Token dans SMS > Service APIs > onglet « Services » > Cliquez sur « Show » pour révéler l’API Token.
API Token

 

SMS Envoi

Sender ID Le nom de l’expéditeur (règles). Si le type de message autorise un TPOA personnalisé et que le champ reste vide, le TPOA préféré de l’utilisateur est utilisé. Doit être vide si le type de message n’autorise pas un TPOA personnalisé.
Username L’email et le mot de passe associés à votre compte, ceux que vous utilisez pour vous connecter à votre compte. Vous pouvez les retrouver dans Compte > Compte > onglet “API & IP”.
API Password

 

SMSFactor

Sender ID Vous permet de personnaliser l’expéditeur.
API Token Trouvez votre API Token dans Developers > API Tokens > Create an API token > Cliquez sur le bouton « Click to display » pour voir le jeton.

 

smsmode

Sender ID L’identifiant de l’expéditeur (entre 1 et 11 caractères) (docs).
API Key Trouvez votre API Key dans Paramètres > Clés API > Générez une nouvelle Clé API.

 

Spot-Hit

Sender ID Le nom de l’expéditeur. Entre 3 et 11 caractères (voir plus de restrictions dans l’entrée “expediteur” du tableau).
API Key Trouvez votre clé API dans le menu de votre compte > Mon compte > API > Clé API.

 

Telesign

Sender ID Avec un compte d’essai, utilisez le numéro de téléphone associé à votre compte. De plus, avec un compte d’essai, vous ne pourrez envoyer des SMS qu’à des numéros de téléphone de test, vous pouvez en ajouter un dans menu de votre compte > Manage test numbers.
Avec un compte mis à niveau, cette option vous permet de définir un Sender ID alphanumérique. Afin d’utiliser un Sender ID spécifique, Telesign doit le mettre sur liste blanche (docs).
Sachez que le Sender ID peut ne pas être préservé tel quel. Telesign peut remplacer le Sender ID que le detinataire recevra afin d’améliorer la qualité de la livraison ou de suivre les réglementations SMS dans certains pays. Pour utiliser cette fonctionnalité, vous devez contacter le support Telesign et lui demander de l’activer pour vous. Nous recommandons de limiter les valeurs à 0-9 et A-Z, car la prise en charge d’autres caractères ASCII varie selon l’opérateur.
Customer ID Trouvez votre Customer ID et votre API Key dans menu de votre compte > API Keys > Cliquez sur le bouton “Show” pour voir la clé.
API Key

 

TextingHouse

Sender ID Vous permet de personnaliser l’identifiant de l’expéditeur du SMS. Limité à 11 caractères non accentués (a-zA-Z0-9), et doit être préenregistré dans votre compte > onglet “Noms d’expéditeur”. La personnalisation de l’identifiant de l’expéditeur n’est pas possible pour certaines destinations (restriction technique de certains opérateurs). TextingHouse se réserve le droit de remplacer l’expéditeur choisi au moment de l’envoi.
Username Trouvez votre identifiant et votre mot de passe dans l’onglet “Login API”.
Password

 

Textlocal

Sender ID Utilisez ce champ pour spécifier le nom de l’expéditeur de votre message. Celui-ci doit comporter au moins 3 caractères mais pas plus de 11 caractères alphanumériques ou 13 caractères numériques. Les noms d’expéditeurs peuvent également inclure un point, &, un trait de soulignement ou un trait d’union. S’il n’est pas renseigné ici, le nom d’expéditeur par défaut configuré sur votre compte sere utilisé.
API Key Trouvez votre API Key dans Settings > API Keys (vous devrez peut-être créer une nouvelle clé).

 

Twilio

Twilio phone number / Alphanumeric Sender ID Le numéro de téléphone Twilio de l’expéditeur (au format E.164), l’identifiant alphanumérique de l’expéditeur, la carte SIM sans fil, ou le code court. Cet identifiant d’expéditeur doit être hébergé dans votre compte Twilio.
Trouvez votre numéro de téléphone Twilio dans la zone Account info. Vous devrez peut-être d’abord créer votre numéro de téléphone dans l’assistant de configuration juste au-dessus (Step 1. Get a Twilio phone number).
Vous pourrez personnaliser l’expéditeur avec un identifiant d’expéditeur alphanumérique après la mise à niveau de votre compte. De plus, vous ne pouvez envoyer des SMS qu’à des numéros vérifiés avec un compte d’essai (dans Phone numbers > Manage > Verified Caller IDs) (docs).
SID du compte Recherchez le SID de votre compte et le numéro de jeton d’authentification dans les Account info ou dans le menu menu “Account” > Keys and Credentials > API keys & tokens (ici, vous pouvez trouver vos clés de test et live).
Jeton d’authentification

 

Vonage (Nexmo)

Sender ID Le nom ou le numéro à partir duquel le message doit être envoyé. Les Sender ID alphanumériques ne sont pas pris en charge dans tous les pays, voir Global messaging pour plus de détails. Les espaces sont ignorés et les numéro de téléphones doivent être au format E.164.
API Key Trouvez votre API Key et votre API Secret dans votre
Tableau de bord “API de communication” > API Settings
.
API Secret

 

Autre – Configuration curl manuelle

Si vous souhaitez utiliser un fournisseur SMS qui n’est pas préconfiguré (c’est-à-dire qui ne figure pas dans la liste), vous pouvez le configurer vous-même. Cela requiert des connaissances techniques.

Il y a deux prérequis :

  • le fournisseur de SMS doit disposer d’une API REST (ce devrait toujours être le cas, hors rares exceptions)
  • le fournisseur de SMS n’a besoin que d’une seule requête curl pour envoyer un SMS (cela couvre 90% des cas). Certains fournisseurs de SMS (comme SendPulse) nécessitent deux requêtes : une pour l’authentification, la seconde pour l’envoi du SMS. Ceux-ci ne sont pas compatibles (ou nécessitent un code personnalisé supplémentaire).

La première étape consiste à trouver la documentation de l’API pour envoyer un SMS avec une requête curl. Une fois que vous l’avez, vous devrez transposer la requête curl dans les réglages de Booking Activities :

  • Sélectionnez “Autre – Configuration curl manuelle” dans la boîte de sélection.
  • Sender ID : obligatoire. Généralement le numéro de téléphone fourni par votre fournisseur de SMS ou un identifiant alphanumérique de votre choix (11 caractères). Cette valeur sera stockée dans la balise {sender_id}, que vous pourrez utiliser dans les options curl ci-dessous.
  • API Login : peut être requis. Certains fournisseurs de SMS nécessitent un identifiant en plus de la clé API. Vous pouvez généralement le trouver dans le tableau de bord de votre compte chez votre fournisseur SMS et le saisir ici. Il peut être nommé différemment. Cette valeur sera stockée dans la balise {api_login}, que vous pourrez utiliser dans les options curl ci-dessous.
  • API Key : obligatoire. Tous les fournisseurs de SMS nécessitent une clé secrète pour s’authentifier. Vous pouvez généralement la trouver dans le tableau de bord de votre compte chez votre fournisseur de SMS et la saisir ici. Elle peut être nommé différemment. Cette valeur sera stockée dans la balise {api_key}, que vous pourrez utiliser dans les options curl ci-dessous.
  • URL API (CURLOPT_URL) : URL vers laquelle la requête doit être envoyée.
  • Curl Header (CURLOPT_HTTPHEADER) : données incluses dans l’en-tête de la requête curl. Définissez la partie avant le « : » dans la colonne « Clé » et la partie après le « : » dans la colonne « Valeur ». (Par exemple : “Clé” = “content-type” / “Valeur” = “application/json”)
    • L’en-tête “content-type” est souvent nécessaire car elle définit comment les données sont formatées avant d’être envoyées (le fournisseur SMS attend un certain format de données) :

      • “Content-Type” n’est pas spécifié : les données sont envoyées sous forme de tableau
      • “Content-Type” = “application/json” : les données sont envoyées sous forme d’objet json
      • “Content-Type” = “application/x-www-form-urlencoded” : les données sont envoyées sous forme de paramètres d’URL
  • Curl Data (CURLOPT_POSTFIELDS) : données postées dans le corps de la requête. Il s’agit d’un array avec des clés et des valeurs (par exemple : “Clé” = “sms_content” / “Valeur” = “{message}”). Si la valeur est un array, séparez les clés par un point dans la colonne “Clé” (ex : “Clé” = “my_array.0” / “Valeur” = “Hello”, “Clé” = “my_array.my_key.0. nom” / “Valeur” = “Bonjour”).
  • Curl Options (additional CURLOPT_*) : vous pouvez ajouter n’importe quelle option curl ici (par exemple : “Clé” = “CURLOPT_TIMEOUT” / “Valeur” = “30”).

Vous pouvez utiliser les balises suivantes dans API URL (CURLOPT_URL), Curl Header (CURLOPT_HTTPHEADER), Curl Data (CURLOPT_POSTFIELDS) et Curl Options (additional CURLOPT_*) :

  • {sender_id} : valeur du champ Sender ID.
  • {api_login} : valeur du champ API Login.
  • {api_key} : valeur du champ API Key.
  • {base64_token} : il s’agit de la valeur encodée en base64 de API Login et API Key séparée par deux points (base64_encode( {api_login}:{api_key} )).
  • {message} : Le message SMS.
  • {recipient} : le numéro de téléphone du destinataire avec le préfixe international (chaîne de charactères).
  • {recipient_no+} : identique à {recipient} mais le numéro de téléphone n’est pas préfixé par un +.
  • {recipients_array} : les numéros de téléphone des destinataires avec le préfixe international (array).
  • {recipients_array_no+} : identique à {recipients_array} mais les numéros de téléphone ne sont pas préfixés par un +.

Pour savoir comment remplir ces champs, vous devez analyser la requête curl dans la documentation du fournisseur SMS et la transposer dans les réglages de Booking Activities. Voici un exemple:

curl -X POST \
'https://api.mysmsprovider.com/sms/YOUR_USER_ID/send' \
-H 'Authorization: Basic YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"from": "SENDER_ID",
"to": "+33612345678",
"text": "Hello this is a test SMS",
"date" : "2019-03-25 19:00:00"
}'

se transpose en

  • Sender ID : votre expéditeur alphanumérique personnalisé (ou le numéro de téléphone fourni par votre fournisseur de SMS). Consultez la documentation de votre fournisseur SMS.
  • API Login : trouvez votre “USER ID” dans le tableau de bord de votre compte et collez-le ici.
  • API Key : trouvez votre “API TOKEN” dans le tableau de bord de votre compte et collez-le ici.
  • API URL (CURLOPT_URL) : https://api.mysmsprovider.com/sms/{api_login}/send
  • Curl Header (CURLOPT_HTTPHEADER) :
      Clé Valeur
      Authorization Basic {api_key}
      Content-Type application/json
  • Curl Data (CURLOPT_POSTFIELDS) :
      Clé Valeur
      from {sender_id}
      to {recipient}
      text {message}
  • Curl Options (additional CURLOPT_*) : Laissez vide.

Activez l’option Mode débugage pour pouvoir lire les réponses curl dans le fichier wp-content/plugins/booking-activities/log/debug.log, les messages de succès / erreurs seront affichés ici et vous permettront de savoir si cela fonctionne / ce qui ne fonctionne pas.

Avez-vous besoin de plus d’exemples ?

  • Allez dans Booking Activities > Réglages > onglet Notifications > Faites défiler jusqu’à “Paramètres des notifications SMS” > Sélectionnez un fournisseur SMS dans la boîte de sélection “Fournisseur SMS” > Enregistrez les modifications.
  • Cliquez sur “Afficher les options avancées” sous la boîte de sélection “Fournisseur SMS”.
  • Un lien “Documentation API” apparaît et tous les champs apparaissent avec leurs valeurs préconfigurées. Vous pouvez ainsi voir la documentation de l’API et comment les champs ont été remplis en conséquence pour chacun des fournisseurs SMS préconfigurés.
Notez que vous pouvez ajouter des valeurs aux fournisseurs SMS préconfigurés et remplacer les valeurs préconfigurées simplement en ajoutant une ligne ayant la même clé. Pour remplacer l’API URL (CURLOPT_URL), ajoutez une ligne dont la clé est “CURLOPT_URL” dans le tableau Curl Options (additional CURLOPT_*).

Félicitations, la configuration initiale est terminée. Vous devez maintenant paramétrez vos notifications SMS, et récupérez le numéro de téléphone de vos clients, ainsi que leur autorisation.

Comment pouvons-nous aider ?