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. Токен автентифікації акаунту.
4. Налаштований webhook для акаунту.

Токен автентифікації

Кожен API запит повинен включати HTTP-заголовок X-Viber-Auth-Token, який містить токен автентифікації акаунту.

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

Webhooks

Встановлення Webhook

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, які підписані на бот.

URL ресурсу

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

Приклад відповіді

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

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

API дозволяє надсилати спеціальну клавіатуру за допомогою send_message API, щоб надати користувачеві набір попередньо визначених відповідей або дій.

URL ресурсу

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

Масове надсилання повідомлень (Broadcast Message)

API broadcast_message дозволяє надсилати повідомлення кільком користувачам Viber, які підписані на акаунт. Максимальна довжина списку – 300 отримувачів.

URL ресурсу

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

Отримати інформацію про акаунт (Get Account Info)

Запит get_account_info дозволяє отримати деталі акаунту, як вони зареєстровані.

URL ресурсу

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

Отримати дані користувача (Get User Details)

Запит get_user_details отримає деталі конкретного користувача Viber на основі його унікального ідентифікатора (user ID).

URL ресурсу

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

Статус онлайн (Get Online)

Запит get_online отримує онлайн статус підписаних учасників акаунту (до 100 user ids за один запит).

URL ресурсу

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

Зворотні виклики (Callbacks)

Viber підтримує зворотні виклики для подій: subscribed, unsubscribed, conversation_started, delivered, seen, failed, message. Вони будуть надсилатися на URL, вказаний під час виклику set_webhook.