Send List Message
Send organized lists with multiple options
Reading time: 1 minute
Send List Message
Send organized lists with multiple options.
POST
{{base_url}}/w/message/listQuery Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
phone_number_id | string | Yes | Phone number ID of the sender |
Request Body (JSON)
| Parameter | Type | Required | Description |
|---|---|---|---|
phone | string | Yes | Recipient phone number |
body_text | string | Yes | Message text |
button_text | string | Yes | List button text (max 20 characters) |
sections | array | Yes | Array of sections (1-10 sections) |
header_text | string | No | Header text |
footer_text | string | No | Footer text |
Section Specifications
| Parameter | Type | Required | Description |
|---|---|---|---|
title | string | Yes | Section title (max 24 characters) |
rows | array | Yes | Array of items (1-10 items) |
Item Specifications
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Unique item identifier (max 200 characters) |
title | string | Yes | Item title (max 24 characters) |
description | string | No | Item description (max 72 characters) |
When to use lists?
Lists are ideal when you have:
- More than 3 options (buttons are limited to 3)
- Multiple categories of options
- Need for detailed description of each option
Example Request
Example Requestbash
curl -X POST "{{base_url}}/w/message/list?phone_number_id=123456" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-Awal-Signature-256: sha256=abc..." \
-H "X-Timestamp: 1704124800" \
-H "X-Domain: your-workspace" \
-H "X-Client-ID: your-client-id" \
-d '{
"phone": "96650000000",
"header_text": "šļø Product Catalog",
"body_text": "Choose from the list below to view more details:",
"button_text": "View Catalog",
"sections": [
{
"title": "š± Electronics",
"rows": [
{
"id": "product_phone_1",
"title": "iPhone 15 Pro",
"description": "Latest model - 256GB"
},
{
"id": "product_laptop_1",
"title": "MacBook Pro M3",
"description": "High performance - 16GB RAM"
}
]
},
{
"title": "š Clothing",
"rows": [
{
"id": "product_shirt_1",
"title": "Cotton Shirt",
"description": "All sizes available"
},
{
"id": "product_jeans_1",
"title": "Jeans",
"description": "Classic blue"
}
]
}
]
}'Related
ā Back to Messages
View Guide