Notifications Twilio

Aperçu

• Source: https://twilio.com
• Prise en charge des images: Non
• Prise en charge des pièces jointes: Non
• Limites de caractères des messages:
  • SMS: 160
  • Appel Telephonique (TwiML): 4000
• Créer votre URL Apprise

Configuration du Compte

Pour utiliser Twilio, vous devez recuperer votre Account SID et votre Auth Token. Tous deux sont disponibles via le Tableau de Bord Twilio.

Vous devez aussi disposer d’un numero defini comme Active Number, accessible depuis votre tableau de bord ici. Il deviendra votre {FromPhoneNo} dans les exemples ci-dessous.

Syntaxe

La syntaxe valide est la suivante :

SMS (par defaut)

• twilio://{AccountSID}:{AuthToken}@{FromPhoneNo}/{PhoneNo}
• twilio://{AccountSID}:{AuthToken}@{FromPhoneNo}/{PhoneNo1}/{PhoneNo2}/{PhoneNoN}

Si aucun ToPhoneNo n’est precise, alors le FromPhoneNo recevra le message a la place ; l’URL suivante est donc valide :

• twilio://{AccountSID}:{AuthToken}@{FromPhoneNo}/

Les Short Codes sont aussi pris en charge, mais exigent au moins un PhoneNo cible :

• twilio://{AccountSID}:{AuthToken}@{ShortCode}/{PhoneNo}
• twilio://{AccountSID}:{AuthToken}@{ShortCode}/{PhoneNo1}/{PhoneNo2}/{PhoneNoN}

Appel Telephonique

Lorsque method=call est specifie, Twilio initie un appel telephonique sortant et lit le corps du message en utilisant TwiML. Le corps doit etre un document TwiML valide :

• twilio://{AccountSID}:{AuthToken}@{FromPhoneNo}/{PhoneNo}?method=call
• twilio://{AccountSID}:{AuthToken}@{FromPhoneNo}/{PhoneNo1}/{PhoneNo2}/{PhoneNoN}?method=call

Note

Les appels telephoniques ne sont pas compatibles avec les Short Codes ni avec les numeros prefixes WhatsApp (w:).

Détail des Paramètres

Variable	Obligatoire	Description
AccountSID	Oui	Account SID associe a votre compte Twilio. Il est disponible via le Tableau de Bord Twilio.
AuthToken	Oui	Auth Token associe a votre compte Twilio. Il est disponible via le Tableau de Bord Twilio.
FromPhoneNo	*Non	Active Phone Number associe a votre compte Twilio et depuis lequel vous souhaitez envoyer le SMS ou effectuer l’appel. Il doit s’agir d’un numero enregistre chez Twilio. En alternative a FromPhoneNo, vous pouvez fournir un ShortCode (SMS uniquement). Le numero doit inclure l’indicatif du pays. Ce champ est assez tolerant et accepte aussi les parentheses, les espaces et les tirets pour une meilleure lisibilite.
ShortCode	*Non	ShortCode associe a votre compte Twilio et depuis lequel vous souhaitez envoyer le SMS. Il doit s’agir d’un numero enregistre chez Twilio. En alternative a ShortCode, vous pouvez fournir un FromPhoneNo. Les Short Codes ne sont pas pris en charge pour les appels telephoniques.
PhoneNo	*Non	Le numero de telephone doit inclure l’indicatif du pays. Ce champ est assez tolerant et accepte aussi les parentheses, les espaces et les tirets pour une meilleure lisibilite. Remarque : si vous utilisez un ShortCode, alors au moins un PhoneNo doit etre defini.
method	Non	La methode de notification a utiliser. Definissez sms (par defaut) pour envoyer un SMS, ou call pour initier un appel telephonique sortant. Avec call, le corps du message doit etre un document TwiML valide (ex. <Response><Say>Bonjour</Say></Response>). Les prefixes WhatsApp (w:) et les Short Codes ne sont pas compatibles avec method=call.
apikey	Non	Cle API Twilio optionnelle (commencant par SK). Lorsqu’elle est fournie, elle remplace l’Account SID pour l’authentification HTTP Basic, ce qui correspond a l’approche recommandee pour un usage en production.

Note

Ce service de notification n’utilise pas le champ title ; seul le body est transmis.

Paramètres Globaux

Variable	Description
overflow	Ce paramètre peut être défini sur split, truncate ou upstream. Il détermine la manière dont Apprise remet le message que vous lui transmettez. Par défaut, il vaut upstream. 👉 upstream : ne fait aucune modification et transmet le message exactement tel qu’il a été reçu au service. 👉 truncate : veille à ce que le message tienne dans la limite amont documentée par le service. Si plus d’informations sont fournies que la limite définie, l’excédent est tronqué. 👉 split : similaire à truncate, sauf que si le message dépasse la limite amont documentée par le service, il est découpé en plusieurs morceaux plus petits puis envoyés séquentiellement.
format	Ce paramètre peut être défini sur text, html ou markdown. Certains services prennent en charge plusieurs formats de publication du contenu. La valeur par défaut varie selon le service choisi et peut correspondre à l’un de ces trois formats. Vous pouvez facultativement forcer cette option pour vous écarter du comportement par défaut. Si le service ne prend pas en charge plusieurs formats de transmission, ce champ est ignoré.
verify	Les requêtes externes vers des emplacements sécurisés, par exemple via https, utilisent des certificats. Par défaut, Apprise vérifie la validité de ces certificats ; si ce n’est pas le cas, aucune notification n’est envoyée à la source. Dans certains cas, un utilisateur ne dispose pas d’une autorité de certification pour valider la clé ou fait simplement confiance à la source ; dans ce cas, vous pouvez définir ce drapeau sur no. Par défaut, il vaut yes.
redirect	Par défaut, Apprise suit les redirections HTTP (réponses 3xx) émises par le serveur distant, conformément au comportement de la bibliothèque requests sous-jacente. Si vous souhaitez empêcher la transmission des en-têtes personnalisés et des identifiants vers des destinations différentes de l’URL d’origine, définissez cette option sur no. Par défaut, elle vaut yes.
cto	Signifie Socket Connect Timeout. Il s’agit du nombre de secondes pendant lesquelles Requests attend que votre client établisse une connexion avec une machine distante, ce qui correspond à l’appel connect() sur la socket. La valeur par défaut est de 4.0 secondes.
rto	Signifie Socket Read Timeout. Il s’agit du nombre de secondes pendant lesquelles le client attend que le serveur envoie une réponse. La valeur par défaut est de 4.0 secondes.
emojis	Active la prise en charge des emojis, par exemple :+1: qui sera traduit en 👍. Par défaut, cette option vaut no. Remarque : selon la configuration côté serveur, l’administrateur peut désactiver globalement la prise en charge des emojis ; mais par défaut, ce n’est pas le cas.
tz	Identifie le fuseau horaire de la base IANA que vous souhaitez utiliser. Par défaut, celui-ci est détecté à partir de la configuration du serveur qui exécute Apprise. Vous pouvez le définir sur des valeurs comme America/Toronto, ou sur tout autre fuseau correctement formaté correspondant à votre région.
retry	Nombre de tentatives de remise supplémentaires après le premier échec, avant d’abandonner. Accepte un entier compris entre 0 et 10. La valeur par défaut est 0 (aucune nouvelle tentative — une seule tentative est effectuée). Lorsqu’il est combiné avec wait, Apprise marque une pause du nombre de secondes spécifié entre chaque tentative.
wait	Nombre de secondes à attendre entre les nouvelles tentatives. Accepte une valeur décimale comprise entre 0.0 et 20.0 ; les entiers sont automatiquement convertis en virgule flottante. La valeur par défaut est 0.5. Ce paramètre n’est utile que si retry est supérieur à zéro — un service avec retry=0 effectue exactement une tentative, quelle que soit la valeur de wait.
optional	Lorsqu’il est défini sur yes, un échec de remise pour ce service est silencieusement absorbé. L’appel global notify() retourne quand même True même si ce point de terminaison était injoignable, à condition que tous les services requis (non optionnels) du même lot aient réussi. Ce drapeau ne saute pas la remise ni ne contourne la logique de nouvelles tentatives — toutes les tentatives configurées sont effectuées avant que l’échec soit absorbé. Par défaut, il vaut no, ce qui signifie que chaque échec est propagé à l’appelant.

Exemples

Envoyer une notification Twilio sous forme de SMS :

# Supposons que notre {AccountSID} soit AC735c307c62944b5a
# Supposons que notre {AuthToken} soit e29dfbcebf390dee9
# Supposons que notre {FromPhoneNo} soit +1-900-555-9999
# Supposons que notre {PhoneNo}
#  - se trouve aux Etats-Unis, donc avec l'indicatif +1
#  - corresponde a 800-555-1223
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   twilio://AC735c307c62944b5a:e29dfbcebf390dee9@19005559999/18005551223

# l'exemple suivant aurait egalement fonctionne, les espaces,
# parentheses et tirets sont acceptes dans un numero :
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   twilio://AC735c307c62944b5a:e29dfbcebf390dee9@1-(900) 555-9999/1-(800) 555-1223

Envoyer une notification Twilio sous forme d’appel telephonique avec TwiML :

# Supposons que notre {AccountSID} soit AC735c307c62944b5a
# Supposons que notre {AuthToken} soit e29dfbcebf390dee9
# Supposons que notre {FromPhoneNo} soit +1-900-555-9999
# Supposons que notre {PhoneNo} soit +1-800-555-1223
apprise -vv -t "Titre du Message de Test" \
   -b "<Response><Say>Corps du Message de Test</Say></Response>" \
   "twilio://AC735c307c62944b5a:e29dfbcebf390dee9@19005559999/18005551223?method=call"

Prise en Charge de WhatsApp

Si votre compte est configure pour prendre en charge WhatsApp for Business, vous pouvez aussi utiliser ce plugin pour notifier ces points de terminaison. Il suffit de placer w: devant les numeros sortants qui doivent etre remis via WhatsApp au lieu de la configuration Twilio par defaut, par exemple :

# Supposons que notre {AccountSID} soit AC735c307c62944b5a
# Supposons que notre {AuthToken} soit e29dfbcebf390dee9
# Supposons que notre {FromPhoneNo} soit +1-900-555-9999
# Supposons que notre {PhoneNo} WhatsApp soit +1 555 123 3456
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   twilio://AC735c307c62944b5a:e29dfbcebf390dee9@19005559999/w:15551233456

# l'exemple suivant aurait egalement fonctionne, les espaces,
# parentheses et tirets sont acceptes dans un numero :
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   twilio://AC735c307c62944b5a:e29dfbcebf390dee9@1-(900) 555-9999/w:+1 555 123 3456

Vous pouvez aussi placer w: devant votre propre numero afin de modifier le comportement par defaut et faire en sorte que tous les numeros suivants soient interpretes comme des destinations WhatsApp. Par exemple : twillio://credentials/w:18005559876/15551234444/15551235555

Dans l’exemple ci-dessus, les numeros cibles 15551234444 et 15551235555 seraient envoyes via WhatsApp, car le comportement par defaut de traitement des numeros a ete modifie en prefixant la source par w:.

Remarque : les sources basees sur des Short Codes ne fonctionneront pas avec WhatsApp.