Notifications MSG91

Aperçu

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

Configuration du Compte

Pour utiliser MSG91, vous devez obtenir votre Clé d’Authentification. Celle-ci est accessible via le Tableau de Bord MSG91. De plus, vous devrez préparer un modèle et lui assigner des variables body, title et type afin qu’Apprise puisse y relayer ses informations.

Syntaxe

La syntaxe valide est la suivante :

• msg91://{TemplateID}@{AuthKey}/{PhoneNo}
• msg91://{TemplateID}@{AuthKey}/{PhoneNo1}/{PhoneNo2}/{PhoneNoN}

Détail des Paramètres

Variable	Requis	Description
AuthKey	Oui	La Clé d’Authentification associée à votre compte MSG91. Disponible via le Tableau de Bord MSG91.
TemplateID	Oui	L’Identifiant de Modèle associé à votre compte MSG91. Disponible via le Tableau de Bord MSG91.
PhoneNo	Oui	Un numéro de téléphone DOIT inclure le préfixe d’appel international du pays. Ce champ est très flexible et accepte les parenthèses, espaces et tirets si vous souhaitez formater le numéro de manière lisible.
short_url	Non	Un booléen (par défaut Non) indiquant si les messages SMS doivent utiliser la notation URL courte.

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.
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.

Variables de Modèle

Les modèles que vous générez vous permettent de définir vos propres correspondances de clés.

Les clés suivantes sont automatiquement transmises par Apprise au système de modèles MSG91, que vous choisissiez de les utiliser ou non.

• ##body## : Le corps du message Apprise (le titre y est préfixé s’il est défini)
• ##type## : Le type de message Apprise (par exemple warning, info, failure ou success)

Si vous souhaitez assigner de nouveaux types à body ou type depuis Apprise, ces mots-clés spéciaux sont spécifiés avec le préfixe : (deux-points) pour effectuer la correspondance/substitution. Par exemple : ?:body=msg remapperait le corps du message par défaut d’Apprise vers le mot-clé msg.

Si vous souhaitez exclure type de la transmission, définissez-le simplement dans l’URL sans lui assigner de valeur, comme ceci : ?:type.

Enfin, si vous souhaitez définir vos propres arguments, définissez-les de la manière suivante : ?:key=value assignera à key le contenu de value lors de la transmission à votre modèle.

Exemples

Envoyer une notification MSG91 par SMS :

# Assuming our {TemplateID} is 12345
# Assuming our {AuthKey} is gank339l7jk3cjaE
# Assuming our {PhoneNo} - is in the US somewhere making our country code +1
#                        - identifies as 800-555-1223
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   msg91://12345@gank339l7jk3cjaE/18005551223

# the following would also have worked (spaces, brackets,
# dashes are accepted in a phone no field):
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "msg91://12345@gank339l7jk3cjaE/1-(800) 555-1223"

Voici un exemple de modèle : Envoyer une notification MSG91 par SMS :

# Assuming our {TemplateID} is 12345
# Assuming our {AuthKey} is gank339l7jk3cjaE
# Assuming our {PhoneNo} - is in the US somewhere making our country code +1
# Assuming we want to map our `body` tag (sent from Apprise to `payload` instead
# Assuming we want to make sure Apprise does not pass along the `type`
# Assuming we want to define our Foobar Inc company name as the template token `company`:
#                        - identifies as 800-555-1223
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "msg91://12345@gank339l7jk3cjaE/18005551223?:body=payload&:type&company=Foobar%20Inc"