Counterbat API: Брояч на билинг сесии на Viber Bot

Възможност на брояча

Виждане в реално време на данни от сесията и използване на Cascade API за изпращане на допълнителни съобщения в сервизна или вече платена сесия на Viber Bot.

Как да свържете услугата за отчитане на билинг

1. Подпишете договор.
2. Получете достъп до функционалността.
3. Настройте (пропишете) webhook.
4. Използвайте панела и възможностите на Cascade API.

---

Viber REST API (Counterbat Edition)

Следното е пълно описание на Viber REST API. Обърнете внимание, че крайната точка https://chatapi.viber.com е заменена с https://api.counterbat.com/ за използване с функционалността на Counterbat.

Начало (Get Started)

За да имплементирате API, ще ви трябва следното:

1. Активен Viber акаунт на платформа, поддържаща ботове (iOS/Android).
2. Активен бот.
3. Токен за удостоверяване на акаунта (authentication token).
4. Настроен webhook на акаунта.

Токен за удостоверяване (Authentication token)

Всеки API aзапитване трябва да включва HTTP Header, наречен X-Viber-Auth-Token, съдържащ токена за удостоверяване на акаунта.

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

Webhooks (Уебкуки)

Задаване на Webhook

Resource URL

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

Post data (Данни на заявката)

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

Премахване на вашия webhook

За да деактивирате webhook, изпратете set_webhook заявка с празен URL низ.

{
   "url": ""
}

Изпращане на съобщение (Send Message)

API-то send_message позволява на акаунти да изпращат съобщения на Viber потребители, абонирали се за бота.

Resource URL

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

Пример за отговор (Response example)

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

Клавиатури (Keyboards)

API позволява изпращане на персонализирана клавиатура чрез send_message API, за да се предостави на потребителя набор от предварително зададени отговори или действия.

Resource URL

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

Групово изпращане на съобщения (Broadcast Message)

API-то broadcast_message позволява изпращане на съобщения до няколко Viber потребители, абонирали се за акаунта. Максималната дължина на списъка е 300 получатели.

Resource URL

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

Получаване на информация за акаунта (Get Account Info)

Заявката get_account_info ще извлече данните на акаунта, както са регистрирани.

Resource URL

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

Получаване на данни за потребителя (Get User Details)

Заявката get_user_details ще извлече подробности за конкретен потребител на Viber въз основа на неговия уникален идентификатор.

Resource URL

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

Онлайн статус (Get Online)

Заявката get_online ще извлече онлайн статуса на дадени абонирани членове на акаунта (до 100 user ids на заявка).

Resource URL

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

Обратни извиквания (Callbacks)

Viber предлага обратни извиквания за събития като subscribed, unsubscribed, conversation_started, delivered, seen, failed, и message. Те ще бъдат изпратени към URL адреса, предоставен по време на set_webhook.