Notifications Webex Teams

Aperçu

• Source: https://teams.webex.com
• Prise en charge des images: Non
• Prise en charge des pièces jointes: Oui
• Limites de caractères des messages:
  • Webhook: 1000
  • API Robot: 7439
• Créer votre URL Apprise

Configuration du compte

Les notifications Webex Teams peuvent être envoyées selon deux modes : Webhook (simple, sans pièces jointes) et Robot (accès API complet avec prise en charge des pièces jointes). Le mode est détecté automatiquement à partir du format du jeton, ou vous pouvez le forcer avec le paramètre d’URL mode=.

Mode 1 — Webhook (par défaut)

Pour utiliser le mode webhook, accédez d’abord à https://teams.webex.com et créez un compte si vous n’en avez pas encore. Vous devrez créer au moins un “space” avant de récupérer le “incoming webhook”.

Ensuite, installez l’intégration “Incoming webhook” disponible dans la catégorie “other” sur https://apphub.webex.com/integrations/. Au moment de la rédaction, ce lien direct y menait.

Une fois connecté, cliquez sur “Connect”, acceptez les permissions, puis donnez un nom au webhook, par exemple apprise.

Une fois terminé, vous recevrez une URL ressemblant à ceci :

https://api.ciscospark.com/v1/webhooks/incoming/\
       Y3lzY29zcGkyazovL3VzL1dFQkhPT0sajkkzYWU4fTMtMGE4Yy00

La dernière partie de l’URL est votre {token} :

• https://api.ciscospark.com/v1/webhooks/incoming/{token}

Remarque : Apprise prend en charge cette URL telle quelle (depuis la version 0.7.7).

Limitation : les incoming webhooks ne prennent pas en charge les pièces jointes. Utilisez le mode robot (ci-dessous) si vous devez envoyer des fichiers.

Mode 2 — Robot (Jeton API + Identifiant de Salon, avec pièces jointes)

1. Rendez-vous sur https://developer.webex.com/my-apps et créez un nouveau robot.
2. Après création du robot, copiez le jeton d’accès du robot affiché sur la page de confirmation (il n’est visible qu’une seule fois).
3. Invitez le robot dans l’espace/salon où il devra publier.
4. Récupérez l’identifiant de salon de cet espace. Vous pouvez lister les salons via la Rooms API. Cet identifiant de salon est une longue chaîne base64url comme Y2lzY29zcGFyazovL3VzL1JPTU9NLzEyMzQ1.

Assemblez votre URL Apprise comme suit :

wxteams://{bot_token}/{room_id}

Syntaxe

La syntaxe valide est la suivante :

Mode Webhook

• https://api.ciscospark.com/v1/webhooks/incoming/{token}
• https://webexapis.com/v1/webhooks/incoming/{token}
• wxteams://{token}/
• webex://{token}/

Mode Robot

• wxteams://{bot_token}/{room_id}/
• wxteams://{bot_token}/{room_id1}/{room_id2}/

Vous pouvez forcer explicitement un mode en ajoutant ?mode=webhook ou ?mode=bot. Si ce paramètre est omis, le mode est détecté automatiquement à partir du format du jeton :

• Un jeton de 80 à 160 caractères alphanumériques est traité comme un jeton webhook.
• Tout autre jeton (plus long, ou contenant des caractères non alphanumériques) est traité comme un jeton d’accès robot et exige au moins un identifiant de salon.

Détail des Paramètres

Variable	Requis	Description
token	Oui	Jeton webhook ou jeton d’accès robot (détection automatique selon le format)
room_id	Mode Robot seul	Identifiant du salon Webex où publier (peut être répété plusieurs fois)
mode	Non	Force le mode webhook ou bot (détection automatique si omis)

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 Webex Teams via webhook :

# Supposons que notre {token} soit T1JJ3T3L2DEFK543
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   wxteams://T1JJ3T3L2DEFK543/

Envoyer une notification via l’API robot vers un salon spécifique :

# {bot_token} et {room_id} sont des valeurs de remplacement pour vos vraies données
apprise -vv -b "Bonjour depuis le robot Apprise" \
   wxteams://NThhZjI0NzQtMGQx.../Y2lzY29zcGFyazovL3Vz.../

Envoyer une notification avec une pièce jointe (mode robot requis) :

apprise -vv -b "Voir le rapport joint" \
   --attach /path/to/report.pdf \
   wxteams://NThhZjI0NzQtMGQx.../Y2lzY29zcGFyazovL3Vz.../

Publier dans plusieurs salons avec un seul jeton robot :

apprise -vv -b "Message diffuse" \
   wxteams://{bot_token}/{room_id1}/{room_id2}/