Construa sua integração

A API oferece uma interface única para operar conversas, WhatsApp, telefonia, campanhas, CRM e automações com IA.

Use a referência para explorar os contratos disponíveis, autenticar sua aplicação e testar chamadas diretamente no navegador.

📘
Ao entrar no portal, o Try It pode preencher automaticamente sua credencial de acesso. As chamadas são enviadas ao servidor configurado na definição da API.

Primeiros passos

Configure o acesso e faça sua primeira chamada.

Autenticação

Entenda tokens Bearer, sessões e renovação de acesso.

Referência da API

Consulte endpoints, parâmetros e respostas.

Seu primeiro request

Autentique o usuário e obtenha um token de acesso.
Envie o token no cabeçalho Authorization.
Informe o workspace solicitado quando a rota exigir esse contexto.
Use o Try It para validar a chamada antes de escrever sua integração.

Authorization: Bearer <seu_token_de_acesso>
Content-Type: application/json

🚧
Tokens de acesso possuem validade limitada. Integrações próprias devem implementar a renovação de sessão conforme descrito em Autenticação.

Comunicação

Conversas
Envie mensagens, consulte históricos e acompanhe interações em diferentes canais.

Telefones do WhatsApp Business
Configure números, perfis comerciais e conexões com provedores.

Campanhas do WhatsApp
Crie campanhas, selecione destinatários e acompanhe o processamento dos envios.

Modelos de WhatsApp
Gerencie modelos, idiomas, parâmetros e estados de aprovação.

Voz e telefonia

Ramais
Gerencie dispositivos, credenciais e disponibilidade dos ramais.

Troncos SIP
Configure conectividade SIP para chamadas de entrada e saída.

Campanhas de voz
Automatize operações de discagem e acompanhe cada chamada da campanha.

Gravações de chamadas
Consulte e recupere gravações vinculadas às chamadas processadas.

CRM e atendimento

Oportunidades
Crie, consulte e mova oportunidades ao longo da operação comercial.

Funis
Organize processos comerciais e fluxos de atendimento.

Etapas
Controle as etapas disponíveis e a progressão dos registros.

Caixas de atendimento
Gerencie filas, responsáveis e sessões de atendimento.

Automação e IA

Copiloto de fluxos
Crie e evolua automações por meio de instruções em linguagem natural.

Análises
Consulte qualificações, sentimentos, interesses e resultados das interações.

Estúdio de voz
Gere e gerencie recursos de voz utilizados nas automações.

Conta e consumo

Workspaces
Gerencie os ambientes, membros e recursos da organização.

Saldo
Consulte créditos, movimentações e disponibilidade financeira.

Faturas
Acompanhe cobranças e documentos financeiros.

Cobrança de chamadas
Consulte registros de consumo associados à telefonia.

Pronto para começar?

Abra os Primeiros passos, escolha uma operação GET sem parâmetros obrigatórios e execute sua primeira chamada pelo Try It.