Saltar a contenido

API de Counterbat: Sesiones de facturación de Viber Bot

Capacidades del contador de facturación

La API de Counterbat le permite monitorear los datos de la sesión en tiempo real y aprovechar la API de Cascade para enviar mensajes adicionales a una sesión de servicio o a una sesión de Viber Bot ya pagada.

Cómo conectar el servicio de mostrador de facturación

  1. Firma un contrato.
  2. Obtenga acceso a la funcionalidad.
  3. Configurar un webhook.
  4. Utilice el panel y las capacidades de Cascade API.

API REST de Viber (edición Counterbat)

La siguiente es una referencia completa de la API REST de Viber. Tenga en cuenta que el punto final https://chatapi.viber.com se reemplaza por https://api.counterbat.com/ para usar con la funcionalidad Counterbat.

Empezar

Para implementar la API, necesitará: 1. Una cuenta Active Viber en una plataforma que admita bots (iOS/Android). 2. Bot activo. 3. Token de autenticación de cuenta. 4. Configurar el webhook de la cuenta.

Token de autenticación

Cada solicitud de API debe incluir un encabezado HTTP llamado "X-Viber-Auth-Token" que contiene el token de autenticación de la cuenta.

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

Webhooks

Configurar un webhook

URL del recurso

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

Publicar datos

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

Eliminando tu webhook

Para deshabilitar el webhook, publique una solicitud set_webhook con una cadena URL vacía.

{
   "url": ""
}

Enviar mensaje

La API send_message permite que las cuentas envíen mensajes a los usuarios de Viber que se suscriben a la cuenta.

URL del recurso

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

Ejemplo de respuesta

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

Teclados

La API permite enviar un teclado personalizado utilizando la API send_message para proporcionar al usuario un conjunto de respuestas o acciones predefinidas.

URL del recurso

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

Mensaje de difusión

La API broadcast_message permite que las cuentas envíen mensajes a múltiples usuarios de Viber que se suscriban a la cuenta. La longitud máxima de la lista es de 300 receptores.

URL del recurso

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

Obtener información de la cuenta

La solicitud get_account_info recuperará los detalles de la cuenta tal como están registradas.

URL del recurso

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

Obtener detalles del usuario

La solicitud get_user_details obtendrá los detalles de un usuario de Viber específico en función de su ID de usuario único.

URL del recurso

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

Conéctate

La solicitud get_online obtendrá el estado en línea de los miembros de una cuenta suscrita determinada (hasta 100 ID de usuario por solicitud).

URL del recurso

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

Devoluciones de llamada

Viber ofrece devoluciones de llamada para eventos como "suscrito", "cancelado la suscripción", "conversación_iniciada", "entregado", "visto", "fallido" y "mensaje". La devolución de llamada se publicará en la URL proporcionada durante la llamada set_webhook.