Kapso API icon

Kapso API

Send WhatsApp messages, templates, flows, media, contacts, broadcasts, and inbox records through Kapso. Choose a resource, then follow each operation setup hints.

Message → Send CTA

AI-generated

Summary

Send an interactive WhatsApp Call To Action (CTA) message through a connected Kapso WhatsApp number to a specified recipient phone number.

Inputs

  • Phone Number Name or ID — Select the connected Kapso WhatsApp number to send the message from. This is loaded from your Kapso project and can be chosen from a list or specified by ID using an expression.
  • Recipient Phone (required) — Enter the recipient's phone number in Meta's format: 8-15 digits without '+' or spaces.
  • Header Type — Optionally specify a header for the message: none, text, image, video, or document.
  • Header Text (optional) — If the header type is text, provide header text up to 60 characters to display above the message body.
  • Header Media Source — If the header is an image, video, or document, specify whether the header media is provided by a public HTTPS URL or a Meta Media ID.
  • Header Media URL (required) — For media headers sourced by public link, provide a valid HTTPS URL.
  • Header Media ID (optional) — For media headers sourced by media ID, provide the Meta media ID.
  • Header Document Filename (optional) — For document headers, optionally specify the filename displayed to the recipient.
  • Body Text (required) — Provide the main message body text for the CTA message, up to 1024 characters.
  • CTA Type (required) — Choose the CTA button type: URL to open a link or Phone Call to initiate a call.
  • Button Label (required) — Set the label displayed on the CTA button, up to 20 characters.
  • Button URL (required) — If CTA type is 'URL', specify the HTTPS URL that opens when the button is tapped.
  • Button Phone Number (required) — If CTA type is 'Phone Call', specify the E.164 formatted phone number (including '+') to call when the button is tapped.
  • Footer Text (optional) — Optional footer text displayed below the interactive content, up to 60 characters.
  • Message Send Options — Optional settings for the outbound message. Includes replying to a specific message (by WAMID) and opaque callback data for metadata purposes (max 512 characters).

Output shape

a list with one item containing JSON response data from the Kapso API confirming the message send result

The operation returns a Kapso API response per sent message. Use 'Reply To Message ID' to contextually reply to a prior message. Callback data is returned in status webhooks for correlation and is not visible to recipients.

Links

Discussion