Notifications SMSEagle

Aperçu

• Source: https://www.smseagle.eu/
• Prise en charge des images: Non
• Prise en charge des pièces jointes: Oui
• Limites de caractères des messages:
  • Corps: 1200
• Créer votre URL Apprise

Configuration du compte

Procurez-vous votre passerelle materielle SMS/MMS SMSEagle ici. C’est depuis l’appareil que vous pourrez acceder a son interface web et configurer votre jeton d’acces.

Syntaxe

La syntaxe valide est la suivante :

• smseagles://{token}@{hostname}/{target}
• smseagles://{token}@{hostname}:{port}/{target}

Une target peut etre soit un numero de telephone, soit un contact, soit, si elle est prefixee par #, un groupe. Les contacts sont generalement prefixes par @.

• smseagles://{token}@{hostname}:{port}/{phoneNo}
• smseagles://{token}@{hostname}:{port}/{phoneNo1}/{phoneNo2}/{phoneNoN}
• smseagles://{token}@{hostname}:{port}/@{contact}
• smseagles://{token}@{hostname}:{port}/@{contact1}/@{contact2}/@{contactN}
• smseagles://{token}@{hostname}:{port}/#{group}
• smseagles://{token}@{hostname}:{port}/#{group1}/#{group2}/#{groupN}

Remarque : si vous choisissez d’utiliser des groupes, assurez-vous que le groupe est defini comme Public, sinon cela ne fonctionnera pas via l’API.

Vous pouvez aussi melanger les formats :

• smseagles://{token}@{hostname}:{port}/{to_phone1}/3@{group1}/@{contact1}

Pour lever toute ambiguite, si vous ne fournissez pas un numero de telephone valide et que la valeur analysee ne commence ni par # ni par @, elle sera interpretee comme un contact.

smseagle:// utilise le port 80, sans chiffrement, tandis que smseagles:// securise la connexion et utilise par defaut le port 443.

Détail des Paramètres

Variable	Obligatoire	Description
hostname	Oui	Nom d’hote associe a votre appliance et/ou compte SMSEagle.
token	Oui	Jeton d’acces genere et associe a votre compte SMSEagle.
port	Non	Port sur lequel votre serveur web ecoute. La valeur par defaut est 80 pour smseagle:// et 443 pour toutes les references smseagles://.
target	Oui	Numero de telephone, groupe et/ou contact auquel vous souhaitez envoyer votre notification.
batch	Non	Envoie plusieurs notifications precisees dans un seul lot, soit une seule publication vers le serveur distant. Par defaut, cette option vaut no.
test	Non	Execute l’envoi en mode test SMSEagle. Par defaut, cette option vaut No.
flash	Non	Envoie le message comme SMS Flash. Par defaut, cette option vaut No.
priority	Non	Peut etre defini sur normal ou high. Si rien n’est precise, la valeur par defaut est normal.
status	Non	Permet facultativement d’inclure une petite chaine ASCII representant l’etat de la notification envoyee, integree au message. Par defaut, cette option vaut no.

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.

Exemples

Envoyer une notification SMSEagle :

# Supposons que notre {AccessToken} soit abcd123
# Supposons que le {Hostname} de notre appliance SMSEagle soit smseagle.example.com
# Supposons que nous voulions notifier 555221237 et +18005551234
# Testez avec la commande suivante :
apprise -t "Titre de Test" -b "Message de Test" \
 smseagle://abcd123@smseagle.example.com/555221237/+18005551234

Les notifications SMSEagle prennent aussi en charge les pieces jointes, images uniquement :

# Les pieces jointes sont egalement prises en charge :
apprise -t "Titre de Test" -b "Message de Test" \
 smseagle://abcd123@smseagle.example.com/555221237/+18005551234 \
 --attach /path/to/image.png