Aller au contenu

Notifications 46elks

Aperçu

46elks est un fournisseur SMS simple. Vous vous authentifiez avec votre nom d’utilisateur et votre mot de passe API 46elks, puis vous envoyez to, message et optionnellement from. Le plugin itère sur chaque destinataire cible et publie des charges utiles encodées en formulaire vers le point de terminaison API fixe.

  1. Connectez-vous sur https://46elks.com et obtenez votre nom d’utilisateur API et votre mot de passe.
  2. Choisissez facultativement un identifiant d’expéditeur From, soit un numéro E.164 soit un expéditeur alphanumérique approuvé.
  3. Utilisez la forme URL 46elks:// dans Apprise pour envoyer des messages.

La syntaxe valide est la suivante (les alias 46elks:// et elks:// sont acceptés) :

  • 46elks://{user}:{password}@/{from}
  • 46elks://{user}:{password}@/{from}/{to}
  • 46elks://{user}:{password}@/{from}/{to1}/{to2}/{toN}
VariableRequisDescription
userOuiVotre nom d’utilisateur API 46elks
passwordOuiVotre mot de passe API 46elks
toOuiNuméro(s) de téléphone destinataire(s), format E.164 recommandé
fromNonIdentifiant d’expéditeur ou numéro E.164, si configuré dans 46elks
VariableDescription
overflowCe 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.
formatCe 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é.
verifyLes 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.
ctoSignifie 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.
rtoSignifie 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.
emojisActive 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.
tzIdentifie 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.

Envoyer un message simple :

Fenêtre de terminal
# Assuming our {user} is user123
# Assuming our {password} is pass
# Assuming our {Source} is +15551234567
# Because no target is specified, we will notify ourseles
apprise -vv -t "Test" -b "Bonjour d'Apprise" \
46elks://user123:pass@/+15551234567

Plusieurs destinataires et un identifiant d’expéditeur :

Fenêtre de terminal
# Assuming our {user} is user
# Assuming our {password} is pass456
# Assuming our {Source} is Acme
# Assuming our target {PhoneNo} we wish to notify is
# +15551234567 and +15551231234
apprise -vv -b "Statut: OK" \
"46elks://user:pass456@/+15551234567/+15551231234?from=Acme"
Questions ou commentaires ?

Documentation

Vous avez repéré une faute de frappe ou une erreur ? Signalez-la ou proposez une correction .

Problèmes Techniques

Vous rencontrez un problème avec le code ? Ouvrez un ticket sur GitHub :

Conçu avec amour depuis le Canada