Notifications WPUSH

Aperçu

• Source: https://wpush.cn/
• Prise en charge des images: Non
• Prise en charge des pièces jointes: Non
• Limites de caractères des messages:
  • Corps: 10000
• Format(s) de message pris en charge:
  • ✓TEXT
• Créer votre URL Apprise

Configuration du Compte

WPUSH envoie des notifications via WeChat, son application, SMS, e-mail, DingTalk, Feishu, WeCom, WeChat ClawBot, le robot QQ et des Webhooks personnalisés. Plusieurs canaux peuvent partager un même appel API. L’authentification utilise une clé API personnelle.

1. Inscrivez-vous ou connectez-vous sur WPUSH.
2. Rendez-vous sur la page Clé API et copiez votre clé. Elle commence toujours par WPUSH suivi de 27 autres caractères (32 au total).
3. Rendez-vous sur la page Canaux et associez au moins un canal de livraison avant d’envoyer votre premier message.

L’URL de notification pour le cas d’usage le plus simple est :

wpush://{apikey}

Envoi par Topic (Diffusion)

WPUSH prend également en charge l’envoi d’une notification unique à tous les abonnés d’un topic nommé.

1. Créez un topic et notez son code de topic depuis votre tableau de bord WPUSH.
2. Envoyez au topic pour notifier tous ses abonnés.

Placez un ou plusieurs codes de topic directement dans le chemin de l’URL :

wpush://{apikey}/{topic}
wpush://{apikey}/{topic1}/{topic2}

Lorsque plusieurs topics sont listés, Apprise envoie la notification à chacun d’eux dans un appel API séparé.

Canaux de Livraison

Les notifications utilisent WeChat par défaut. Sélectionnez un ou plusieurs canaux avec ?channel= :

Valeur ?channel=	Canal
wechat	WeChat (par défaut, peut être omis)
app	L’application mobile WPUSH
sms	SMS
mail	E-mail
webhook	Point de terminaison webhook configuré
dingtalk	DingTalk
feishu	Feishu
wechat_work	WeCom (WeChat Work / Entreprise WeChat)
clawbot	WeChat ClawBot
qqbot	Robot QQ

Séparez plusieurs canaux par des virgules. WPUSH utilise un seul appel API pour tous :

wpush://{apikey}?channel=mail
wpush://{apikey}/{topic}?channel=feishu
wpush://{apikey}?channel=feishu,dingtalk,wechat_work

Codes de Groupe et d’Instance

?group= correspond au champ option de WPUSH et a deux usages :

• Avec qqbot, il sélectionne un groupe QQ plutôt que le propriétaire du compte.
• Avec Feishu, DingTalk, WeCom ou Webhook, il sélectionne une instance liée.

wpush://{apikey}?channel=qqbot&group={qq_group_code}
wpush://{apikey}?channel=feishu&group={instance_code}

Trouvez le code sur la page Canaux WPUSH. Sans ce paramètre, WPUSH utilise le propriétaire du compte ou l’instance par défaut. Cette option ne peut pas être combinée avec une diffusion par topic.

Lien Cliquable

Utilisez ?url= pour ajouter un lien sur les canaux compatibles :

wpush://{apikey}?url=https://example.com/

Syntaxe

Voici la syntaxe valide :

• https://api.wpush.cn/api/v1/send?apikey={apikey}
• wpush://{apikey}
• wpush://{apikey}/{topic}
• wpush://{apikey}/{topic1}/{topic2}
• wpush://{apikey}?channel={channel}
• wpush://{apikey}?channel={channel1},{channel2}
• wpush://{apikey}/{topic}?channel={channel}
• wpush://{apikey}?channel=qqbot&group={qq_group_code}
• wpush://{apikey}?url={lien_cliquable}

Détail des Paramètres

Variable	Requis	Description
apikey	*Oui	Votre clé API WPUSH personnelle. Commence toujours par WPUSH. Peut aussi être fournie via ?apikey=.
topic	Non	Code de topic placé dans le chemin de l’URL. Plusieurs topics peuvent apparaître ; un appel API est effectué par topic. Peut aussi être fourni via ?to=, ?topic= ou ?topic_code=.
channel	Non	Un ou plusieurs de wechat (défaut), app, sms, mail, webhook, dingtalk, feishu, wechat_work, clawbot, qqbot, séparés par des virgules. Fourni via ?channel=.
group	Non	Code de groupe QQ (qqbot), ou code d’instance liée pour feishu, dingtalk, wechat_work ou webhook. Ne peut pas être combiné avec un topic. Peut aussi être fourni via ?option=.
url	Non	Un lien cliquable optionnel joint à la notification.

Paramètres Globaux

Variable	Description
overflow	Gère les messages qui dépassent la limite documentée d’un service. La valeur par défaut est upstream. 👉 upstream : envoie un seul message sans le découper ni le tronquer selon cette limite. 👉 truncate : conserve la partie qui tient dans la limite et supprime le reste. 👉 split : privilégie une coupure lisible, utilise une coupure stricte si nécessaire, puis envoie toutes les parties dans l’ordre. Le découpage d’un contenu non déclaré ou structuré reste une solution au mieux. Utilisez upstream si le corps doit rester intact.
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é. Le résultat global de notify() est quand même considéré comme réussi 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 une simple notification personnelle :

apprise -vv -t "Titre" -b "Bonjour depuis Apprise" \
    wpush://WPUSHabc123def456ghi789jkl012mno

Envoyer à un topic :

apprise -vv -t "Alerte Équipe" -b "Déploiement terminé." \
    wpush://WPUSHabc123def456ghi789jkl012mno/ops-team

Envoyer à deux topics à la fois (un appel API par topic) :

apprise -vv -t "Diffusion" -b "Maintenance système dans 30 minutes." \
    wpush://WPUSHabc123def456ghi789jkl012mno/ops-team/dev-team

Livrer via Feishu au lieu du canal WeChat par défaut :

apprise -vv -t "Titre" -b "Message Feishu" \
    "wpush://WPUSHabc123def456ghi789jkl012mno?channel=feishu"

Livrer via trois canaux à la fois, en un seul appel API :

apprise -vv -t "Titre" -b "Message multi-canal" \
    "wpush://WPUSHabc123def456ghi789jkl012mno?channel=feishu,dingtalk,wechat_work"

Envoyer à un topic et livrer par e-mail :

apprise -vv -t "Titre" -b "E-mail de topic" \
    "wpush://WPUSHabc123def456ghi789jkl012mno/ops-team?channel=mail"

Livrer à un groupe QQ spécifique via le canal Robot QQ :

apprise -vv -t "Titre" -b "Message de groupe QQ" \
    "wpush://WPUSHabc123def456ghi789jkl012mno?channel=qqbot&group=123456789"

Livrer via une instance Feishu liée spécifique :

apprise -vv -t "Titre" -b "Message d'instance Feishu" \
    "wpush://WPUSHabc123def456ghi789jkl012mno?channel=feishu&group=my-instance"

Joindre un lien cliquable à la notification :

apprise -vv -t "Titre" -b "Voir le rapport" \
    "wpush://WPUSHabc123def456ghi789jkl012mno?url=https://example.com/report"

Utiliser directement l’URL native de l’API WPUSH :

apprise -vv -t "Titre" -b "Bonjour" \
    "https://api.wpush.cn/api/v1/send?apikey=WPUSHabc123def456ghi789jkl012mno"