Kirago icon

Kirago

Interact with the Kirago API

Message → Send Buttons

AI-generated

Summary

Send a WhatsApp message with interactive buttons to a specified phone number via the Kirago API.

Inputs

  • phone (required) — The recipient's WhatsApp number in international format, e.g., 5511999999999.
  • title — Optional title displayed above the message body.
  • body (required) — Main text displayed above the buttons.
  • footer — Footer text shown below the buttons.
  • headerType — Type of header to display before the text; options are none, image, or video.
  • headerMediaUrl (required) — URL of the header media (image or video). Required if headerType is 'image' or 'video'.
  • headerThumbnailUrl — Thumbnail URL for video headers, recommended for iOS compatibility.
  • buttons (required) — Up to 3 buttons displayed below the message body. Each button must specify its type and corresponding parameters:

Output shape

a list of JSON response objects, one per message sent

Returns the API response data for each sent button message. Throws errors if required fields are missing or invalid, such as button count exceeding 3 or required fields per button type. Supports button types: Quick Reply (with buttonId), CTA URL (with url and optional merchantUrl), CTA Copy (with copyCode), and CTA Call (with phoneNumber). If headerType is image or video, headerMediaUrl must be provided; for video, headerThumbnailUrl is recommended.

Links

Discussion