curl --request POST \
--url https://api.omni.z-api.io/channels/{channel_id}/token/{channel_token}/send-button-list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phone": "5511999999999",
"message": "How would you rate our service?",
"buttonList": {
"buttons": [
{
"id": "1",
"label": "Excellent"
},
{
"id": "2",
"label": "Good"
},
{
"id": "3",
"label": "Average"
}
]
}
}
'{
"zaapId": "3999984263738042930CD6ECDE9VDWSA",
"messageId": "D241XXXX732339502B68",
"id": "D241XXXX732339502B68"
}{
"error": 405,
"message": "Method not allowed"
}{
"error": 415,
"message": "Unsupported media type"
}Messages
Send button list
Send messages with quick selection buttons
POST
/
send-button-list
curl --request POST \
--url https://api.omni.z-api.io/channels/{channel_id}/token/{channel_token}/send-button-list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phone": "5511999999999",
"message": "How would you rate our service?",
"buttonList": {
"buttons": [
{
"id": "1",
"label": "Excellent"
},
{
"id": "2",
"label": "Good"
},
{
"id": "3",
"label": "Average"
}
]
}
}
'{
"zaapId": "3999984263738042930CD6ECDE9VDWSA",
"messageId": "D241XXXX732339502B68",
"id": "D241XXXX732339502B68"
}{
"error": 405,
"message": "Method not allowed"
}{
"error": 415,
"message": "Unsupported media type"
}Overview
Method for sending messages with quick selection buttons. The recipient can choose from the presented options, which work as a reply to the message. Optionally, you can include an image or video with the buttons by adding theimage or video field inside buttonList.
Send only
image or video, never both at the same time.Authorizations
Secret Key generated in the Omni Z-API Security panel
Body
application/json
Recipient phone number (country code + area code + number)
Example:
"5511999999999"
Message text (required, cannot be empty)
Button configuration
Show child attributes
Show child attributes
Delay in seconds before sending (1-15)
Required range:
1 <= x <= 15