Send a message with a call-to-action link button
send_cta_buttonSend a WhatsApp message carrying one link button.
Set exactly one recipient: number, group_id, or contact_id.
A link button is the only interactive type WhatsApp accepts on this kind of connection. Reply buttons and list pickers are not available and will not become available, so do not try to emulate them.
body is the text above the button (up to 1024 characters),
button_text its label (up to 20), header and footer optional short
lines above and below (up to 60 each).
A message with a link button cannot be edited after it is sent:
delete_message is the only change for it.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"body": "<body>",
"button_text": "<button_text>",
"button_url": "<button_url>"
},
"name": "send_cta_button"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | The text above the button, 1 to 1024 characters. | |
| footer | No | A short line below the text, up to 60 characters. | |
| header | No | A short line above the text, 1 to 60 characters. | |
| number | No | Recipient phone number in E.164 form, digits only, country code first (e.g. `5511999999999`). Set exactly one of `number`, `group_id` or `contact_id`. | |
| group_id | No | Recipient group id (`grp_…`), from `list_groups`. A group id belongs to one number: an id from one number does not address the same group in another. Set exactly one of `number`, `group_id` or `contact_id`. Addressing a group needs a plan that includes group messaging: without it the call answers `payment_required: feature_not_available`, and retrying will not change that. | |
| button_url | Yes | The link the button opens when the recipient taps it. | |
| contact_id | No | Recipient contact id (`ct_…`), from `list_contacts`. A contact id belongs to one number: an id from one number does not address the same person in another. Set exactly one of `number`, `group_id` or `contact_id`. | |
| button_text | Yes | The label on the button, 1 to 20 characters. | |
| number_alias | No | Which of the organization's WhatsApp numbers this acts on: `main`, the alias of an extra number, or the number's `id` (`num_…`), which stays the same when the alias is renamed. Call `list_numbers` to see them. Defaults to the main number. | main |
| idempotency_key | No | Any printable ASCII text you choose, 1 to 255 characters, for example the id of the event you are answering. Reusing it for the same number suppresses a duplicate if you retry, but only for the same request: the same key with another recipient or another text is refused as idempotency_key_conflict and nothing is sent, so use a new key for each new message. Without it, retrying after a timeout may deliver the message twice, and the recipient sees both. | |
| quoted_message_id | No | Quote an earlier message (`msg_…`) so it appears above yours. Do this only when your text depends on something said a while ago, yours or theirs; do not quote the message you are answering right now, send a normal message instead. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||