ESesputnik
Messages

Search for Viber messages

Changed on

The method is used to search for Viber messages using a part of name or a tag. By default, a rate limit of 500 requests per hour applies. <br/>The method returns a maximum of 500 messages per request.<br/>The <b>TotalCount</b> header contains the number of messages returned by the query

get/api/v1/messages/viber

Request

Query parameters

searchstring

Search condition (part of the message name or a tag)

startindexinteger

Index of the first returned message from the search results. Numbering starts at 1

maxrowsinteger

Maximum number of messages to return (not more than 500)

Response

idinteger

Message ID.

namestring required

Message name.

languageCodestring

Language code.

tagsstring[]

List of tags.

subscriptionsKeysstring[]

Subscription categories keys, assigned to a message.

languagesstring[]

An array with the language codes for multilingual messages. Available for the GET method only.

fromstring required

Sender name. Must exist in your account.

transactionalboolean

Transactional messages have lower cost, but can contain only text. Content must be agreed with provider for successful sending. Default - false.

templateIdstring

Provider template ID for a transactional Viber message.

textstring required

Message text.

imgstring

Image URL for message. If set, caption and action must be set too.

captionstring

Button text. If set, img and action must be set too.

actionstring

Link assigned to button. If set, img and caption must be set too.

ttlSecinteger

Time to live for message in seconds. Default - 86400 (1 day).

smsFallbackboolean

Enables smsFallback feature: send SMS message instead of Viber, if contact does not have Viber app installed. Default - false.

smsSenderstring

SMS sender name for smsFallback feature.

smsContentstring

SMS text for smsFallback feature.

Changes

  • e75431e60ca1Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property /// to the response with the status