Abre em uma nova aba
Callix para desenvolvedores

Construa em cima da Callix

Voz, WhatsApp e SMS dentro do seu sistema. Uma API REST para automatizar campanhas, disparar chamadas e mensagens e extrair cada dado da operação. Um SDK para colocar o telefone da Callix direto na tela onde o seu time já trabalha.

Os exemplos são interativos: configure seu subdomínio e token e teste as requisições direto na documentação.
# Liga para o cliente a partir do seu CRM
curl -X POST 
  https://suaempresa.callix.com.br/api/v1/click_to_call 
  -H "Authorization: Bearer $CALLIX_TOKEN" 
  -H "Content-Type: application/vnd.api+json" 
  -d '{
    "data": {
      "type": "click_to_call",
      "attributes": { "user_id": "1", "phone": "11987654321" }
    }
  }'
Resposta 200 OK
{
  "click_to_call_id": "654ab628-d964-4dc4-9beb-5defafe82d38",
  "message": "Call successfully sent"
}
40+ recursosna API REST
3 canaisvoz, WhatsApp e SMS
JSON:APIpadrão aberto, previsível
Voz no navegadorvia WebRTC, direto no seu sistema
Duas formas de integrar

Automatize a operação ou embarque o telefone

Use a API para conversar com a plataforma de servidor para servidor. Use o SDK quando o agente precisa operar dentro do seu sistema. Os dois se complementam.

Servidor para servidor · JSON:API

API REST

Acesso programático a campanhas, contatos, chamadas, WhatsApp, SMS, usuários e relatórios. Ideal para CRMs, ERPs, BI e automações.

  • Disparar chamadas, conversas de WhatsApp e SMS
  • Importar contatos e alimentar campanhas
  • Extrair chamadas, transcrições e indicadores
  • Filtros, paginação, ordenação e inclusão de relacionamentos
Navegador do agente · WebRTC · npm

SDK de telefonia

O softphone da Callix como biblioteca. O agente atende, disca, pausa e qualifica dentro da sua aplicação, e o áudio trafega pelo próprio navegador.

  • Voz de entrada e saída direto no navegador, sem softphone, plugin ou VPN
  • Estado do operador em tempo real
  • Contexto da campanha e do contato na chamada ativa
  • Pacote para React com 17 hooks, núcleo agnóstico de framework
Casos de uso

O que você pode construir

Cada caso tem um guia passo a passo com exemplos em várias linguagens e requisições que você executa na própria página.

API

Ligue com um clique do seu CRM

Um botão na ficha do cliente e a Callix conecta o agente ao número de destino. Sem copiar e colar telefone.

POST /api/v1/click_to_call
Guia Click to Call
API

Inicie conversas no WhatsApp

Envie um template aprovado com variáveis e direcione o atendimento para uma fila, um fluxo ou um agente específico.

POST /api/v1/click_to_chat
Guia Click to Chat
API

Envie SMS transacionais

Confirmações, lembretes e avisos disparados pelo seu sistema, com rastreio no relatório de SMS enviados.

POST /api/v1/click_to_sms
Guia Click to SMS
API

Alimente campanhas automaticamente

Envie leads do seu CRM ou formulário direto para listas de campanha, inclusive em lote com importação assíncrona.

POST /api/v1/campaign_contacts_async
Guia Importar contatos
API

Leve os resultados para o seu BI

Chamadas completadas e com falha, qualificações, funil de completamento e transcrições, prontos para seu data warehouse.

GET /api/v1/campaign_completed_calls
Guia Ler dados
API

Mantenha a discagem em conformidade

Sincronize opt-outs e listas de “não me perturbe” do seu sistema com as listas de números bloqueados da Callix.

POST /api/v1/outbound_blacklisted_phones
Guia Bloquear números
API

Sincronize a configuração da operação

Consulte filas, pausas, qualificações e templates de WhatsApp para montar telas e regras no seu sistema.

GET /api/v1/qualifications
Guias de consulta
API

Gerencie equipes e usuários

Crie e atualize agentes e equipes a partir do seu RH ou diretório, e acompanhe a performance de cada um.

GET /api/v1/teams
Guia Gerenciar equipes
SDK

Coloque o telefone dentro do seu sistema

Uma tela só: o agente recebe a chamada da campanha com a ficha do cliente já aberta e registra o desfecho uma única vez.

npm @callixbrasil/client-sdk
SDK Playground

Vai integrar opt-outs e a lista do Não Me Perturbe? Veja o que a Callix aplica na discagem e o que fica com a sua empresa →

Primeiros passos

Da chave de API à primeira requisição em minutos

Uma API previsível, baseada na especificação aberta JSON:API, com URL exclusiva para cada conta.

  1. 1

    Gere seu token de acesso

    Na plataforma, acesse Configurações › APIs e crie o token que autentica suas requisições.

  2. 2

    Aponte para o seu domínio

    Todas as rotas partem de https://{sua-empresa}.callix.com.br/api/v1, com o cabeçalho Content-Type: application/vnd.api+json.

  3. 3

    Autentique e chame

    Envie Authorization: Bearer {token} e consuma recursos como /users, /campaigns ou /click_to_call.

Consulta com filtros
# Chamadas de campanha com falha, só o nome da campanha,
# mais recentes primeiro, 5.000 por página
curl -G https://suaempresa.callix.com.br/api/v1/campaign_missed_calls 
  -H "Authorization: Bearer $CALLIX_TOKEN" 
  -H "Content-Type: application/vnd.api+json" 
  --data-urlencode "filter[failure-cause]=7" 
  --data-urlencode "fields[campaign]=name" 
  --data-urlencode "sort=-started_at" 
  --data-urlencode "page[limit]=5000"
filterFiltros próprios de cada rota, incluindo intervalos de data
includeTraz entidades relacionadas na mesma resposta
fieldsRetorna só os atributos que você precisa
pagelimit até 5.000 e offset
sortAscendente ou descendente com -

Boas práticas: datas em ISO-8601 (UTC), limite padrão de 10 requisições por minuto por rota (algumas rotas têm limites próprios) e tratamento do código 429 com nova tentativa.

Catálogo da API

Tudo o que a plataforma faz, acessível por código

Uma amostra dos recursos disponíveis. A referência completa traz atributos, filtros, relacionamentos e códigos de erro de cada um.

Quer ver como esses recursos funcionam na prática? Abra os exemplos de uso →

SDK Callix

O telefone da Callix, na sua interface

Sem SDK, o agente é a integração: dois logins, número copiado de uma tela para a outra e o mesmo atendimento registrado duas vezes. Com o SDK, é uma tela só, e você decide o que aparece durante a chamada.

@callixbrasil/server-sdkSeu backend

Troca a chave de API por um token de sessão do agente. A chave nunca chega ao navegador.

@callixbrasil/client-sdkNavegador

Softphone WebRTC e máquina de estados do operador. Funciona com Angular, Vue, Svelte ou JavaScript puro.

@callixbrasil/client-sdk-reactOpcional

Provider e 17 hooks para quem usa React, o caminho mais curto para integrar.

// Roda no seu backend: a chave nunca sai daqui
const callix = new CallixServerSdk(
  dominio,
  process.env.CALLIX_API_KEY
);

const sessao = await callix
  .createUserSessionForClientSdk(loginDoAgente);

// Devolve para a tela apenas o token de sessão
return { userSessionToken: sessao.userSessionToken };
Estados do operador
startingidleonBreakofflinecallRingingcallInProgressafterCallmanualCallRinging
1 · Servidor

Crie a sessão do agente

Seu backend usa a chave de API para emitir um token de sessão descartável.

2 · Navegador

Registre o softphone

Com o token, o SDK conecta o agente à telefonia da Callix por WebRTC, via HTTPS.

3 · Interface

Reaja ao estado

O SDK empurra o estado do operador e a sua tela é consequência dele: ficha, cronômetro, qualificação.

Pronto para integrar?

Os exemplos de uso e o SDK Playground são abertos a todos. A referência completa da API, com todos os recursos, atributos, filtros e códigos de erro, fica disponível para contas Callix dentro da plataforma.

  • Já é cliente Callix

    Acesse a referência completa e gere seu token em Configurações › APIs › Documentação

    Como autenticar →
  • Sentiu falta de algo?

    Um recurso ou caso de uso que a API ou o SDK ainda não cobrem? Conte para o time de produto.

    produtos@callix.com.br →

Está avaliando a Callix

Converse com um especialista sobre o seu caso de integração e receba acesso a um ambiente para testes.

Website Novo