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>"
}
'
{
  "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.