API Tappy.

Integre os produtos Tappy à sua aplicação de forma simples e rápida. APIs RESTful com documentação completa e SDKs para as principais linguagens.

Produtos

Guias

Tappy Whatsapp API

Introdução

A API Tappy Whatsapp permite que você integre as funcionalidades do Tappy Whatsapp em sua aplicação. Com esta API, você pode enviar mensagens, gerenciar contatos, criar automações e muito mais.

Todas as requisições devem ser feitas para https://api.tappy.com.br/v1/whatsapp

Início Rápido

javascript

const { TappyClient } = require('@tappy/sdk');

const client = new TappyClient({
  apiKey: 'sua-chave-api-aqui',
  product: 'whatsapp'
});

// Enviar mensagem
client.messages.send({
  to: '5511999999999',
  body: 'Olá do Tappy!'
})
.then(response => console.log(response))
.catch(error => console.error(error));

Endpoints da API

GET/v1/whatsapp/messages

Retorna uma lista de mensagens paginadas.

Parâmetros

Nome	Tipo	Requerido	Descrição
limit	integer	Não	Número de mensagens por página (max: 100)
offset	integer	Não	Índice para paginação
status	string	Não	Filtrar por status (sent, delivered, read)

Resposta

json

{
  "data": [
    {
      "id": "msg_123abc456def",
      "to": "5511999999999",
      "body": "Olá do Tappy!",
      "status": "delivered",
      "created_at": "2025-05-01T14:32:15.000Z"
    },
    // ... mais mensagens
  ],
  "meta": {
    "total": 243,
    "limit": 10,
    "offset": 0
  }
}

POST/v1/whatsapp/messages

Envia uma nova mensagem.

Parâmetros

Nome	Tipo	Requerido	Descrição
to	string	Sim	Número do destinatário no formato E.164
body	string	Sim	Conteúdo da mensagem
media_url	string	Não	URL da mídia a ser enviada

Resposta

json

{
  "id": "msg_abc123def456",
  "to": "5511999999999",
  "body": "Olá do Tappy!",
  "status": "queued",
  "created_at": "2025-05-02T16:15:32.000Z"
}

GET/v1/whatsapp/messages/{id}

Retorna informações de uma mensagem específica.

Parâmetros

Nome	Tipo	Requerido	Descrição
id	string	Sim	ID da mensagem

Resposta

json

{
  "id": "msg_abc123def456",
  "to": "5511999999999",
  "body": "Olá do Tappy!",
  "status": "delivered",
  "delivered_at": "2025-05-02T16:15:40.000Z",
  "read_at": null,
  "created_at": "2025-05-02T16:15:32.000Z"
}

Webhooks

Configure webhooks para receber notificações em tempo real sobre eventos da sua aplicação.

Endpoints para configuração

Configure seu endpoint para receber eventos:

https://seu-dominio.com/webhooks/tappy-whatsapp

Recursos da API Tappy

Nossa API foi projetada para desenvolvedores, com foco em simplicidade, desempenho e confiabilidade.

RESTful APIs

APIs REST com endpoints intuitivos, códigos de status consistentes e formatos JSON.

Webhooks

Receba notificações em tempo real sobre eventos importantes na sua aplicação.

Autenticação Segura

Autenticação baseada em tokens JWT com controle de permissões granular.

Explorar documentação completa