Notifications Nextcloud Talk

Aperçu

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

Configuration du Compte

Apprise peut publier dans Nextcloud Talk en tant qu’utilisateur ordinaire ou en tant que bot.

Compte utilisateur

L’application officielle Nextcloud Talk doit être installée. Un ‘mot de passe d’application’ (également appelé mot de passe/jeton ‘spécifique à l’appareil’) d’un membre du salon de discussion doit être créé ; consultez la documentation pour plus d’informations. N’oubliez pas de désactiver l’accès au système de fichiers pour ce mot de passe.

Bot

Les bots nécessitent Nextcloud Talk 17.1 (Nextcloud 27.1) ou une version plus récente. Les messages sont publiés sous le nom du bot plutôt que sous celui d’un utilisateur.

1. Un administrateur du serveur installe le bot avec un secret partagé de 40 à 128 caractères. Le bot a besoin de la fonctionnalité response pour pouvoir publier des messages. L’argument URL est exigé par la commande, mais Apprise ne l’utilise pas :

   occ talk:bot:install --feature response \
       "Apprise" "{secret}" "https://localhost"

2. Activez le bot dans chaque conversation où il doit publier. Un modérateur peut le faire depuis les paramètres Bots de la conversation, ou un administrateur peut exécuter occ talk:bot:setup {bot_id} {room_id}.

3. Utilisez le jeton de la conversation (la dernière partie du lien de la conversation) comme {room_id} dans votre URL Apprise.

Syntaxe

Les connexions sécurisées (via https) doivent utiliser nctalks:// tandis que les connexions non sécurisées (via http) doivent utiliser nctalk://.

La syntaxe valide est la suivante :

• nctalk://{user}:{password}@{hostname}/{room_id}
• nctalk://{user}:{password}@{hostname}:{port}/{room_id}
• nctalks://{user}:{password}@{hostname}/{room_id}
• nctalks://{user}:{password}@{hostname}:{port}/{room_id}

Vous pouvez publier dans plusieurs salons en les enchaînant simplement à la fin de l’URL.

• nctalk://{user}:{password}@{hostname}:{port}/{room_id1}/{room_id2}/{room_id3}
• nctalks://{user}:{password}@{hostname}:{port}/{room_id1}/{room_id2}/{room_id3}

Pour publier en tant que bot, retirez l’utilisateur et le mot de passe et ajoutez le secret du bot :

• nctalk://{hostname}/{room_id}?secret={secret}
• nctalks://{hostname}/{room_id}?secret={secret}
• nctalks://{hostname}:{port}/{room_id1}/{room_id2}?secret={secret}

Détail des Paramètres

Variable	Requis	Description
hostname	Oui	Le nom d’hôte du serveur hébergeant votre service Nextcloud.
user	*Oui	L’utilisateur du service Nextcloud que vous avez configuré.
password	*Oui	Le mot de passe associé à l’utilisateur de votre compte Nextcloud.
secret	*Oui	Le secret partagé d’un bot installé. À utiliser à la place d’un utilisateur et d’un mot de passe.
room_id	Oui	L’identifiant de salon Nextcloud Talk.
silent	Non	Mettez yes pour publier sans déclencher de notifications de discussion. Par défaut, cette option vaut no.

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 un message Nextcloud Talk sécurisé vers le salon 93nfkdn3 :

# Assuming our {host} is localhost
# Assuming our {user} is user1
# Assuming our (user1) {password} is 12345-67890-12345-67890-12345:
apprise nctalks://user1:12345-67890-12345-67890-12345@localhost/93nfkdn3

Envoyer le même message en tant que bot :

# Assuming our {host} is localhost
# Assuming our bot {secret} is abcdefghijklmnopqrstuvwxyz0123456789ABCD
apprise -vv -t "Sauvegarde terminée" -b "La sauvegarde nocturne est prête." \
   'nctalks://localhost/93nfkdn3?secret=abcdefghijklmnopqrstuvwxyz0123456789ABCD'

Astuce

Si votre secret contient des caractères spéciaux comme &, +, / ou %, encodez-les pour l’URL (par exemple & devient %26).

Manipulation des En-têtes

Certains utilisateurs peuvent avoir besoin d’en-têtes HTTP spéciaux lors de l’envoi de données vers leur serveur. Pour cela, il suffit d’ajouter un symbole plus (+) devant n’importe quel paramètre précisé dans votre URL.

# Below would set the header:
#    X-Token: abcdefg
#
# Assuming our {hostname} is localhost
# Assuming our {user} is user1
# Assuming our (user1) {password} is 12345-67890-12345-67890-12345
# We want to notify Room 93nfkdn3
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "nctalks://user1:12345-67890-12345-67890-12345@localhost/93nfkdn3?+X-Token=abcdefg"

# Multiple headers just require more entries defined:
# Below would set the headers:
#    X-Token: abcdefg
#    X-Apprise: is great
#
# Assuming our {hostname} is localhost
# Assuming our {user} is user1
# Assuming our (user1) {password} is 12345-67890-12345-67890-12345
# We want to notify Room 93nfkdn3
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "nctalks://user1:12345-67890-12345-67890-12345@localhost/93nfkdn3?+X-Token=abcdefg&+X-Apprise=is%20great"