Notifications Amazon Web Service (AWS) - Simple Notification Service (SNS)

Aperçu

• Source: https://aws.amazon.com/sns/
• 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

Vous devrez d’abord creer un compte Amazon Web Service, AWS, pour utiliser ce service. Si vous n’en avez pas encore, une carte bancaire sera necessaire, meme si les 12 premiers mois sont gratuits. Si vous avez deja un compte, ou si vous l’utilisez via votre entreprise, vous pouvez passer a l’etape suivante.

L’etape suivante consiste a generer un Access Key ID et un Secret Access Key :

1. Depuis la AWS Management Console, recherchez IAM dans la section AWS services ou cliquez simplement ici.
2. Developpez la section Access keys (access key ID and secret access key).
3. Cliquez sur Create New Access Key.
4. Les informations s’afficheront a l’ecran et vous pourrez aussi telecharger un fichier contenant les memes donnees. Il est recommande de le faire, car il ne sera plus possible de recuperer cette cle plus tard, sauf a la supprimer puis en creer une nouvelle.

A ce stade, on suppose donc que tout est configure et que vous disposez bien de votre Access Key ID et de votre Secret Access Key.

Vous avez maintenant tout ce qu’il faut pour envoyer des SMS.

Si vous souhaitez envoyer vos notifications vers des topics, recherchez Simple Notification Service dans la AWS Management Console, section AWS services, puis configurez autant de topics que necessaire. Vous pourrez ensuite les referencer avec ce service de notification.

Syntaxe

La syntaxe valide est la suivante :

• sns://{AccessKeyID}/{AccessKeySecret}/{Region}/+{PhoneNo}
• sns://{AccessKeyID}/{AccessKeySecret}/{Region}/+{PhoneNo1}/+{PhoneNo2}/+{PhoneNoN}
• sns://{AccessKeyID}/{AccessKeySecret}/{Region}/#{Topic}
• sns://{AccessKeyID}/{AccessKeySecret}/{Region}/#{Topic1}/#{Topic2}/#{TopicN}

Vous pouvez aussi melanger ces entrees :

• sns://{AccessKeyID}/{AccessKeySecret}/{Region}/+{PhoneNo1}/#{Topic1}

Le fait de prefixer les topics par un hashtag, #, et les numeros de telephone par un plus, +, permet d’eviter les ambiguities, par exemple lorsqu’un topic ne contient que des chiffres. Ces caracteres restent purement facultatifs.

Détail des Paramètres

Variable	Obligatoire	Description
AccessKeyID	Oui	Access Key ID genere depuis la AWS Management Console.
AccessKeySecret	Oui	Access Key Secret genere depuis la AWS Management Console.
Region	Oui	Code region, par exemple us-east-1, us-west-2, cn-north-1, etc.
PhoneNo	Non	Le numero de telephone doit inclure le prefixe d’appel du pays. Vous pouvez facultativement prefixer tout le numero avec un plus, +, pour forcer son interpretation comme numero de telephone si la detection automatique ne suffit pas. Ce champ accepte aussi les parentheses, espaces et tirets pour une meilleure lisibilite.
Topic	Non	Topic vers lequel publier votre message.

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.
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 un message SMS :

# Supposons que notre {AccessKeyID} soit AHIAJGNT76XIMXDBIJYA
# Supposons que notre {AccessKeySecret} soit bu1dHSdO22pfaaVy/wmNsdljF4C07D3bndi9PQJ9
# Supposons que notre {Region} soit us-east-2
# Supposons que notre {PhoneNo}
#   - se trouve aux Etats-Unis, donc avec l'indicatif pays +1
#   - corresponde au numero 800-555-1223
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   sns://AHIAJGNT76XIMXDBIJYA/bu1dHSdO22pfaaVy/wmNsdljF4C07D3bndi9PQJ9/us-east-2/+18005551223

# la variante suivante aurait aussi 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" \
   sns://AHIAJGNT76XIMXDBIJYA/bu1dHSdO22pfaaVy/wmNsdljF4C07D3bndi9PQJ9/us-east-2/+1(800)555-1223