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" }
}
}'
// Liga para o cliente a partir do seu CRMconst res = awaitfetch(
"https://suaempresa.callix.com.br/api/v1/click_to_call",
{
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CALLIX_TOKEN}`,
"Content-Type": "application/vnd.api+json",
},
body: JSON.stringify({
data: {
type: "click_to_call",
attributes: { user_id: "1", phone: "11987654321" },
},
}),
}
);
# Liga para o cliente a partir do seu CRMimport os, requests
requests.post(
"https://suaempresa.callix.com.br/api/v1/click_to_call",
headers={
"Authorization": f"Bearer {os.environ['CALLIX_TOKEN']}",
"Content-Type": "application/vnd.api+json",
},
json={"data": {
"type": "click_to_call",
"attributes": {"user_id": "1", "phone": "11987654321"},
}},
)
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
Uma API previsível, baseada na especificação aberta JSON:API, com URL exclusiva para cada conta.
1
Gere seu token de acesso
Na plataforma, acesse Configurações › APIs e crie o token que autentica suas requisições.
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
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.
Voz e chamadas
Click to Call/click_to_call
Chamadas efetuadas e recebidas/outgoing_completed_calls
Chamadas de campanha/campaign_completed_calls
Transcrições de chamada?include=transcriptions
Resumos do receptivo e ativo/call_summaries
Filas e URAs/call_queues · /ivrs
WhatsApp e SMS
Click to Chat/click_to_chat
Campanhas de WhatsApp/chat_campaigns
Templates de WhatsApp/chat_outbound_templates
Números e filas de WhatsApp/chat_inbound_numbers
Relatório de chats e mensagens/chat_reports · /messages
Click to SMS/click_to_sms
Campanhas e contatos
Campanhas/campaigns
Listas de campanha/campaign_lists
Contatos (síncrono e assíncrono)/campaign_contacts_async
Funil de completamento/campaign_call_funnel
Números bloqueados para discagem/outbound_blacklists
Clientes, callbacks e rechamadas/customers · /callbacks
Gestão da operação
Usuários e equipes/users · /teams
Pausas e qualificações/breaks · /qualifications
Performance dos agentes/user_performance_reports
Status dos agentes/user_service_status_change_reports
Fluxos de automação/workflows
Subcontas e logs do API Proxy/sub_accounts · /api_proxy_logs
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 daquiconst callix = newCallixServerSdk(
dominio,
process.env.CALLIX_API_KEY
);
const sessao = await callix
.createUserSessionForClientSdk(loginDoAgente);
// Devolve para a tela apenas o token de sessãoreturn { userSessionToken: sessao.userSessionToken };
// Na tela: ligue o SDK uma vez
<CallixClientProvider domain={dominio} userSessionToken={token}>
<TelaDeAtendimento />
</CallixClientProvider>
// Em qualquer componente: leia o estado e comandeconst estado = useCallOperatorState();
const { makeManualCall } = useCallOperatorControls();
const info = useCallOperatorCurrentCallInfo();
if (info?.type === 'campaign')
return <FichaDoCliente contato={info.info.campaignContact} />;
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