Aller au contenu

Notifications Viber

Aperçu

Les notifications Viber sont transmises via l’API REST Viber Bot (compte public).
L’authentification est geree a l’aide d’un unique jeton d’authentification de robot.

Important : les robots Viber ne peuvent envoyer des messages qu’aux utilisateurs abonnes au robot. Vous ne pouvez pas contacter des utilisateurs arbitraires ni des numeros de telephone quelconques.

Pour commencer :

  1. creez un robot Viber via le portail developpeur Viber ;
  2. recuperez votre jeton d’authentification du robot, parfois appele cle applicative ;
  3. relevez un ou plusieurs identifiants de destinataire depuis les evenements de rappel du robot, comme subscribed ou message ;
  4. utilisez ensuite le jeton et les identifiants de reception avec l’URL Apprise viber://.

La syntaxe valide est la suivante :

  • viber://{token}/{receiver}
  • viber://{token}/{receiver1}/{receiver2}/{receiverN}

Les valeurs {receiver} correspondent aux identifiants Viber des utilisateurs abonnes a votre robot.

VariableObligatoireDescription
tokenOuiJeton d’authentification du robot Viber, envoye comme X-Viber-Auth-Token.
receiverOuiUn ou plusieurs identifiants de reception Viber, c’est-a-dire des abonnes au robot.
fromNonNom d’expediteur affiche dans Viber. Par defaut, le nom de l’application Apprise est utilise et tronque a 28 caracteres si besoin.
avatarNonURL d’une image d’avatar pour l’expediteur.
toNonAlias pour les identifiants receiver. Accepte une liste separee par des virgules pour plus de praticite.
VariableDescription
overflowCe 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.
formatCe 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é.
verifyLes 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.
redirectPar 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.
ctoSignifie 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.
rtoSignifie 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.
emojisActive 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.
tzIdentifie 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.
retryNombre 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.
waitNombre 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.
optionalLorsqu’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.

Envoyer un message a un destinataire unique :

Fenêtre de terminal
apprise -vv -b "Bonjour d'Apprise" \
"viber://MYTOKEN/RECEIVER_ID"

Envoyer un message a plusieurs destinataires :

Fenêtre de terminal
apprise -vv -b "Deployment completed successfully" \
"viber://MYTOKEN/ID1/ID2/ID3"

Envoyer un message en utilisant l’alias to= et des details expediteur personnalises :

Fenêtre de terminal
apprise -vv -b "System Alert" \
"viber://MYTOKEN/?to=ID1,ID2&from=Apprise&avatar=https://example.com/avatar.png"
Questions ou commentaires ?

Documentation

Vous avez repéré une faute de frappe ou une erreur ? Signalez-la ou proposez une correction .

Problèmes Techniques

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

Conçu avec amour depuis le Canada