Retrieve Viber Trackings by Campaign

Retrieve tracking information for viber messages included in a campaign.

RESPONSE PARAMETERS

KEY

DESCRIPTION

content.trackingId

The tracking id of the viber message.

content.to

The recipient number.

content.from

The name of the sender id.

content.groups

The groups that the recipient belongs to.

content.country

The country of the recipient.

content.status

Information about the status of the viber message.

content.status.status

The current status of the viber message.
Check here for possible values.

content.status.date

The updated date of the status.

content.status.reason

The reason of the status.

content.status.reason.detailedStatus

The current detailed status.
Check here for details.

content.status.reason.description

The description of the detailed status.

content.campaign

The name of the campaign that this message was send from.

content.campaignTrackingId

The id of the campaign that this message was send from.

content.applicationName

The name of the application that was used to send this message.

content.originatingService

The service that sent this message.

content.direction

The direction of this message.

content.ttl

Time range until message expires.

content.message

The text of the viber message.

content.viberAction

Represents the action (button) of the viber message.

content.viberAction.caption

The displayed text on the button.

content.viberAction.targetUrl

The action which should be executed, when the recipient clicks on the button.

content.imageUrl

The url of image.

content.viberFile.fileId

The Id of the file.

content.viberFile.fileName

The name of the file.

content.viberFile.fileType

The type of the file.

content.viberFile.fileUrl

The url of the file.

content.viberVideo.videoUrl

The URL where the video is hosted.

content.viberVideo.videoThumbnail

The URL of a thumbnail for the Video.

content.viberVideo.fileSize

The file size in MB.

content.viberVideo.duration

The video’s duration in seconds.

content.price

The cost of this message.

content.sessionMessage

Indicates a Viber Campaign is a Viber Session if the value is true. Learn more about session messaging at our documentation.

last

Whether the current page is the last one.

totalPages

The number of total pages.

totalElements

The total amount of elements for the current search.

numberOfElements

The number of elements currently on this page.

first

Whether the current page is the first one.

size

The requested page size.

number

The requested page number.

sessionId

The sessionId of a Viber Session

ERROR CODES

STATUS

CODE

DESCRIPTION

404

404009001

Campaign not found.

Language