Viber API Documentation7.1.0

Docs / General / API Access White Paper

Viber API Access - White Paper

Viber 6.5 introduced a new Viber API, which third parties can use to send and receive messages between a Public Account (run by a big brand or company)or bot account (collectively known as “account”) and a Viber user.

Table of Contents

Using the Viber API

Viber Public Accounts and bots contain two communications channels:

  1. Public Chats – Public Account only. Public communication channel from the Public Account visible to all of the Public Account’s followers. All information shared through this communications channel is publicly accessible by all the Public Account’s followers and open to free access via external API’s.
  2. Viber API – Suitable for both Public Accounts and bots. Private encrypted communications channel between an account and a subscribed Viber user. All information communicated over this channel can only be seen by the subscribed Viber user and the account’s administrators. It cannot be accessed by any 3rd party API.

When creating a new account you will receive a token which is used for all communication with the Viber Back End. In order to enable communication between the Viber Back End and the account, the account must call the set web hook request with the token providing the account’s URL for receiving the web hook. There is also an optional parameter (v6.5.1 and up) to define which events it will receive (such as delivered and seen notifications when clients receive and read messages). Once the set web hook request is received by the Viber Back End, it will validate the URL and send a response.

Communication between Public Accounts/ bots and Viber users

All communication between accounts and Viber users can only be initialized by the Viber user starting a new conversation to the account (opt–in) (in both cases the user will be subscribed to the account). When a Viber user subscribes to the Public Account/ bot, the account will receive the following information about the user:

Once a Viber user subscribes to a Public Account (and not a bot account), the Public Account can send messages to the Viber user freely (not only in response to a message from the user). Viber users can unsubscribe at any time from the Public Account, which will immediately block any further communication from the Public Account to the user. All messages will include a unique message token and timestamp created by the Viber Back End and will be synchronized between all users’ devices. Messages sent to the Public Account/ bot will also include the user’s Viber name and avatar.

Security

Privacy

Successful delivery definition