• Installs:
  • Today: 0
  • All Time: 0
Developer:userzakutynsky

Viber API Package

With Viber’s APIs, you can create unique experiences for users at scale.

List of Endpoints
This is the list of endpoints this API includes. To add any of the endpoints to your app, please click on “Connect to endpoint” text.
See All
List of Webhook Events
This is the list of webhook events this API provides. Webhooks allow you to register to certain events and receive real-time data over websockets.
See All
Discussions
See All
Readme

Viber

Viber Package

With Viber’s APIs, you can create unique experiences for users at scale. There are no registration fees and our team is here to support you through the development and integration process.

How to get credentials:

  1. The authentication token is generated upon account creation and can be viewed by the account’s admins in the “edit info” screen of their Public Account/ bot or on the Viber Admin Panel.

Viber.setWebhook

Webhook will be used for receiving callbacks and user messages from Viber.

FieldTypeDescription
tokenCredentialsYour viber token
urlStringAccount webhook URL to receive callbacks & messages from users. Webhook URL must use SSL.
eventTypesListIndicates the types of Viber events that the account owner would like to be notified about. Don’t include this parameter in your request to get all events

Viber.deleteAllWebhooks

Cancel webhooks event

FieldTypeDescription
tokenCredentialsYour viber token

Viber.sendTextMessage

Send text messages to Viber users who subscribe to the account.

FieldTypeDescription
tokenCredentialsYour viber token
receiverStringUnique Viber user id
textStringThe text of the message
senderNameStringThe sender’s name to display
senderAvatarStringThe sender’s avatar URL
trackingDataStringAllow the account to track messages and user’s replies. Sent tracking_data value will be passed back with user’s reply
minApiVersionStringMinimal API version required by clients for this message

Viber.sendPicture

Send picture messages to Viber users who subscribe to the account.

FieldTypeDescription
tokenCredentialsYour viber token
receiverStringUnique Viber user id
textStringDescription of the photo.
mediaStringURL of the image (JPEG). Max size 1 MB. Only JPEG format is supported. Other image formats as well as animated GIFs can be sent as URL messages or file messages
thumbnailStringURL of a reduced size image (JPEG). Max size 100 kb. Recommended: 400x400. Only JPEG format is supported
senderNameStringThe sender’s name to display
senderAvatarStringThe sender’s avatar URL
trackingDataStringAllow the account to track messages and user’s replies. Sent tracking_data value will be passed back with user’s reply
minApiVersionStringMinimal API version required by clients for this message

Viber.sendVideo

Send video messages to Viber users who subscribe to the account.

FieldTypeDescription
tokenCredentialsYour viber token
receiverStringUnique Viber user id
mediaStringURL of the video (MP4, H264). Max size 50 MB. Only MP4 and H264 are supported
sizeNumberSize of the video in bytes
durationNumberVideo duration in seconds; will be displayed to the receiver. Max 180 seconds
thumbnailStringURL of a reduced size image (JPEG). Max size 100 kb. Recommended: 400x400. Only JPEG format is supported
senderNameStringThe sender’s name to display
senderAvatarStringThe sender’s avatar URL
trackingDataStringAllow the account to track messages and user’s replies. Sent tracking_data value will be passed back with user’s reply
minApiVersionStringMinimal API version required by clients for this message

Viber.sendFile

Send file messages to Viber users who subscribe to the account.

FieldTypeDescription
tokenCredentialsYour viber token
receiverStringUnique Viber user id
mediaStringURL of the file. Max size 50 MB. See forbidden file formats for unsupported file types
sizeNumberSize of the file in bytes
fileNameStringName of the file. File name should include extension. Max 256 characters (including file extension). Sending a file without extension or with the wrong extension might cause the client to be unable to open the file
senderNameStringThe sender’s name to display
senderAvatarStringThe sender’s avatar URL
trackingDataStringAllow the account to track messages and user’s replies. Sent tracking_data value will be passed back with user’s reply
minApiVersionStringMinimal API version required by clients for this message

Viber.sendContact

Send contact messages to Viber users who subscribe to the account.

FieldTypeDescription
tokenCredentialsYour viber token
receiverStringUnique Viber user id
contactNameStringName of the contact
contactPhoneStringPhone number of the contact
senderNameStringThe sender’s name to display
senderAvatarStringThe sender’s avatar URL
trackingDataStringAllow the account to track messages and user’s replies. Sent tracking_data value will be passed back with user’s reply
minApiVersionStringMinimal API version required by clients for this message

Viber.sendLocation

Send location messages to Viber users who subscribe to the account.

FieldTypeDescription
tokenCredentialsYour viber token
receiverStringUnique Viber user id
coordinatesMapLocation coordinates
senderNameStringThe sender’s name to display
senderAvatarStringThe sender’s avatar URL
trackingDataStringAllow the account to track messages and user’s replies. Sent tracking_data value will be passed back with user’s reply
minApiVersionStringMinimal API version required by clients for this message

Viber.sendUrl

Send url messages to Viber users who subscribe to the account.

FieldTypeDescription
tokenCredentialsYour viber token
receiverStringUnique Viber user id
mediaStringURL
senderNameStringThe sender’s name to display
senderAvatarStringThe sender’s avatar URL
trackingDataStringAllow the account to track messages and user’s replies. Sent tracking_data value will be passed back with user’s reply
minApiVersionStringMinimal API version required by clients for this message

Viber.sendSticker

Send sticker messages to Viber users who subscribe to the account.

FieldTypeDescription
tokenCredentialsYour viber token
receiverStringUnique Viber user id
contactNameStringName of the contact
stickerIdStringUnique Viber sticker ID. For examples visit the https://developers.viber.com/docs/tools/sticker-ids page
senderNameStringThe sender’s name to display
senderAvatarStringThe sender’s avatar URL
trackingDataStringAllow the account to track messages and user’s replies. Sent tracking_data value will be passed back with user’s reply
minApiVersionStringMinimal API version required by clients for this message

Viber.sendCarouselContentMessage

The Carousel Content Message type allows a user to scroll through a list of items, each composed of an image, description and call to action button.

FieldTypeDescription
tokenCredentialsYour viber token
receiverStringUnique Viber user id
minApiVersionStringMinimal API version required by clients for this message
richMediaJSONCarousel object

Viber.sendBroadcastMessage

Send messages to multiple Viber users who subscribe to the account. Sending a message to a user will be possible only after the user has subscribed to the Public Account by pressing the subscribe button or by sending a message, or by sending a message to a bot. The ability to send broadcast messages is only opened on application and approval from Viber account managers.

FieldTypeDescription
tokenCredentialsYour viber token
senderNameStringThe sender’s name to display
senderAvatarStringThe sender’s avatar URL
minApiVersionStringMinimal API version required by clients for this message
broadcastListListRecipients for the message.
richMediaJSONCarousel object

Viber.getAccountInfo

Fetch the account’s details as registered in Viber. The account admin will be able to edit most of these details from his Viber client.

FieldTypeDescription
tokenCredentialsYour viber token

Viber.getUserDetails

Fetch the details of a specific Viber user based on his unique user ID. The user ID can be obtained from the callbacks sent to the account regarding user’s actions. This request can be sent twice during a 12 hours period for each user ID.

FieldTypeDescription
tokenCredentialsYour viber token
idStringUnique Viber user id

Viber.getOnlineStatus

Fetch the online status of a given subscribed account members. The API supports up to 100 user id per request and those users must be subscribed to the account.

FieldTypeDescription
tokenCredentialsYour viber token
idsListUnique Viber user ids
x
circle
Viber
$ / m
We will charge your card every month for the plan amount, as well as any overages incurred in the previous month.
?

Oops, we are missing some details

Looks like there are a few missing details that you haven't filled in yet.
These details are important and will help us protect you and let you know about anything new.

x

Why sign up to RapidAPI?

  • integrate
    Integrate APIs into your app
    Ruby, Java, Elixir, Node.js, Phyton, Objective C, Swift, PHP and MORE
  • keys
    Save all API keys in one place
  • notifications
    Get notifications about API changes
  • stats
    Get stats and monitor API connections
__SING_UP_WITH_GITHUB__
__SING_UP_WITH_FACEBOOK__
__SING_UP_WITH_GOOGLE__
  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view
    x

    Authentication

    Authenticate
    esccloses this view