Skip to main content
POST
viber.message.send

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
to
string
required

Recipient phone number in international format; they must have opted in.

Pattern: ^\+[1-9]\d{1,14}$
text
string
required

Text to send exactly as written, up to 1,000 characters.

Required string length: 1 - 1000
senderRef
string

Optional owned sender handle. Sources decline if they cannot resolve it.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
category
enum<string>
default:transactional

Message purpose. Promotional sending is an explicit choice.

Available options:
transactional,
promotional

Response

The result

status
enum<string>
required

Whether the message was accepted or sent.

Available options:
queued,
sent
ref
string

Reference to what this call created. Pass it as ref to message delivery follow-ups.