Aller au contenu

Notifications Kook

Aperçu

Kook (anciennement Kaihei / 开黑啦) est une plateforme de communication axée sur les jeux vidéo, similaire à Discord, proposant des canaux texte, des canaux vocaux et la messagerie directe.

Le mode bot offre un accès complet à l’API, y compris la prise en charge des pièces jointes.

  1. Rendez-vous sur https://developer.kookapp.cn et connectez-vous.
  2. Cliquez sur Créer une application et donnez-lui un nom (ex. : « Apprise »).
  3. Sous votre nouvelle application, cliquez sur Bot dans la barre latérale gauche.
  4. Cliquez sur Ajouter un bot puis copiez le Token affiché.
  5. Invitez le bot sur votre serveur via la page OAuth2 en lui accordant les permissions requises (au minimum : Envoyer des messages).
  6. Activez le mode développeur dans Kook : Paramètres > Autres > Mode développeur.
  7. Faites un clic droit sur un canal et sélectionnez Copier l’ID pour obtenir son identifiant numérique.

Le mode webhook est plus simple, mais ne prend pas en charge les pièces jointes.

  1. Dans Kook, ouvrez Paramètres du serveur > Intégrations > Webhooks.
  2. Cliquez sur Créer un webhook pour le canal souhaité.
  3. Copiez la clé webhook depuis l’URL générée (la partie après /incoming/).

Les syntaxes valides sont les suivantes :

  • kook://{token}/{channel_id}
  • kook://{token}/{channel_id1}/{channel_id2}/...
  • kook://{token}/@{user_id}
  • kook://{token}/{channel_id}/@{user_id}
  • kook://{webhook_key}?mode=webhook
Variable Requis Description
token *Oui Votre token de bot (mode bot) ou clé webhook (mode webhook).
channel_id Non Identifiant numérique du canal cible. Peut être répété pour plusieurs canaux.
user_id Non Identifiant numérique d’un utilisateur pour un message direct. Préfixez avec @.
mode Non Mode de fonctionnement : bot (par défaut) ou webhook.
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.

Envoyer une notification KMarkdown à un canal :

Fenêtre de terminal
apprise -vv -t "Titre" -b "Bonjour depuis **Apprise** !" \
kook://BOT_TOKEN/CHANNEL_ID

Envoyer à plusieurs canaux :

Fenêtre de terminal
apprise -vv -t "Alerte" -b "Corps du message" \
kook://BOT_TOKEN/CHANNEL_ID1/CHANNEL_ID2

Envoyer un message direct à un utilisateur :

Fenêtre de terminal
apprise -vv -t "MP" -b "Message privé" \
kook://BOT_TOKEN/@USER_ID

Envoyer via un webhook entrant :

Fenêtre de terminal
apprise -vv -b "Notification webhook" \
"kook://WEBHOOK_KEY?mode=webhook"

Forcer le format texte brut (paramètre standard Apprise ?format=) :

Fenêtre de terminal
apprise -vv -b "Message texte brut" \
"kook://BOT_TOKEN/CHANNEL_ID?format=text"
Questions ou commentaires ?

Documentation

Vous avez repéré une faute de frappe ou une erreur ?

Problèmes Techniques

Vous rencontrez un problème avec le code ? Ouvrez un ticket sur GitHub :

Conçu avec amour depuis le Canada