Help Center Counterbat API: Sesje rozliczeniowe Viber Bot

Counterbat API: Sesje rozliczeniowe Viber Bot

Możliwości licznika rozliczeń

Counterbat API umożliwia monitorowanie danych sesji w czasie rzeczywistym i wykorzystanie Cascade API do wysyłania dodatkowych wiadomości do sesji usługi lub już opłaconej sesji Viber Bot.

Jak podłączyć usługę licznika rozliczeń

  1. Podpisz umowę.
  2. Uzyskaj dostęp do funkcjonalności.
  3. Skonfiguruj webhooka.
  4. Wykorzystaj panel i możliwości Cascade API.

Viber REST API (wersja Counterbat)

Poniżej znajduje się pełna dokumentacja interfejsu API REST Viber. Należy pamiętać, że punkt końcowy „https://chatapi.viber.com” został zastąpiony przez „https://api.counterbat.com/” do użytku z funkcjonalnością Counterbat.

Zacznij

Do wdrożenia API potrzebne będą:

  1. Aktywne konto Viber na platformie obsługującej boty (iOS/Android).
  2. Aktywny bot.
  3. Token uwierzytelniający konto.
  4. Skonfiguruj webhook konta.

Token uwierzytelniający

Każde żądanie API musi zawierać nagłówek HTTP o nazwie X-Viber-Auth-Token zawierający token uwierzytelniający konta.

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

Haki internetowe

Konfigurowanie webhooka

Adres URL zasobu

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

Opublikuj dane

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

Usuwanie webhooka

Aby wyłączyć webhook, wyślij żądanie set_webhook z pustym ciągiem adresu URL.

{
   "url": ""
}

Wyślij wiadomość

API send_message umożliwia wysyłanie wiadomości do użytkowników Vibera, którzy subskrybują konto.

Adres URL zasobu

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

Przykład odpowiedzi

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

Klawiatury

API umożliwia wysyłanie niestandardowej klawiatury za pomocą API send_message w celu dostarczenia użytkownikowi zestawu predefiniowanych odpowiedzi lub akcji.

Adres URL zasobu

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

Wiadomość rozgłoszeniowa

Interfejs API „broadcast_message” umożliwia kontom wysyłanie wiadomości do wielu użytkowników Vibera, którzy subskrybują konto. Maksymalna długość listy to 300 odbiorców.

Adres URL zasobu

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

Uzyskaj informacje o koncie

Żądanie get_account_info spowoduje pobranie danych konta w postaci zarejestrowanej.

Adres URL zasobu

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

Uzyskaj dane użytkownika

Żądanie „get_user_details” pobierze szczegółowe informacje o konkretnym użytkowniku Vibera na podstawie jego unikalnego identyfikatora użytkownika.

Adres URL zasobu

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

Połącz się z internetem

Żądanie get_online pobierze status online danego subskrybowanego konta (do 100 identyfikatorów użytkowników na żądanie).

Adres URL zasobu

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

Oddzwonienia

Viber oferuje wywołania zwrotne dla zdarzeń takich jak „subskrybowano”, „unsubskrybowano”, „rozpoczęto konwersację”, „dostarczono”, „widziano”, „nie udało się” i „wiadomość”. Wywołanie zwrotne zostanie wysłane na adres URL podany podczas wywołania set_webhook.