Notifications Pushplus

Aperçu

• Source: https://www.pushplus.plus/
• Prise en charge des images: Non
• Prise en charge des pièces jointes: Non
• Limites de caractères des messages:
  • Corps: 20000
• Créer votre URL Apprise

Configuration du Compte

PushPlus est une plateforme de notification chinoise qui distribue les messages via WeChat et plusieurs autres canaux (e-mail, SMS, WeCom, webhook). Elle utilise un token personnel pour authentifier les requêtes.

1. Inscrivez-vous ou connectez-vous sur PushPlus.
2. Copiez le Token affiché dans votre tableau de bord sous la section « Push ».
3. Installez optionnellement le mini-programme PushPlus dans WeChat pour recevoir les messages sur votre téléphone.

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

pushplus://{token}

Envoi en Groupe (Topic)

PushPlus prend également en charge l’envoi d’une notification à tous les membres abonnés à un groupe nommé.

1. Ouvrez la section Group Push de la console PushPlus.
2. Créez un groupe et notez son code de groupe — c’est la valeur du topic.
3. Les abonnés rejoignent le groupe dans WeChat ; lorsque vous envoyez au topic, tous les membres reçoivent le message.

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

pushplus://{token}/{topic}
pushplus://{token}/{topic1}/{topic2}

Lorsque plusieurs topics sont listés, Apprise envoie la notification à chaque groupe dans un appel API séparé.

Canaux de Livraison

Par défaut, les notifications arrivent via WeChat. Vous pouvez les rediriger vers un canal différent en utilisant le paramètre de requête ?channel= (ou son synonyme ?mode=) :

Valeur ?channel=	Canal
wechat	WeChat (défaut — peut être omis)
webhook	Point de terminaison webhook configuré
cp	WeCom (WeChat Work / Enterprise WeChat)
wecom	Alias convivial pour cp — même canal
mail	Adresse e-mail enregistrée
sms	SMS

pushplus://{token}?channel=mail
pushplus://{token}/{topic}?channel=cp

channel= et mode= sont entièrement interchangeables ; utilisez celui qui se lit le plus naturellement dans votre configuration.

Alias de Schéma

Apprise accepte également wecom:// comme préfixe de schéma pour les utilisateurs WeCom. Il définit automatiquement le canal de livraison à cp — aucun paramètre de requête supplémentaire n’est nécessaire :

Schéma	Équivalent à
wecom://{token}	pushplus://{token}?channel=cp

Point de Terminaison Webhook Nommé

Lorsque vous utilisez ?channel=webhook, vous pouvez également cibler un point de terminaison nommé spécifique. Deux formes équivalentes sont acceptées :

pushplus://{token}?channel=webhook&name={webhook_name}
pushplus://{webhook_name}@{token}

Dans la deuxième forme (schema://{name}@{token}), le canal webhook est implicite — il n’est pas nécessaire d’ajouter ?channel=webhook explicitement. Un ?channel= explicite remplace toujours cette implication si vous avez besoin d’un canal différent.

Rendu des Messages

Le corps du message est rendu par PushPlus sur leurs serveurs en utilisant un template qui correspond au paramètre de format standard d’Apprise :

?format= Apprise	PushPlus rend comme
html (défaut)	HTML — gras, liens et images fonctionnent
markdown	Markdown — titres, gras, listes, etc.
text	Texte brut — sans mise en forme

Il n’y a pas de paramètre spécifique à PushPlus ; définissez ?format=markdown (ou l’équivalent dans votre YAML/config) de la même manière que pour tout autre service Apprise.

Syntaxe

La syntaxe valide est la suivante :

• https://www.pushplus.plus/send?token={token}
• pushplus://{token}
• pushplus://{token}/{topic}
• pushplus://{token}/{topic1}/{topic2}
• pushplus://{token}?channel={channel}
• pushplus://{token}/{topic}?channel={channel}
• pushplus://{token}?channel=webhook&name={webhook_name}
• pushplus://{webhook_name}@{token}
• wecom://{token}

Détail des Paramètres

Variable	Requis	Description
token	*Oui	Votre token PushPlus personnel depuis le tableau de bord. Peut également être fourni via ?token=.
topic	Non	Code de groupe placé dans le chemin de l’URL. Plusieurs topics peuvent apparaître ; un appel API est effectué par topic. Peut également être fourni via ?topic= ou ?to=.
channel	Non	Canal de livraison. L’un des suivants : wechat (défaut), webhook, cp, wecom, mail, sms. Fourni via ?channel= ou son alias ?mode=.
name	Non	Nom du point de terminaison webhook. Utilisé uniquement lorsque ?channel=webhook. Fourni via ?name= ou via le composant user@ : pushplus://{name}@{token} (implique channel=webhook).

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.

Voir Aussi

Si vous souhaitez envoyer des messages directement à un bot de groupe WeCom — sans passer par PushPlus — consultez le plugin WeCom Bot (wecombot://). Il utilise l’API webhook WeCom Group Bot directement et requiert une clé de bot, non un token PushPlus.

Exemples

Envoyer une notification personnelle simple :

apprise -vv -t "Titre" -b "Bonjour depuis Apprise" \
    pushplus://abc123def456ghi789jkl012mno345pq

Envoyer un message formaté en Markdown :

apprise -vv -t "Alerte" -b "## Avertissement\n\nQuelque chose s'est produit." \
    "pushplus://abc123def456ghi789jkl012mno345pq?format=markdown"

Envoyer à un groupe (topic) :

apprise -vv -t "Alerte Équipe" -b "Déploiement terminé." \
    pushplus://abc123def456ghi789jkl012mno345pq/mongroupe

Envoyer à deux groupes simultanément (un appel API par groupe) :

apprise -vv -t "Diffusion" -b "Maintenance système dans 30 minutes." \
    pushplus://abc123def456ghi789jkl012mno345pq/equipe-ops/equipe-dev

Livrer par e-mail :

apprise -vv -t "Titre" -b "Corps de l'e-mail" \
    "pushplus://abc123def456ghi789jkl012mno345pq?channel=mail"

Envoyer à un groupe et livrer par e-mail :

apprise -vv -t "Titre" -b "E-mail de groupe" \
    "pushplus://abc123def456ghi789jkl012mno345pq/mongroupe?channel=mail"

Livrer via un point de terminaison webhook nommé (forme longue) :

apprise -vv -t "Titre" -b "Charge utile webhook" \
    "pushplus://abc123def456ghi789jkl012mno345pq?channel=webhook&name=monhook"

Livrer via un point de terminaison webhook nommé (forme compacte — canal implicite) :

apprise -vv -t "Titre" -b "Charge utile webhook" \
    "pushplus://monhook@abc123def456ghi789jkl012mno345pq"

Utiliser l’alias de schéma WeCom (équivalent à ?channel=cp) :

apprise -vv -t "Titre" -b "Message WeCom" \
    wecom://abc123def456ghi789jkl012mno345pq

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

apprise -vv -t "Titre" -b "Bonjour" \
    "https://www.pushplus.plus/send?token=abc123def456ghi789jkl012mno345pq"