Aller au contenu

API Counterbat : sessions de facturation Viber Bot

Capacités du compteur de facturation

L'API Counterbat vous permet de surveiller les données de session en temps réel et d'exploiter l'API Cascade pour envoyer des messages supplémentaires dans une session de service ou une session Viber Bot déjà payante.

Comment connecter le service de compteur de facturation

  1. Signez un contrat.
  2. Accédez à la fonctionnalité.
  3. Configurez un webhook.
  4. Utilisez le panneau et les capacités de l'API Cascade.

API REST Viber (édition Counterbat)

Ce qui suit est une référence complète de l'API Viber REST. Notez que le point de terminaison « https://chatapi.viber.com » est remplacé par « https://api.counterbat.com/ » pour être utilisé avec la fonctionnalité Counterbat.

Commencer

Pour implémenter l'API, vous aurez besoin de : 1. Un compte Active Viber sur une plateforme prenant en charge les robots (iOS/Android). 2. Bot actif. 3. Jeton d'authentification du compte. 4. Configurez le webhook du compte.

Jeton d'authentification

Chaque requête API doit inclure un en-tête HTTP appelé « X-Viber-Auth-Token » contenant le jeton d'authentification du compte.

X-Viber-Auth-Token: 445da6az1s345z78-dazcczb2542zv51a-e0vc5fva17480im9

Webhooks

Définir un webhook

URL de la ressource

https://api.counterbat.com/pa/set_webhook

Publier des données

{
   "url": "https://my.host.com",
   "event_types": [
      "delivered",
      "seen",
      "failed",
      "subscribed",
      "unsubscribed",
      "conversation_started"
   ],
   "send_name": true,
   "send_photo": true
}

Supprimer votre webhook

Pour désactiver le webhook, publiez une requête set_webhook avec une chaîne d'URL vide.

{
   "url": ""
}

Envoyer un message

L'API send_message permet aux comptes d'envoyer des messages aux utilisateurs Viber qui s'abonnent au compte.

URL de la ressource

https://api.counterbat.com/pa/send_message

Exemple de réponse

{
   "status": 0,
   "status_message": "ok",
   "message_token": 5741311803571721087,
   "chat_hostname": "SN-CHAT-05_",
   "billing_status": 1
}

Claviers

L'API permet d'envoyer un clavier personnalisé à l'aide de l'API send_message pour fournir à l'utilisateur un ensemble de réponses ou d'actions prédéfinies.

URL de la ressource

https://api.counterbat.com/pa/send_message

Message de diffusion

L'API broadcast_message permet aux comptes d'envoyer des messages à plusieurs utilisateurs Viber qui s'abonnent au compte. La longueur maximale de la liste est de 300 destinataires.

URL de la ressource

https://api.counterbat.com/pa/broadcast_message

Obtenir des informations sur le compte

La requête get_account_info récupérera les détails du compte tels qu'ils ont été enregistrés.

URL de la ressource

https://api.counterbat.com/pa/get_account_info

Obtenir les détails de l'utilisateur

La requête get_user_details récupérera les détails d'un utilisateur Viber spécifique en fonction de son identifiant utilisateur unique.

URL de la ressource

https://api.counterbat.com/pa/get_user_details

Se connecter

La requête get_online récupérera le statut en ligne des membres d'un compte abonné donné (jusqu'à 100 identifiants utilisateur par requête).

URL de la ressource

https://api.counterbat.com/pa/get_online

Rappels

Viber propose des rappels pour des événements tels que « abonné », « désabonné », « conversation_started », « livré », « vu », « échec » et « message ». Le rappel sera publié sur l'URL fournie lors de l'appel set_webhook.