WhatsApp API

WhatsApp API — Mensagens Conversacionais

Envie e receba mensagens WhatsApp com suporte a templates, mídia enriquecida e interações. Gerencie clientes, templates pré-aprovados e acompanhe conversas em tempo real.

Introdução

A WhatsApp API da Yup Chat permite que você envie e receba mensagens através do WhatsApp Business API com suporte completo a templates pré-aprovados, mídia enriquecida (imagens, vídeos, documentos), mensagens interativas com botões, e gerenciamento de clientes. Com callbacks de status em tempo real e rastreamento completo de conversas, você pode integrar WhatsApp em seus fluxos de negócio com confiança.

Envio de Mensagens

Envie mensagens de texto, templates, mídia e interativas com suporte a variáveis e personalização.

Recebimento de Mensagens

Receba mensagens de entrada, confirmações de leitura e respostas a interações via webhooks.

Gerenciamento de Templates

Crie, gerencie e reutilize templates pré-aprovados para envios em massa com variáveis.

Gerenciamento de Clientes

Crie e consulte clientes para organizar conversas e histórico de mensagens.

Base URL

Todos os endpoints da WhatsApp API são acessados através da seguinte URL base:

https://api.yup.chat/v1/

Todos os exemplos de endpoints nesta documentação devem ser prefixados com esta URL base. Por exemplo, o endpoint POST /whatsapp/messages completo seria: https://api.yup.chat/v1/whatsapp/messages

Autenticação

A WhatsApp API utiliza autenticação HTTP Basic com seu ID e Token, assim como a SMS API. Envie suas credenciais codificadas em Base64 no header Authorization.

Authorization: Basic <base64(ID:TOKEN)>

Dica: Obtenha suas credenciais em "Informações da conta" no Dashboard da Yup Chat.

Endpoints

GET/whatsapp/client

Consulta informações de um cliente WhatsApp específico pelo seu ID.

Parâmetros

Parâmetro	Tipo	Descrição
`client_id`	String	ID único do cliente

Exemplo de Requisição

curl -u 'SEU_ID:SEU_TOKEN' \
  https://api.yup.chat/v1/whatsapp/client/client_123456

Exemplo de Resposta (200 OK)

{
  "id": "client_123456",
  "name": "Empresa XYZ",
  "phone": "+5511999999999",
  "status": "active",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-19T14:20:00Z"
}

POST/whatsapp/client

Cria um novo cliente WhatsApp para organizar conversas e histórico de mensagens.

Corpo da Requisição

Campo	Tipo	Descrição
`name`*	String	Nome do cliente
`phone`*	String	Número em formato E.164 (ex: +5511999999999)
`metadata`	Object	Dados adicionais do cliente (ex: email, empresa)

Exemplo de Requisição

curl -X POST https://api.yup.chat/v1/whatsapp/client \
  -u 'SEU_ID:SEU_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Empresa XYZ",
    "phone": "+5511999999999",
    "metadata": {
      "email": "[email protected]",
      "segment": "premium"
    }
  }'

Exemplo de Resposta (201 Created)

{
  "id": "client_123456",
  "name": "Empresa XYZ",
  "phone": "+5511999999999",
  "status": "active",
  "metadata": {
    "email": "[email protected]",
    "segment": "premium"
  },
  "created_at": "2024-01-19T14:20:00Z",
  "updated_at": "2024-01-19T14:20:00Z"
}

POST/whatsapp/templates

Cria um novo template de WhatsApp pré-aprovado para uso em envios em massa com variáveis.

Corpo da Requisição

Campo	Tipo	Descrição
`name`*	String	Nome único do template
`category`*	String	Categoria: "marketing", "transactional", "otp"
`body`*	String	Conteúdo com variáveis {1}, {2}, etc

Exemplo de Requisição

curl -X POST https://api.yup.chat/v1/whatsapp/templates \
  -u 'SEU_ID:SEU_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "confirmacao_pedido",
    "category": "transactional",
    "body": "Olá {1}, seu pedido #{2} foi confirmado!"
  }'

POST/whatsapp/messages

Envia uma mensagem WhatsApp. Suporta múltiplos tipos: texto simples, templates, imagens, vídeos e mensagens interativas com botões.

Corpo da Requisição

Campo	Tipo	Descrição
`type`*	String	Tipo: "simple", "text", "image", "video", "template", "interactive"
`to`*	String	Número em formato E.164 (ex: +5511999999999)
`body`	String	Conteúdo da mensagem (para tipo "text")
`url`	String	URL da mídia (para tipos "image", "video")
`template`	String	ID do template (para tipo "template")
`params`	Array	Variáveis para substituir no template
`interaction`	Object	Estrutura de botões para mensagens interativas

Exemplo: Mensagem de Texto

curl -X POST https://api.yup.chat/v1/whatsapp/messages \
  -u 'SEU_ID:SEU_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "text",
    "to": "+5511999999999",
    "body": "Olá! Bem-vindo à nossa plataforma."
  }'

Exemplo: Mensagem com Imagem

curl -X POST https://api.yup.chat/v1/whatsapp/messages \
  -u 'SEU_ID:SEU_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "image",
    "to": "+5511999999999",
    "url": "https://exemplo.com/imagem.jpg",
    "body": "Confira nossa nova coleção!"
  }'

Exemplo: Mensagem com Template

curl -X POST https://api.yup.chat/v1/whatsapp/messages \
  -u 'SEU_ID:SEU_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "template",
    "to": "+5511999999999",
    "template": "confirmacao_pedido",
    "params": ["João Silva", "123456"]
  }'

Exemplo de Resposta (200 OK)

{
  "id": "msg_1234567890abcdef",
  "type": "text",
  "to": "+5511999999999",
  "body": "Olá! Bem-vindo à nossa plataforma.",
  "status": "sent",
  "timestamp": "2024-01-19T14:20:00Z",
  "account_id": "acc_123456789"
}

DELETE/whatsapp/templates/:id

Deleta um template de WhatsApp pelo seu ID.

Parâmetros

Parâmetro	Tipo	Descrição
`id`*	String	ID único do template a deletar

POST/whatsapp/messages/list

Lista mensagens com filtros por cliente, período e status. Retorna uma lista paginada de mensagens.

Corpo da Requisição

Campo	Tipo	Descrição
`client_id`	String	Filtrar por cliente específico
`status`	String	Filtrar por status: "sent", "delivered", "read", "failed"
`limit`	Number	Número máximo de resultados (padrão: 50)

GET/whatsapp/templates/list

Lista todos os templates de WhatsApp criados na conta com status de aprovação.

Tipos de Mensagens

Simple

Mensagem de texto simples sem formatação especial.

"type": "simple", "body": "Seu texto aqui"

Text

Mensagem de texto com suporte a emojis e formatação básica.

"type": "text", "body": "Seu texto aqui"

Image

Envio de imagem com legenda opcional. Suporta JPEG, PNG e GIF.

"type": "image", "url": "https://...", "body": "Legenda"

Video

Envio de vídeo com legenda opcional. Suporta MP4 e WebM.

"type": "video", "url": "https://...", "body": "Legenda"

Template

Uso de template pré-aprovado com variáveis personalizadas.

"type": "template", "template": "id", "params": ["valor1"]

Interactive

Mensagem com botões interativos para seleção do usuário.

"type": "interactive", "body": "Texto", "interaction": {...}

Interação — Mensagens com Botões

Mensagens interativas permitem que você envie botões para o usuário selecionar. A estrutura de interação define os botões disponíveis e as ações associadas.

Estrutura de Interação

{
  "type": "interactive",
  "to": "+5511999999999",
  "body": "Qual é sua preferência?",
  "interaction": {
    "type": "button",
    "buttons": [
      {
        "id": "btn_1",
        "title": "Opção 1",
        "action": "reply"
      },
      {
        "id": "btn_2",
        "title": "Opção 2",
        "action": "reply"
      }
    ]
  }
}

Exemplo Completo: Mensagem com Botões

curl -X POST https://api.yup.chat/v1/whatsapp/messages \
  -u 'SEU_ID:SEU_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "interactive",
    "to": "+5511999999999",
    "body": "Deseja confirmar seu pedido?",
    "interaction": {
      "type": "button",
      "buttons": [
        {
          "id": "btn_confirm",
          "title": "Confirmar",
          "action": "reply"
        },
        {
          "id": "btn_cancel",
          "title": "Cancelar",
          "action": "reply"
        }
      ]
    }
  }'

Recursos Principais

Mensagens Conversacionais

Envie e receba mensagens em conversas bidirecionais com histórico completo

Mídia Enriquecida

Suporte a imagens, vídeos, documentos e áudio com qualidade otimizada

Templates Pré-Aprovados

Crie templates reutilizáveis com variáveis para envios em massa

Mensagens Interativas

Envie botões e menus para que usuários façam seleções diretas

Rastreamento em Tempo Real

Acompanhe status: enviado, entregue, lido com timestamps precisos

Gerenciamento de Clientes

Organize conversas por cliente com metadados e histórico completo

Casos de Uso

Notificações de Pedidos

Acompanhamento de pedidos com atualizações em tempo real

Suporte ao Cliente

Atendimento bidirecional com histórico de conversas

Confirmação de Agendamentos

Lembretes e confirmações automáticas de compromissos

Campanhas de Marketing

Envio em massa de promoções com templates personalizados

Autenticação 2FA

Envio de códigos de verificação seguros via WhatsApp

Pesquisas e Feedback

Coleta de respostas com botões interativos

Pronto para Começar?

Integre a WhatsApp API em minutos e comece a enviar mensagens conversacionais.