Conecte o atendimento aos seus sistemas.
Leve a jornada de voz para o seu BI, consulte o histórico de chamadas e conecte o seu agente de IA à operação. Documentação em português, exemplos HTTP e escopos de acesso por recurso.
- Autenticação por chave
- Paginação por cursor
- Webhooks para agentes
Uma integração para cada necessidade
Jornada e histórico de chamadas
Consulte sessões na URA, etapas percorridas e trechos de atendimento. Relacione a passagem pelo robô com a fila e o atendente.
Ver endpoints e camposDados para o seu BI
Leia cadastros, desfechos, tempos e referências de gravação com paginação por cursor. Monte a extração no seu sistema de dados.
Planejar a extraçãoSeu agente externo na conversa
Receba mensagens por webhook e devolva ações para responder, transferir para uma fila humana ou encerrar o atendimento.
Integrar o agente
Do início da ligação ao desfecho
Cruze a sessão de URA com os trechos de fila e atendimento. Os identificadores permitem acompanhar transferências sem contar cada trecho como uma nova ligação.
O que consultar
- Sessões de URA, etapas percorridas e falas disponíveis.
- Chamadas recebidas e feitas, com fila, atendente, duração e tabulação quando registradas.
- Gravações disponíveis e links com expiração.
- Cadastros de fluxos, filas, campanhas, números, agentes, tabulações e motivos de pausa.
Como consumir
As consultas por período aceitam janelas de até 31 dias. Percorra as páginas e reconsulte registros recentes para incorporar o encerramento, a gravação e o desfecho quando estiverem disponíveis.
Confira a versão instalada em seu ambiente e os escopos concedidos à chave antes de configurar a extração.
Ver filtros, paginação e limitesComece pelas sessões da URA
Defina a origem do seu ambiente e uma chave com ivr:read. Os exemplos usam o contrato da API de Integração, sem SDK obrigatório.
# IF_BASE_URL: origem HTTPS do seu ambiente, sem barra final.
# IF_API_KEY: chave com o escopo ivr:read.
curl --get "$IF_BASE_URL/api/v1/integracao/v1/ura/sessoes" \
-H "X-API-Key: $IF_API_KEY" \
--data-urlencode "inicio=2026-10-01T00:00:00-03:00" \
--data-urlencode "fim=2026-10-02T00:00:00-03:00" \
--data-urlencode "limite=100"Do acesso ao primeiro atendimento
Autenticação e escopos
Crie a chave e escolha as permissões do seu consumidor.
Referência da API
Consulte endpoints, filtros, erros e o OpenAPI do ambiente.
Agentes externos
Implemente webhook, respostas e transferência para humano.
Salesforce
Configure softphone, vínculo dos atendentes e registro de chamadas.
Consulte também os guias de webhooks e de configuração do canal WhatsApp.
Perguntas sobre a API
Qual sistema você quer conectar?
Traga seu caso de uso: dados para BI, integração com CRM ou um agente de IA que precisa trabalhar com sua equipe.