Send buttons with image
curl --request POST \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/send-button-list \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"phone": "<string>",
"message": "<string>",
"buttonList": {
"image": "<string>",
"buttons": [
{
"label": "<string>",
"id": "<string>"
}
]
}
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/send-button-list"
payload = {
"phone": "<string>",
"message": "<string>",
"buttonList": {
"image": "<string>",
"buttons": [
{
"label": "<string>",
"id": "<string>"
}
]
}
}
headers = {
"Client-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
phone: '<string>',
message: '<string>',
buttonList: {image: '<string>', buttons: [{label: '<string>', id: '<string>'}]}
})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/send-button-list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.z-api.io/instances/{instanceId}/token/{token}/send-button-list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'phone' => '<string>',
'message' => '<string>',
'buttonList' => [
'image' => '<string>',
'buttons' => [
[
'label' => '<string>',
'id' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Client-Token: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.z-api.io/instances/{instanceId}/token/{token}/send-button-list"
payload := strings.NewReader("{\n \"phone\": \"<string>\",\n \"message\": \"<string>\",\n \"buttonList\": {\n \"image\": \"<string>\",\n \"buttons\": [\n {\n \"label\": \"<string>\",\n \"id\": \"<string>\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Client-Token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.z-api.io/instances/{instanceId}/token/{token}/send-button-list")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phone\": \"<string>\",\n \"message\": \"<string>\",\n \"buttonList\": {\n \"image\": \"<string>\",\n \"buttons\": [\n {\n \"label\": \"<string>\",\n \"id\": \"<string>\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/send-button-list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phone\": \"<string>\",\n \"message\": \"<string>\",\n \"buttonList\": {\n \"image\": \"<string>\",\n \"buttons\": [\n {\n \"label\": \"<string>\",\n \"id\": \"<string>\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_bodyMessages
Send buttons with image
Send an image with quick reply buttons
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-button-list
Send buttons with image
curl --request POST \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/send-button-list \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"phone": "<string>",
"message": "<string>",
"buttonList": {
"image": "<string>",
"buttons": [
{
"label": "<string>",
"id": "<string>"
}
]
}
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/send-button-list"
payload = {
"phone": "<string>",
"message": "<string>",
"buttonList": {
"image": "<string>",
"buttons": [
{
"label": "<string>",
"id": "<string>"
}
]
}
}
headers = {
"Client-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
phone: '<string>',
message: '<string>',
buttonList: {image: '<string>', buttons: [{label: '<string>', id: '<string>'}]}
})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/send-button-list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.z-api.io/instances/{instanceId}/token/{token}/send-button-list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'phone' => '<string>',
'message' => '<string>',
'buttonList' => [
'image' => '<string>',
'buttons' => [
[
'label' => '<string>',
'id' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Client-Token: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.z-api.io/instances/{instanceId}/token/{token}/send-button-list"
payload := strings.NewReader("{\n \"phone\": \"<string>\",\n \"message\": \"<string>\",\n \"buttonList\": {\n \"image\": \"<string>\",\n \"buttons\": [\n {\n \"label\": \"<string>\",\n \"id\": \"<string>\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Client-Token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.z-api.io/instances/{instanceId}/token/{token}/send-button-list")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phone\": \"<string>\",\n \"message\": \"<string>\",\n \"buttonList\": {\n \"image\": \"<string>\",\n \"buttons\": [\n {\n \"label\": \"<string>\",\n \"id\": \"<string>\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/send-button-list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phone\": \"<string>\",\n \"message\": \"<string>\",\n \"buttonList\": {\n \"image\": \"<string>\",\n \"buttons\": [\n {\n \"label\": \"<string>\",\n \"id\": \"<string>\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_bodyOverview
With this method you can send images with action button options, the button content e.g.: YES / No, can be chosen by the user.Button sending is currently available, but there are some decisive factors for it to work. For more details check the Button Status topic.
The message attribute cannot be sent empty!
Example on WhatsApp

Attributes
Header
Your instance ID. Available in the Z-API panel under Instances.
Your Z-API instance token.
Required
Recipient’s phone number (or group ID for group messages) in DDI DDD NUMBER format. E.g.: 551199999999
Text to be sent
Optional
Delay added to the message. You can choose between a range of 1 to 15 sec, meaning how many seconds it will wait before sending the next message. (E.g.: “delayMessage”: 5). The default delay if not provided is 1 to 3 sec
Request Body
{
"phone": "5511999999999",
"message": "Is Z-API Good?",
"buttonList": {
"image": "https://avatars.githubusercontent.com/u/60630101?s=280&v=4",
"buttons": [
{
"id": "1",
"label": "Great"
},
{
"id": "2",
"label": "Excellent"
}
]
}
}
Response
200
{
"zaapId": "3999984263738042930CD6ECDE9VDWSA",
"messageId": "D241XXXX732339502B68",
"id": "D241XXXX732339502B68"
}
405
Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.415
If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.⌘I