Send a Viber transactional template message

Send an approved BM transactional template (transactional or OTP category).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Send any approved BM transactional template. OTP-category templates require pin in templateParams.

There is no greenfield POST /viber/transactional/otp. Legacy POST /viber/otp remains for older integrations.

HTTP 200 means the message was accepted for processing, not delivered to the handset.

Request notes

TopicGuidance
templateParamsTEXT values, max 25 chars each, no URLs, no file-extension-like values (e.g. test.pdf). Omit or {} only when the template has no variables.
deliveryScopePRIMARY_DEVICE (default) or ALL_DEVICES
seqOptional partner correlation id; Routee assigns one if omitted (returned in response and echoed on tracking)
callbackUrlOptional HTTPS URL for delivery status callbacks for this message

Send-time validation (HTTP 400)

Invalid templateLang or templateParams fail before queue with code 400019029 and validationIssues:

CodeMeaning
TEMPLATE_LANG_REQUIREDtemplateLang missing
TEMPLATE_LANG_MISMATCHLanguage does not match template locale
MISSING_PARAMRequired placeholder missing or blank
UNKNOWN_PARAMExtra key not on template
PARAM_VALUE_TOO_LONGValue longer than 25 characters
PARAM_CONTAINS_URLURL-like content in a parameter
PARAM_CONTAINS_FILE_EXTENSIONFile-extension-like fragment
OTP_PIN_REQUIREDOTP-category template without pin

Response fields

KEYDESCRIPTION
trackingIdUse with Retrieve Viber Single Message by Tracking Id
deliveryScopePRIMARY_DEVICE or ALL_DEVICES as applied
seqCorrelation id (yours or Routee-assigned)
to, fromRecipient and sender as resolved by Routee
statusInitial status object
priceCharged amount where applicable

Tracking GET and delivery callbacks include messageKind: transactional_template and a transactionalTemplate block. See Viber transactional tracking and callbacks.

Body Params
string
required
string
required

E.164 MSISDN with leading +.

string
required
string
required
templateParams
object

Placeholder map. OTP-category templates must include pin.

string
enum
Defaults to PRIMARY_DEVICE
Allowed:
int64
integer
uri
uri
string
string
boolean
Responses

403

Missing or invalid OAuth token, or insufficient Viber permission

404

Account or resource not found

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json