Add base Viber message

post

https://yespo.io/api/v1/messages/viber

The method is used for creating base Viber message.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

int32

Message ID.

name

string

required

Message name.

languageCode

string

Language code.

tags

subscriptionsKeys

array of strings

Subscription categories keys, assigned to a message.

subscriptionsKeys

languages

array of strings

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

languages

from

string

required

Sender name. Must exist in your account.

transactional

boolean

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

text

string

required

Message text.

img

string

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

caption

string

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

action

string

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

ttlSec

int32

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

smsFallback

boolean

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

smsSender

string

SMS sender name for smsFallback feature.

smsContent

string

SMS text for smsFallback feature.

carouselItems

array of objects

Carousel items (2-5 items). When provided, img/action/caption are ignored.

carouselItems

translations

array of objects

An array with translations to other languages. Available for the GET method only.

translations

Responses

400

Bad request:

Request body is empty.

Required field is absent: name, from, text.

Non-existing sender name used in message.

Used sender does not support specified transactional mode.

Not applicable field in transactional message: img, caption or action.

One or two of fields specified: img, caption or action; but not all three.

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json; charset=UTF-8

200