Description
This endpoint allows you to send interactive messages with buttons organized in lists to individual contacts or groups on WhatsApp. Lists can contain multiple sections with various options each.Body
Body Parameters
Property | Type | Required | Description |
---|---|---|---|
sessionId | string | ✅ Yes | Authenticated session ID that will send the message |
jid | string | ✅ Yes | Recipient identifier (WhatsApp JID). Format: 5511999999999@s.whatsapp.net for contacts or 120363XXXXX@g.us for groups |
list | object | ✅ Yes | Object containing the button list information |
list.title | string | ✅ Yes | Message title |
list.description | string | ❌ No | Description or message body |
list.button | string | ✅ Yes | Button text that opens the list (example: “View options”) |
list.sections | array | ✅ Yes | Array of list sections |
list.sections[].title | string | ✅ Yes | Section title |
list.sections[].rows | array | ✅ Yes | Array of section rows (options) |
list.sections[].rows[].title | string | ✅ Yes | Option title |
list.sections[].rows[].description | string | ❌ No | Option description |
list.sections[].rows[].rowId | string | ✅ Yes | Unique option ID (used to identify the response) |
Status Codes
200
- Message with buttons sent successfully400
- Invalid parameters401
- Unauthorized session404
- Session not found
Usage Example
Authorizations
Your Wappfy API key (get it at dash.wappfy.com.br)
Body
application/json
Example:
"5511999999999@c.us"
Example:
"How are you?"
Example:
"Tell us how are you please 🙏"
Example:
"If you have any questions, please send it in the chat"
Example:
[
{ "type": "reply", "text": "I am good!" },
{
"type": "call",
"text": "Call us",
"phoneNumber": "+1234567890"
},
{
"type": "copy",
"text": "Copy code",
"copyCode": "4321"
},
{
"type": "url",
"text": "How did you do that?",
"url": "https://waha.devlike.pro"
}
]
Session name (instanceName)
Example:
"my-session"
- Option 1
- Option 2