Z-API WhatsApp icon

Z-API WhatsApp

Integration with Z-API (WhatsApp) organized by resources (messages, groups, chats, contacts, products, queue, instance, status, etc.).

Message → Send a Button List

AI-generated

Summary

Send a button list message to a phone number.

Inputs

  • phone (required) — Contact number (or group ID) in international format, digits only.
  • message (required) — Message text to be sent
  • delayMessage — Delay in seconds before sending the message (1-15).
  • buttons — List of buttons, each with a label (required) and optional id.

Output shape

JSON object returned by Z-API (e.g., contains message ID, status, or generic success info)

The exact fields depend on the API; may include success indicators but no fixed schema.

Examples

Example 1: Send a button list to a contact to confirm an appointment

phone: 5511999999999, message: "Please confirm your appointment", delayMessage: 2, buttons: [{label:"Yes", id:"confirm"}, {label:"No", id:"reject"}]

Example 2: Prompt user for a choice via button list

phone: 5511999999999, message: "Select an option", buttons: [{label:"Option A", id:"a"}, {label:"Option B", id:"b"}]

Example 3: Send a button list with no delay

phone: 5511999999999, message: "Do you want to proceed?", delayMessage: 0, buttons: [{label:"Proceed", id:"proceed"}]

Links

Discussion