Enviar botões

curl --request POST \
  --url https://cloud.datafyapi.com.br/v1/{phone_number_id}/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "5511999999999",
  "type": "interactive",
  "interactive": {
    "type": "button",
    "header": {
      "type": "text",
      "text": "Confirmação de agendamento"
    },
    "body": {
      "text": "Olá, Camila! Seu atendimento está marcado para segunda-feira, às 9h. Deseja confirmar?"
    },
    "footer": {
      "text": "Clínica Exemplo"
    },
    "action": {
      "buttons": [
        {
          "type": "reply",
          "reply": {
            "id": "confirmar",
            "title": "Confirmar"
          }
        },
        {
          "type": "reply",
          "reply": {
            "id": "remarcar",
            "title": "Remarcar"
          }
        },
        {
          "type": "reply",
          "reply": {
            "id": "cancelar",
            "title": "Cancelar"
          }
        }
      ]
    }
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    messaging_product: 'whatsapp',
    recipient_type: 'individual',
    to: '5511999999999',
    type: 'interactive',
    interactive: {
      type: 'button',
      header: {type: 'text', text: 'Confirmação de agendamento'},
      body: JSON.stringify({
        text: 'Olá, Camila! Seu atendimento está marcado para segunda-feira, às 9h. Deseja confirmar?'
      }),
      footer: {text: 'Clínica Exemplo'},
      action: {
        buttons: [
          {type: 'reply', reply: {id: 'confirmar', title: 'Confirmar'}},
          {type: 'reply', reply: {id: 'remarcar', title: 'Remarcar'}},
          {type: 'reply', reply: {id: 'cancelar', title: 'Cancelar'}}
        ]
      }
    }
  })
};

fetch('https://cloud.datafyapi.com.br/v1/{phone_number_id}/messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://cloud.datafyapi.com.br/v1/{phone_number_id}/messages"

payload = {
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "5511999999999",
    "type": "interactive",
    "interactive": {
        "type": "button",
        "header": {
            "type": "text",
            "text": "Confirmação de agendamento"
        },
        "body": { "text": "Olá, Camila! Seu atendimento está marcado para segunda-feira, às 9h. Deseja confirmar?" },
        "footer": { "text": "Clínica Exemplo" },
        "action": { "buttons": [
                {
                    "type": "reply",
                    "reply": {
                        "id": "confirmar",
                        "title": "Confirmar"
                    }
                },
                {
                    "type": "reply",
                    "reply": {
                        "id": "remarcar",
                        "title": "Remarcar"
                    }
                },
                {
                    "type": "reply",
                    "reply": {
                        "id": "cancelar",
                        "title": "Cancelar"
                    }
                }
            ] }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "5511999999999",
      "wa_id": "5511999999999"
    }
  ],
  "messages": [
    {
      "id": "wamid.HBgNNTUxMTk5OTk5OTk5ORUCABIYFjNFQjA="
    }
  ]
}

{
  "error": {
    "message": "(#100) Invalid parameter",
    "type": "OAuthException",
    "code": 100,
    "fbtrace_id": "AbCdEfGhIjK"
  }
}

{
  "statusCode": 401,
  "message": "Token inválido ou não encontrado."
}

POST

{phone_number_id}

messages

Enviar botões

curl --request POST \
  --url https://cloud.datafyapi.com.br/v1/{phone_number_id}/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "5511999999999",
  "type": "interactive",
  "interactive": {
    "type": "button",
    "header": {
      "type": "text",
      "text": "Confirmação de agendamento"
    },
    "body": {
      "text": "Olá, Camila! Seu atendimento está marcado para segunda-feira, às 9h. Deseja confirmar?"
    },
    "footer": {
      "text": "Clínica Exemplo"
    },
    "action": {
      "buttons": [
        {
          "type": "reply",
          "reply": {
            "id": "confirmar",
            "title": "Confirmar"
          }
        },
        {
          "type": "reply",
          "reply": {
            "id": "remarcar",
            "title": "Remarcar"
          }
        },
        {
          "type": "reply",
          "reply": {
            "id": "cancelar",
            "title": "Cancelar"
          }
        }
      ]
    }
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    messaging_product: 'whatsapp',
    recipient_type: 'individual',
    to: '5511999999999',
    type: 'interactive',
    interactive: {
      type: 'button',
      header: {type: 'text', text: 'Confirmação de agendamento'},
      body: JSON.stringify({
        text: 'Olá, Camila! Seu atendimento está marcado para segunda-feira, às 9h. Deseja confirmar?'
      }),
      footer: {text: 'Clínica Exemplo'},
      action: {
        buttons: [
          {type: 'reply', reply: {id: 'confirmar', title: 'Confirmar'}},
          {type: 'reply', reply: {id: 'remarcar', title: 'Remarcar'}},
          {type: 'reply', reply: {id: 'cancelar', title: 'Cancelar'}}
        ]
      }
    }
  })
};

fetch('https://cloud.datafyapi.com.br/v1/{phone_number_id}/messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://cloud.datafyapi.com.br/v1/{phone_number_id}/messages"

payload = {
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "5511999999999",
    "type": "interactive",
    "interactive": {
        "type": "button",
        "header": {
            "type": "text",
            "text": "Confirmação de agendamento"
        },
        "body": { "text": "Olá, Camila! Seu atendimento está marcado para segunda-feira, às 9h. Deseja confirmar?" },
        "footer": { "text": "Clínica Exemplo" },
        "action": { "buttons": [
                {
                    "type": "reply",
                    "reply": {
                        "id": "confirmar",
                        "title": "Confirmar"
                    }
                },
                {
                    "type": "reply",
                    "reply": {
                        "id": "remarcar",
                        "title": "Remarcar"
                    }
                },
                {
                    "type": "reply",
                    "reply": {
                        "id": "cancelar",
                        "title": "Cancelar"
                    }
                }
            ] }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "5511999999999",
      "wa_id": "5511999999999"
    }
  ],
  "messages": [
    {
      "id": "wamid.HBgNNTUxMTk5OTk5OTk5ORUCABIYFjNFQjA="
    }
  ]
}

{
  "error": {
    "message": "(#100) Invalid parameter",
    "type": "OAuthException",
    "code": 100,
    "fbtrace_id": "AbCdEfGhIjK"
  }
}

{
  "statusCode": 401,
  "message": "Token inválido ou não encontrado."
}

Envia uma mensagem com até três botões para o cliente responder com um toque, como Confirmar, Remarcar e Cancelar. É a forma mais simples de coletar uma escolha sem depender de o cliente digitar. A janela de 24 horas precisa estar aberta.

O destinatário pode ser informado pelo número de telefone (to) ou pelo ID do usuário (recipient). Se os dois forem enviados, vale o to; para enviar pelo ID do usuário, deixe o to em branco. Veja a diferença em Destinatário.

Estrutura da mensagem

A mensagem é do tipo interactive, com interactive.type igual a button. Ela tem quatro partes:

Parte	Campo	Obrigatório	Limite
Cabeçalho	`interactive.header`	Não	Texto com até 60 caracteres, ou imagem, vídeo ou documento.
Texto	`interactive.body.text`	Sim	1.024 caracteres.
Rodapé	`interactive.footer.text`	Não	60 caracteres.
Botões	`interactive.action.buttons`	Sim	De 1 a 3 botões.

Botões

Cada botão tem type igual a reply e um objeto reply com dois campos:

Campo	Limite	Para que serve
`reply.id`	256 caracteres	Identificador que volta no webhook quando o cliente toca no botão. Use um valor que o seu sistema reconheça, como `confirmar` ou `pedido-7539-cancelar`.
`reply.title`	20 caracteres	Texto exibido no botão. Não pode se repetir entre os botões da mesma mensagem.

"action": {
  "buttons": [
    { "type": "reply", "reply": { "id": "confirmar", "title": "Confirmar" } },
    { "type": "reply", "reply": { "id": "remarcar", "title": "Remarcar" } },
    { "type": "reply", "reply": { "id": "cancelar", "title": "Cancelar" } }
  ]
}

Cabeçalho

O cabeçalho é opcional e aceita um texto ou uma mídia:

`header.type`	Conteúdo
`text`	`header.text`, com até 60 caracteres.
`image`	`header.image`, com `link` ou `id`.
`video`	`header.video`, com `link` ou `id`.
`document`	`header.document`, com `link` ou `id`.

A mídia do cabeçalho segue as mesmas regras e formatos de Enviar imagem, Enviar vídeo e Enviar documento: informe link ou id, nunca os dois.

"header": {
  "type": "image",
  "image": { "link": "https://exemplo.com/agenda.jpg" }
}

No Testar, a mensagem já vem preenchida com um cabeçalho de texto, o texto, o rodapé e três botões. Para testar um cabeçalho com mídia, troque o type do cabeçalho e preencha o link da mídia.

Resposta do cliente

Quando o cliente toca em um botão, chega pelo webhook uma mensagem do tipo interactive, com interactive.type igual a button_reply. O button_reply.id é o reply.id do botão tocado, e o context.id aponta para a mensagem com os botões:

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "234567890123456",
      "changes": [
        {
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "5541999999999",
              "phone_number_id": "123456789012345"
            },
            "contacts": [
              {
                "profile": {
                  "name": "Camila Souza"
                },
                "wa_id": "5511999999999",
                "user_id": "BR.13491208655302741918"
              }
            ],
            "messages": [
              {
                "context": {
                  "from": "5541999999999",
                  "id": "wamid.HBgNNTUxMTk5OTk5OTk5ORUCABIYFjNFQjA="
                },
                "from": "5511999999999",
                "from_user_id": "BR.13491208655302741918",
                "id": "wamid.HBgNNTUxMTk5OTk5OTk5ORUCABIYFjVBQjI=",
                "timestamp": "1757956200",
                "type": "interactive",
                "interactive": {
                  "type": "button_reply",
                  "button_reply": {
                    "id": "confirmar",
                    "title": "Confirmar"
                  }
                }
              }
            ]
          },
          "field": "messages"
        }
      ]
    }
  ]
}

Use o button_reply.id para decidir o que fazer com a resposta. O title pode mudar se você ajustar o texto do botão; o id continua o mesmo.

A resposta do cliente é uma mensagem nova, então renova a janela de 24 horas. Veja mais detalhes na documentação de botões de resposta da Meta.

Autorizações

Authorization

string

header

obrigatório

Token gerado no painel da Datafy ao criar o canal. Formato: sk_live_xxx.

Parâmetros de caminho

phone_number_id

string

obrigatório

ID do número que envia a mensagem. Descubra com GET /me.

Corpo

application/json

messaging_product

enum<string>

padrão:whatsapp

obrigatório

Sempre whatsapp.

Opções disponíveis:

whatsapp

Exemplo:

"whatsapp"

string

obrigatório

Número do destinatário com código do país e DDD, como 5511999999999. Tem prioridade sobre recipient: para enviar pelo ID do usuário, deixe em branco.

Exemplo:

"5511999999999"

type

enum<string>

padrão:interactive

obrigatório

Sempre interactive.

Opções disponíveis:

interactive

Exemplo:

"interactive"

interactive

object

obrigatório

Mensagem com até três botões de resposta rápida.

Show child attributes

recipient_type

enum<string>

padrão:individual

Sempre individual.

Opções disponíveis:

individual

Exemplo:

"individual"

recipient

string

ID do usuário no WhatsApp (BSUID), recebido nos webhooks em from_user_id e contacts[].user_id, como BR.13491208655302741918. Usado quando to não é informado.

context

object

Responde citando uma mensagem anterior da conversa.

Show child attributes

Resposta

Envio aceito pela Meta. Não confirma a entrega.

Começar

Administração

Mensagens

Recursos de mensagens

Mídias

Templates

Conta e número

Endpoints Datafy

Webhooks

Enviar botões

Estrutura da mensagem

Botões

Cabeçalho

Resposta do cliente

Autorizações

Parâmetros de caminho

Corpo

Resposta

​Estrutura da mensagem

​Botões

​Cabeçalho

​Resposta do cliente

Autorizações

Parâmetros de caminho

Corpo

Resposta

Estrutura da mensagem

Botões

Cabeçalho

Resposta do cliente