Viber Business Message icon

Viber Business Message

Send messages through the Rakuten Viber Business Messages API

Actions8

Message → Send Carousel

AI-generated

Summary

Send a Viber carousel message to specified destinations

Inputs

  • dest (required) — Complete phone number, digits only — no spaces, "+" or special characters
  • label (required) — Declares the nature of the message for Viber internal purposes. Does not affect billing.
  • messageText (required) — Intro text shown above the cards (recommended ≤200 chars)
  • carouselCards (required) — 2–5 cards, each with an image and up to two buttons
  • simplify — Whether to return a simplified response (status, message token, session ID) instead of the full Viber payload
  • seq — Unique identifier linking this request to the response. Defaults to a timestamp when left at 0. Use an expression such as {{ $itemIndex }} for deterministic values.
  • tag — Free text for generating custom reports
  • ttl — Time to Live in seconds (30–1209600). Leave 0 for the default (14 days).
  • trackingData — String returned to your webhook when the user replies. Auto-filled for types that require it; set it here to override.

Output shape

An array of result objects, one per input item.

Each result contains either a simplified payload (status, messageToken, sessionId) when simplify is true, or the full Viber response; errors are handled by continueOnFail.

Examples

Example 1: Promotional carousel to customers

dest=9725551234, label=promotion, messageText="Special offers", carouselCards=[{imageUrl=https://example.com/img1.jpg,primaryLabel=Shop,primaryActionUrl=https://shop.com,secondaryLabel=View,secondaryActionUrl=https://shop.com}], simplify=true

Example 2: Transactional carousel for order updates

dest=9725559876, label=transaction, messageText="Your order is shipped", carouselCards=[{imageUrl=https://example.com/order.png,title=Order,primaryLabel=Track,primaryActionUrl=https://track.com,secondaryLabel=Details,secondaryActionUrl=https://track.com}], ttl=86400, tag="order123"

Links

Discussion