Notifications Exotel

Aperçu

• Source: https://exotel.com/
• Prise en charge des images: Non
• Prise en charge des pièces jointes: Non
• Limites de caractères des messages:
  • Corps: 2000
• Créer votre URL Apprise

Configuration du Compte

Pour utiliser Exotel, vous aurez besoin de votre Account SID, de votre API Key et de votre API Token. Ces valeurs sont disponibles dans le tableau de bord Exotel dans les parametres API.

Exotel utilise le Account SID dans le point d’acces API ainsi que l’API Key avec l’API Token pour l’authentification HTTP basique. Pour des raisons de compatibilite ascendante, Apprise utilise le Account SID comme cle API lorsque apikey= n’est pas fourni.

Vous aurez aussi besoin d’une valeur source valide pour {FromPhoneNo}. Exotel accepte un ExoPhone, un Sender ID alphanumerique approuve ou un identifiant expediteur numerique approuve associe a votre compte.

Syntaxe

La syntaxe valide est la suivante :

• exotel://{AccountSid}:{ApiToken}@{FromPhoneNo}
• exotel://{AccountSid}:{ApiToken}@{FromPhoneNo}/{PhoneNo}
• exotel://{AccountSid}:{ApiToken}@{FromPhoneNo}/{PhoneNo1}/{PhoneNo2}/{PhoneNoN}
• exotel://{AccountSid}:{ApiToken}@{SenderID}/{PhoneNo}?apikey={ApiKey}
• exotel://{AccountSid}:{ApiToken}@{SenderID}/{PhoneNo1}/{PhoneNo2}?batch=yes

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

• exotel://{AccountSid}:{ApiToken}@{FromPhoneNo}/

Vous pouvez aussi transmettre des valeurs sous forme de parametres de requete :

• exotel://_?sid={AccountSid}&token={ApiToken}&apikey={ApiKey}&from={FromPhoneNo}&to={PhoneNo}

Détail des Paramètres

Variable	Obligatoire	Description
AccountSid	Oui	Account SID associe a votre compte Exotel. Il est utilise dans le chemin API Exotel.
ApiToken	Oui	API Token associe a votre compte Exotel. Il est utilise comme mot de passe pour l’authentification HTTP basique.
ApiKey	Non	API Key associee a votre compte Exotel. Elle est utilisee comme nom d’utilisateur pour l’authentification HTTP basique. Si elle est omise, Apprise utilise AccountSid pour assurer la compatibilite avec les anciennes URL.
FromPhoneNo	Oui	ExoPhone associe a votre compte Exotel. Le numero doit inclure l’indicatif du pays. Les espaces, parentheses et tirets sont acceptes pour la lisibilite.
SenderID	Oui	Identifiant expediteur, header, Exotel approuve et associe a votre compte. Il peut s’agir d’un Sender ID alphanumerique, tel que EXOTEL, ou d’un identifiant numerique, comme 600123. Utilisez-le a la place de FromPhoneNo lorsqu’il est configure dans Exotel.
PhoneNo	*Non	Le numero de telephone doit inclure l’indicatif du pays. Les espaces, parentheses et tirets sont acceptes pour la lisibilite. Si aucune cible n’est fournie, Apprise envoie le SMS a FromPhoneNo.
region	Non	Peut etre us ou in. Par defaut, la region est definie sur us. Utilisez in pour le point d’acces API de Mumbai.
priority	Non	Peut etre normal ou high. Par defaut, la priorite est definie sur normal. Exotel recommande high uniquement pour les messages OTP.
unicode	Non	Permet facultativement d’indiquer a Apprise si le SMS doit etre envoye en Unicode. Par defaut, cette valeur est yes ; definissez-la sur no pour utiliser un encodage texte brut.
batch	Non	Envoie plusieurs cibles dans une seule requete d’API bulk SMS Exotel. Par defaut, cette option est definie sur no, donc Apprise envoie une requete amont par cible.

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 Exotel sous forme de SMS :

# Supposons que notre {AccountSid} soit acme123
# Supposons que notre {ApiToken} soit exo-token
# 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" \
   exotel://acme123:exo-token@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" \
   exotel://acme123:exo-token@1-(900) 555-9999/1-(800) 555-1223

Envoyer via la region Inde en utilisant une cle API distincte et un sender ID approuve :

# Supposons que notre {AccountSid} soit acme123
# Supposons que notre {ApiKey} soit api-key
# Supposons que notre {ApiToken} soit exo-token
# Supposons que notre {SenderID} soit EXOTEL
# Supposons que notre {PhoneNo} soit +91-98765-43210
apprise -vv -b "Votre code de verification est 123456" \
   "exotel://acme123:exo-token@EXOTEL/919876543210?apikey=api-key&region=in&priority=high"

Envoyer un message a plusieurs cibles en utilisant les bulk SMS Exotel :

# Supposons que notre {AccountSid} soit acme123
# Supposons que notre {ApiKey} soit api-key
# Supposons que notre {ApiToken} soit exo-token
# Supposons que notre {SenderID} soit EXOTEL
# Supposons que notre {PhoneNo1} soit +91-98765-43210
# Supposons que notre {PhoneNo2} soit +91-98765-43211
apprise -vv -b "Your scheduled reminder" \
   "exotel://acme123:exo-token@EXOTEL/919876543210/919876543211?apikey=api-key&region=in&batch=yes"