curl --request POST \
--url https://api.omni.z-api.io/v1/channels/{channelId}/messages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipient": {
"identifier": "5511999999999"
},
"content": {
"type": "INTERACTIVE_ACTION",
"body": {
"message": "How can we help?"
},
"header": {
"message": "Omni Z-API"
},
"footer": {
"message": "Choose an option"
},
"attachments": [
{
"id": "1",
"title": "Visit our website",
"name": "URL",
"url": "https://www.omni.z-api.io"
},
{
"id": "2",
"title": "Contact us",
"name": "CALL",
"phones": [
"5511999999999"
]
}
]
}
}
'{
"messageId": "wamid.HBgNNTU0NDk3MDUwNzg1FQIAERgSM0"
}{
"error": 401,
"message": "Unauthorized"
}Messages
Send action buttons
Send messages with action buttons (URL and call)
POST
/
v1
/
channels
/
{channelId}
/
messages
curl --request POST \
--url https://api.omni.z-api.io/v1/channels/{channelId}/messages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipient": {
"identifier": "5511999999999"
},
"content": {
"type": "INTERACTIVE_ACTION",
"body": {
"message": "How can we help?"
},
"header": {
"message": "Omni Z-API"
},
"footer": {
"message": "Choose an option"
},
"attachments": [
{
"id": "1",
"title": "Visit our website",
"name": "URL",
"url": "https://www.omni.z-api.io"
},
{
"id": "2",
"title": "Contact us",
"name": "CALL",
"phones": [
"5511999999999"
]
}
]
}
}
'{
"messageId": "wamid.HBgNNTU0NDk3MDUwNzg1FQIAERgSM0"
}{
"error": 401,
"message": "Unauthorized"
}Overview
Sends a message with action buttons to a contact. Thecontent.type field must be INTERACTIVE_ACTION.
Available button types:
- URL — Opens a link when clicked
- CALL — Calls a number when clicked
header and footer fields are optional.
Details of the WhatsApp Official rule in conversation window. See the capability matrix for every channel.
Authorizations
Secret Key generated in the Omni Z-API Security panel
Path Parameters
Channel ID
Example:
"YOUR_CHANNEL_ID"
Body
application/json
Response
Message sent successfully
Sent message ID