Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-button-actions
Enviar botões de ação
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/send-button-actions \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "message": "<string>",
  "buttonActions": [
    {
      "id": "<string>",
      "type": "<string>",
      "label": "<string>",
      "phone": "<string>",
      "url": "<string>"
    }
  ]
}
'

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Neste método você poderá enviar mensagens de texto com botões de ação que redirecionam para links, iniciam chamadas ou fornecem respostas padrão.
Envios de botões atualmente se encontram disponíveis, porém possui alguns fatores decisivos para o funcionamento. Consulte o tópico status dos botões para mais informações.
ATENÇÃOAo enviar os três tipos de botões simultaneamente, o WhatsApp Web gera um erro. Combine botões CALL e URL juntos, e envie botões REPLY separadamente.

​
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 para casos de envio para grupos) do destinatário no formato DDI DDD NÚMERO. Ex: 551199999999
​
message
string
obrigatório
Texto da mensagem
​
buttonActions
array
obrigatório
Array de botões de ação

​
Opcionais

​
title
string
Título da mensagem
​
footer
string
Rodapé da mensagem

​
Request Body

Botões CALL e URL (juntos): 
{
  "phone": "551199999999",
  "message": "uma mensagem",
  "title": "se quiser vincular um titulo",
  "footer": "se quiser vincular um rodape top",
  "buttonActions": [
    {
      "id": "1",
      "type": "CALL",
      "phone": "554498398733",
      "label": "Fale conosco"
    },
    {
      "id": "2",
      "type": "URL",
      "url": "https://z-api.io",
      "label": "Visite nosso site"
    }
  ]
}
Botão REPLY (separado): 
{
  "phone": "551199999999",
  "message": "uma mensagem",
  "title": "se quiser vincular um titulo",
  "footer": "se quiser vincular um rodape top",
  "buttonActions": [
    {
      "id": "3",
      "type": "REPLY",
      "label": "Falar com atendente"
    }
  ]
}

​
Response

​
200

{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.