Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
reply-template-button
Responder botão de ação
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/reply-template-button \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "responseTemplateButtonId": "<string>",
  "messageId": "<string>"
}
'
import requests

url = "https://api.z-api.io/instances/{instanceId}/token/{token}/reply-template-button"

payload = {
    "phone": "<string>",
    "responseTemplateButtonId": "<string>",
    "messageId": "<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>', responseTemplateButtonId: '<string>', messageId: '<string>'})
};

fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/reply-template-button', 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}/reply-template-button",
  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>',
    'responseTemplateButtonId' => '<string>',
    'messageId' => '<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}/reply-template-button"

	payload := strings.NewReader("{\n  \"phone\": \"<string>\",\n  \"responseTemplateButtonId\": \"<string>\",\n  \"messageId\": \"<string>\"\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}/reply-template-button")
  .header("Client-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phone\": \"<string>\",\n  \"responseTemplateButtonId\": \"<string>\",\n  \"messageId\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/reply-template-button")

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  \"responseTemplateButtonId\": \"<string>\",\n  \"messageId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "zaapId": "<string>",
  "messageId": "<string>",
  "id": "<string>"
}

Conceituação

Este endpoint permite responder um botão de ação, simulando o clique do usuário em uma das opções enviadas anteriormente via send-button-actions.
Apenas botões do tipo REPLY podem ser respondidos. Botões de outros tipos não suportam resposta via API.
O botão deve ter sido previamente enviado e o ID do botão deve ser obtido via webhook de recebimento da mensagem.

Exemplo no WhatsApp


Atributos

instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
token
string
obrigatório
Token da sua instância Z-API.

Obrigatórios

phone
string
obrigatório
Telefone (ou ID do grupo) no formato DDI DDD NÚMERO. Ex: 551199999999
responseTemplateButtonId
string
obrigatório
ID do botão do tipo REPLY. Esse ID é obtido via webhook da mensagem recebida.
messageId
string
obrigatório
ID da mensagem que contém os botões enviados anteriormente.

Request Body

{
  "phone": "5511999999999",
  "responseTemplateButtonId": "1",
  "messageId": "D241XXXX732339502B68"
}

Response

200

zaapId
string
id no z-api
messageId
string
id no whatsapp
id
string
Adicionado para compatibilidade com zapier, ele tem o mesmo valor do messageId
{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

405

Verifique se o método HTTP utilizado está correto (POST).

415

Certifique-se de enviar o header Content-Type: application/json.