Notifications WeChat (Application WeCom)

Aperçu

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

Configuration du Compte

Ce plugin utilise l’API de messages de l’application WeCom pour livrer des notifications directement aux utilisateurs, departements ou etiquettes d’une organisation WeCom (WeChat Work / Enterprise WeChat). Aucun service intermediaire n’est requis.

Vous aurez besoin de trois identifiants provenant de la console d’administration WeCom :

1. Connectez-vous a la console d’administration WeCom sur https://work.weixin.qq.com/.
2. Allez dans “Applications & Mini Programs” -> “Applications” et creez une nouvelle application auto-developpee, ou selectionnez-en une existante.
3. Copiez l’AgentID affiche sur la page de details de l’application.
4. Allez dans “Mon Entreprise” -> “Informations sur l’Entreprise” et copiez le CorpID.
5. Sur la page de l’application, cliquez sur “Afficher” a cote de Secret et copiez le Secret d’Application.

Note

Le Secret d’Application n’est affiche qu’une seule fois apres sa generation. Conservez-le en lieu sur.

Syntaxe

La syntaxe valide est la suivante :

• wechat://{corpid}:{corpsecret}@{agentid}/@all
• wechat://{corpid}:{corpsecret}@{agentid}/@{userid}
• wechat://{corpid}:{corpsecret}@{agentid}/@{user1}/@{user2}
• wechat://{corpid}:{corpsecret}@{agentid}/%23{deptid}
• wechat://{corpid}:{corpsecret}@{agentid}/+{tagid}
• wechat://{corpid}:{corpsecret}@{agentid}/@{user}/%23{dept}/+{tag}

Regles de prefixe des destinataires :

Prefixe	Type de destinataire	Exemple
@	Identifiant utilisateur WeCom (optionnel en entree, toujours emis)	@johndoe
@all	Tous les utilisateurs de l’organisation	@all
%23 (# encode en URL)	Identifiant de departement (numerique)	%23100
+	Identifiant d’etiquette (numerique)	+7

Note

@all est un mot-cle reserve qui diffuse a tous les membres de l’organisation. La forme sans prefixe all (sans @) est egalement acceptee et traitee de maniere identique. Les deux formes envoient a tout le monde et non a un utilisateur nomme “all”.

Le prefixe @ sur les identifiants utilisateur ordinaires est optionnel lors de la saisie manuelle d’une URL — johndoe et @johndoe sont tous deux acceptes. Apprise emet toujours le prefixe @ dans les URLs generees pour que tous les types de destinataires soient visuellement distincts.

Vous pouvez combiner plusieurs destinataires de differents types dans une seule URL. Au moins un destinataire doit etre specifie.

Detail des Parametres

Variable	Obligatoire	Description
corpid	*Oui	L’identifiant d’entreprise (CorpID) trouve sous “Mon Entreprise” -> “Informations sur l’Entreprise” dans la console d’administration WeCom.
corpsecret	*Oui	Le Secret d’Application genere pour l’application auto-developpee.
agentid	*Oui	L’identifiant d’agent (AgentID) numerique affiche sur la page de details de l’application.
targets	Non	Un ou plusieurs destinataires dans le chemin de l’URL. Utilisez aucun prefixe pour les identifiants utilisateur, @all pour toute l’organisation, le prefixe %23 pour les identifiants de departement, et + pour les identifiants d’etiquette.
to	Non	Liste de destinataires separee par des virgules fournie en tant que parametre de requete (?to=) plutot que dans le chemin de l’URL.
format	Non	Definissez a markdown pour envoyer le corps de la notification comme un message Markdown WeCom ; le texte brut est la valeur par defaut.

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.
redirect	Par défaut, Apprise suit les redirections HTTP (réponses 3xx) émises par le serveur distant, conformément au comportement de la bibliothèque requests sous-jacente. Si vous souhaitez empêcher la transmission des en-têtes personnalisés et des identifiants vers des destinations différentes de l’URL d’origine, définissez cette option sur no. Par défaut, elle 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.
retry	Nombre de tentatives de remise supplémentaires après le premier échec, avant d’abandonner. Accepte un entier compris entre 0 et 10. La valeur par défaut est 0 (aucune nouvelle tentative — une seule tentative est effectuée). Lorsqu’il est combiné avec wait, Apprise marque une pause du nombre de secondes spécifié entre chaque tentative.
wait	Nombre de secondes à attendre entre les nouvelles tentatives. Accepte une valeur décimale comprise entre 0.0 et 20.0 ; les entiers sont automatiquement convertis en virgule flottante. La valeur par défaut est 0.5. Ce paramètre n’est utile que si retry est supérieur à zéro — un service avec retry=0 effectue exactement une tentative, quelle que soit la valeur de wait.
optional	Lorsqu’il est défini sur yes, un échec de remise pour ce service est silencieusement absorbé. L’appel global notify() retourne quand même True même si ce point de terminaison était injoignable, à condition que tous les services requis (non optionnels) du même lot aient réussi. Ce drapeau ne saute pas la remise ni ne contourne la logique de nouvelles tentatives — toutes les tentatives configurées sont effectuées avant que l’échec soit absorbé. Par défaut, il vaut no, ce qui signifie que chaque échec est propagé à l’appelant.

Exemples

Envoyer a tous les utilisateurs de l’organisation :

# Remplacez par votre CorpID, Secret d'Application et AgentID
apprise -vv -t "Titre de Test" -b "Message de Test" \
   "wechat://wwCORPID:SECRETAPP@1000002/@all"

Envoyer a un utilisateur specifique :

apprise -vv -t "Titre de Test" -b "Message de Test" \
   "wechat://wwCORPID:SECRETAPP@1000002/@johndoe"

Envoyer a plusieurs utilisateurs :

apprise -vv -t "Titre de Test" -b "Message de Test" \
   "wechat://wwCORPID:SECRETAPP@1000002/@alice/@bob/@charlie"

Envoyer a un departement (identifiant de departement 42) :

apprise -vv -t "Titre de Test" -b "Message de Test" \
   "wechat://wwCORPID:SECRETAPP@1000002/%2342"

Envoyer une notification au format Markdown :

apprise -vv -t "Titre de Test" -b "## Alerte\nQuelque chose s'est produit." \
   "wechat://wwCORPID:SECRETAPP@1000002/@all?format=markdown"

Voir Aussi

Apprise propose egalement deux integrations WeCom/WeChat complementaires :

• WeCom Bot — envoie dans un groupe WeCom via une cle de webhook ; plus simple a configurer, mais livre dans un groupe plutot qu’a des utilisateurs ou departements specifiques.
• PushPlus — achemine les notifications via la plateforme PushPlus, qui prend en charge la livraison via WeChat, WeCom, email et SMS depuis un seul token personnel.