Help Center Counterbat API: Viber Bot-factureringssessies

Counterbat API: Viber Bot-factureringssessies

Mogelijkheden voor factureringstellers

Met de Counterbat API kunt u sessiegegevens in realtime volgen en de Cascade API gebruiken om extra berichten naar een servicesessie of een reeds betaalde Viber Bot-sessie te sturen.

Hoe u de factureringstellerservice kunt verbinden

  1. Onderteken een contract.
  2. Krijg toegang tot de functionaliteit.
  3. Stel een webhook in.
  4. Gebruik het paneel en de mogelijkheden van de Cascade API.

Viber REST API (Counterbat-editie)

Het volgende is een volledige Viber REST API-referentie. Houd er rekening mee dat het eindpunt https://chatapi.viber.com is vervangen door https://api.counterbat.com/ voor gebruik met de Counterbat-functionaliteit.

Aan de slag

Om de API te implementeren, hebt u het volgende nodig:

  1. Een Actief Viber-account op een platform dat bots ondersteunt (iOS/Android).
  2. Actieve bot.
  3. Token voor accountverificatie.
  4. Accountwebhook instellen.

Authenticatietoken

Elk API-verzoek moet een HTTP-header bevatten met de naam ‘X-Viber-Auth-Token’, die het authenticatietoken van het account bevat.

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

Webhooks

Een webhook instellen

Bron-URL

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

Postgegevens

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

Uw webhook verwijderen

Om de webhook uit te schakelen, plaatst u een set_webhook-verzoek met een lege URL-tekenreeks.

{
   "url": ""
}

Bericht verzenden

Met de send_message API kunnen accounts berichten sturen naar Viber-gebruikers die zich op het account abonneren.

Bron-URL

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

Reactievoorbeeld

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

Toetsenborden

De API maakt het mogelijk een aangepast toetsenbord te verzenden met behulp van de send_message API om de gebruiker te voorzien van een reeks vooraf gedefinieerde antwoorden of acties.

Bron-URL

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

Uitgezonden bericht

Met de broadcast_message API kunnen accounts berichten sturen naar meerdere Viber-gebruikers die zich op het account abonneren. De maximale lijstlengte is 300 ontvangers.

Bron-URL

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

Ontvang accountinformatie

Het get_account_info verzoek haalt de accountgegevens op zoals geregistreerd.

Bron-URL

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

Gebruikersgegevens ophalen

Het get_user_details-verzoek haalt de details van een specifieke Viber-gebruiker op op basis van zijn unieke gebruikers-ID.

Bron-URL

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

Ga online

Het get_online verzoek haalt de online status op van een bepaald geabonneerd accountlid (tot 100 gebruikers-ID’s per verzoek).

Bron-URL

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

Terugbelgesprekken

Viber biedt callbacks voor gebeurtenissen zoals ‘geabonneerd’, ‘uitgeschreven’, ‘conversation_started’, ‘afgeleverd’, ‘gezien’, ‘mislukt’ en ‘bericht’. De callback wordt gepost op de URL die is opgegeven tijdens de set_webhook-aanroep.