Viber Business Message icon

Viber Business Message

Send messages through the Rakuten Viber Business Messages API

Actions8

Message → Send Text

AI-generated

Summary

Send a plain text message via Viber Business Messages to a specified phone number with optional categorization and message delivery type.

Inputs

  • Destination (required) — Complete phone number in digits only, without spaces, '+' or special characters. Example format: 972500000000.
  • Label (required) — Indicates the message nature as either 'Transaction' or 'Promotion' for Viber internal use; this does not influence billing.
  • Delivery (required) — Classifies and bills the text message as 'Transactional (Legacy)', 'Promotional', or 'Session'.
  • Message Text (required) — The text content of the message, supporting Viber markdown and newlines ('\n'), limited to 1000 UTF-8 characters.
  • Simplify — Optional boolean to receive a simplified response containing status, message token, and session ID instead of the full Viber API payload.
  • Additional Fields — Optional parameters including Sequence (unique message identifier), Tag (custom text for reporting), TTL (message time to live in seconds, default 14 days), and Tracking Data (string returned on user reply, auto-filled unless overridden).

Output shape

a list of result records, one per input item, each containing either a simplified response object with status, seq, message token, and optionally session ID, or the full Viber response payload with the request body included.

If Simplify is enabled, only key response properties are returned. When Additional Fields specify Sequence as 0, it defaults to the current timestamp. TTL must be between 30 and 1,209,600 seconds if set; an error is thrown otherwise. Tracking Data is applied if required by message type. Errors produce API rejection exceptions unless workflow is set to continue on fail.

Examples

Example 1: Send a transactional text message

Set Destination to the recipient's phone number in digits only; set Label to 'Transaction'; set Delivery to 'Transactional (Legacy)'; enter the Message Text; optionally configure Additional Fields like TTL; and choose whether to simplify the output.

Links

Discussion