Kirago icon

Kirago

Interact with the Kirago API

Actions10

Message → Send Carousel

AI-generated

Summary

Send a carousel message to a specified user or group via Kirago, supporting either a global single button for all cards or individual buttons per card.

Inputs

  • Phone (required) — User or group JID (e.g., 5511999999999 or 555...@g.us) to receive the carousel message.
  • Carousel Type (required) — Choose between 'Global Buttons (CardButtons)' for one button applied globally or 'Per-Card Buttons (Cards[].Buttons)' for buttons on each individual card.
  • Global Button Type — When using a global button, select the button type: Call-to-Action URL or Quick Reply.
  • Global Button Display Text — Text displayed on the global button; if empty, no global button is sent.
  • Global Button ID — ID for the global Quick Reply button, returned when the user clicks it (required if button type is Quick Reply).
  • Global Button URL — URL for the global CTA URL button (required if button type is CTA URL).
  • Global Button Merchant URL — Optional merchant URL for the global CTA URL button; defaults to Global Button URL if empty.
  • Text — Text shown above the carousel.
  • Footer — Text shown in the footer below the carousel.
  • View Once (required) — Boolean indicating whether the carousel should be sent as a view-once message.
  • Cards (Global Buttons) (required) — List of cards in the carousel when using global buttons. Each card requires an image and can include optional title, caption, and image footer text.
  • Cards (Per-Card Buttons) (required) — List of cards in the carousel when using per-card buttons. Each card requires an image and can include title, caption, footer text, and multiple buttons (Quick Replies or CTA URLs) specific to that card.

Output shape

a JSON response object from the Kirago API representing the sent carousel message status or details

Returns a single JSON response per input item indicating the result of the carousel message sent. Errors in required fields or unsupported configurations throw workflow errors before sending.

Examples

Example 1: Send a carousel with global Quick Reply button

Phone: 5511999999999, Carousel Type: global, Global Button Type: quick_reply, Global Button Display Text: 'More Info', Global Button ID: 'info_1', Cards: Array of cards with images and optional titles and captions.

Example 2: Send a carousel with per-card CTA URL buttons

Phone: group JID '5551234567890@g.us', Carousel Type: per_card, Cards: Array of cards each with an image, title, caption, and one or more buttons specifying display text and URLs.

Links

Discussion