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": "01A0C92D0C957FE98B73C8BA0CACF741"
}{
"error": 401,
"message": "Unauthorized"
}{
"timestamp": "2026-10-22T14:00:00.123Z",
"code": "BUSINESS_RULE_VIOLATION",
"subCode": "CHANNEL_DISCONNECTED",
"message": "Channel is disconnected"
}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": "01A0C92D0C957FE98B73C8BA0CACF741"
}{
"error": 401,
"message": "Unauthorized"
}{
"timestamp": "2026-10-22T14:00:00.123Z",
"code": "BUSINESS_RULE_VIOLATION",
"subCode": "CHANNEL_DISCONNECTED",
"message": "Channel is disconnected"
}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 Meta Cloud API rule in conversation window. See what each channel accepts for every channel.
If the channel is disconnected, the API refuses the send with
422 and subCode CHANNEL_DISCONNECTED, and the message is not sent. See Send errors.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 — 32-character uppercase hexadecimal string