IXC Provedor conversando com a sua IA
Clientes, contratos, logins PPPoE, sinal da ONU, faturas, 2ª via e Pix, desbloqueio de confiança, atendimentos e O.S. do IXC Provedor.
- Ferramentas
- 28
- Consultas
- 19
- Alterações
- 9
- Ativação individual
- 5
Integração em beta
Desenvolvida a partir da documentação oficial da API do IXC Provedor e testada em ambiente simulado, ainda está sendo validada com instalações reais. Você usa normalmente, pelo mesmo preço. Se algo não funcionar como esperado, conte para a gente.
Antes de conectar
Como preparar o seu IXC Provedor
A configuração é feita uma vez, pelo administrador da empresa, no painel do Provia. Nada é instalado no seu servidor.
O que você vai precisar
- Endereço do IXC ProvedorObrigatório
- Endereço que você usa para abrir o IXC no navegador (o Provia completa /webservice/v1). Se o IXC estiver em um subdiretório, cole a URL até /webservice/v1. O servidor precisa estar acessível pela internet nas portas 443, 80, 8080 ou 8443 (outras portas podem ser liberadas pela equipe do Provia: fale com o suporte), com certificado HTTPS válido.
- ID do usuário da APIOpcional
- Código (ID) do usuário do IXC com "Permite acesso ao webservice" marcado (Configurações >> Usuários). Pode ficar vazio se você colar o token completo no formato ID:token.
- Token de acesso da APIObrigatório
- Exibido no cadastro do usuário após salvar com "Permite acesso ao webservice". Ele muda se o e-mail ou a senha desse usuário mudarem, ou após migração do servidor do IXC.
Os tokens ficam guardados com criptografia e nunca são mostrados de volta, nem para a sua equipe, nem para a IA.
Checklist de configuração
- Crie no IXC um grupo de usuários exclusivo para o Provia (Configurações >> Usuários >> Grupo de usuários) só com as permissões necessárias: leitura de clientes, contratos, logins, financeiro, atendimentos e O.S.; inclua os botões e inclusões apenas se for usar as ferramentas de escrita.
- Crie um usuário exclusivo nesse grupo, marque "Permite acesso ao webservice", salve e copie o "Token de acesso". O IXC registra as ações em nome desse usuário; o Provia registra qual membro da sua equipe usou cada ferramenta.
- Em "Redes permitidas" do grupo, deixe o campo vazio: o Provia ainda não tem IP de saída fixo (o IXC responde "Seu IP não está liberado" quando o IP não está na lista).
- Na aba Parâmetros do usuário, remova os filtros "filtrar setor" e "filtrar funcionário" se for usar atendimentos e O.S.; caso contrário as listas podem vir incompletas.
- Se uma ferramenta responder "Recurso ... não está disponível", peça ao suporte da IXC Soft (SUP - API) para liberar a rota no seu servidor.
- As ferramentas de escrita (abrir/responder atendimentos, abrir O.S., enviar boleto, desbloqueio de confiança) começam desligadas: ative a escrita na conexão e libere por membro. Liberação temporária, liberação de redução, desconexão de login, limpeza de MAC e a consulta avançada precisam, além disso, ser habilitadas uma a uma.
Ferramentas
As 28 ferramentas do IXC Provedor
19 de consulta e 9 de alteração. As de alteração só aparecem para quem tem permissão de escrita, e a escrita começa desligada em cada conexão.
Como ler as etiquetas
- Consulta
- Só lê dados. Aparece para quem tem acesso de leitura ou de escrita à conexão.
- Altera dados
- Só aparece para quem tem permissão de escrita, e a escrita da conexão começa desligada.
- Prévia e confirmação
- A primeira chamada só mostra uma prévia. A alteração só acontece depois da sua confirmação.
- Ativação individual
- Ferramenta de maior risco: fica oculta até o administrador ativá-la individualmente na conexão. As que alteram dados também dependem da escrita ligada.
Clientes
2 ferramentas
Buscar clientes
buscar_clientesConsultaBusca clientes no IXC Provedor por UM critério: CPF/CNPJ, nome (contém), telefone/WhatsApp, e-mail (contém) ou código do cliente. Retorna um resumo de cada cliente (código em `id`, nome/razão social, documento, contatos, endereço, situação). Use o `id` retornado como id_cliente nas demais ferramentas (obter_resumo_cliente, listar_contratos, listar_faturas...).
Resumo completo do cliente
obter_resumo_clienteConsultaVisão 360° de um cliente para atendimento: cadastro completo, contratos (com status de acesso), logins PPPoE/RADIUS (online/offline), faturas em aberto (marcando as vencidas), atendimentos e ordens de serviço em aberto. id_cliente vem de buscar_clientes. Use os ids retornados nas ferramentas específicas (id do contrato, do login, da fatura...). Senhas nunca são exibidas.
Contratos e planos
6 ferramentas
Listar contratos do cliente
listar_contratosConsultaLista os contratos de um cliente do IXC com status do contrato (P=Pré-contrato, A=Ativo, I=Inativo, N=Negativado, D=Desistiu), status de acesso status_internet (A=Ativo, D=Desativado, CM=Bloqueio manual, CA=Bloqueio automático, FA=Financeiro em atraso, AA=Aguardando assinatura), velocidade (N=Normal, R=Reduzida) e regras de desbloqueio de confiança. id_cliente vem de buscar_clientes; o `id` de cada contrato é o id_contrato das demais ferramentas.
Detalhar contrato
obter_contratoConsultaDetalha um contrato do IXC: cadastro completo do contrato, plano de venda (nome e valor), produtos do plano, produtos/descontos próprios do contrato e serviços adicionais. id_contrato vem de listar_contratos ou obter_resumo_cliente.
Listar planos de venda
listar_planosConsultaLista os planos de venda do IXC (nome, tipo e valor do contrato), por padrão só os ativos. Útil para dúvidas de upgrade/preço. O `id` corresponde ao id_vd_contrato dos contratos.
Desbloqueio de confiança
liberar_desbloqueio_confiancaAltera dadosPrévia e confirmaçãoAltera o acesso no IXC: executa o desbloqueio de confiança de um contrato bloqueado por inadimplência (status_internet CA ou FA), liberando a navegação pelo prazo configurado no IXC. Só funciona se o contrato/IXC permitir (campo desbloqueio_confianca diferente de N e sem desbloqueio ativo). A prévia mostra a situação atual do contrato e avisa quando o desbloqueio não se aplica.
Liberação temporária do contrato
liberar_acesso_temporarioAltera dadosPrévia e confirmaçãoAtivação individualAltera o acesso no IXC: libera temporariamente o acesso de um contrato bloqueado (botão "Liberar temporariamente"), conforme a política do provedor. Alternativa ao desbloqueio de confiança. A prévia mostra a situação atual do contrato.
Liberar redução de velocidade
liberar_reducao_velocidadeAltera dadosPrévia e confirmaçãoAtivação individualAltera o serviço no IXC: remove a redução de velocidade aplicada a um contrato (status_velocidade R = Reduzida volta ao normal). A prévia mostra a situação atual do contrato e avisa quando a velocidade não está reduzida.
Financeiro
5 ferramentas
Listar faturas (contas a receber)
listar_faturasConsultaLista as faturas/títulos a receber do IXC de um cliente ou contrato, por situação: abertas (inclui parciais), vencidas, pagas, canceladas ou todas, com filtro opcional por vencimento (DD/MM/AAAA). Mostra valores, vencimento, status (A=a receber, R=recebido, P=parcial, C=cancelado), linha digitável, link de pagamento (gateway_link) e se está vencida. O `id` é o id_fatura de obter_boleto, obter_pix_fatura, baixar_boleto_pdf e enviar_boleto.
Dados do boleto (2ª via)
obter_boletoConsultaRetorna os dados do boleto de uma fatura para 2ª via (linha digitável, nosso número, valores e vencimento) sem alterar nada: não recalcula juros/multa nem atualiza o boleto. Funciona para faturas do tipo Boleto; para gateway/Pix use obter_pix_fatura ou o gateway_link de listar_faturas.
Pix da fatura (copia e cola)
obter_pix_faturaConsultaRetorna o Pix de uma fatura: código "copia e cola" (pixCopiaECola), valor, vencimento, status e validade. Requer gateway Pix configurado no IXC. A imagem do QR Code só vem com incluir_qrcode (é grande); o código copia e cola sempre basta para pagar.
Baixar PDF do boleto
baixar_boleto_pdfConsultaGera o PDF do boleto de uma fatura (sem recalcular nem atualizar) e o devolve em base64 SOMENTE se for pequeno (até ~33 KB); útil em automações que anexam o arquivo. Em conversas, prefira obter_boleto (linha digitável), obter_pix_fatura ou enviar_boleto (e-mail/SMS pelo IXC).
Enviar boleto por e-mail ou SMS
enviar_boletoAltera dadosPrévia e confirmaçãoEnvia uma mensagem ao cliente: pede ao IXC para enviar o boleto de uma fatura por e-mail ou SMS usando o contato cadastrado e a configuração de envio do IXC. Não recalcula nem altera a fatura. Cada execução envia uma nova mensagem. A prévia mostra a fatura e avisa se ela já está paga ou cancelada.
Atendimento
3 ferramentas
Listar atendimentos (tickets)
listar_atendimentosConsultaLista atendimentos (tickets) do IXC por cliente, protocolo, código ou departamento, filtrando por situação (abertos = Novo/Pendente/Em progresso; solucionados; cancelados; todos). su_status: N=Novo, P=Pendente, EP=Em progresso, S=Solucionado, C=Cancelado. Com incluir_mensagens e um único atendimento, traz também as interações. O `id` é o id_atendimento de responder_atendimento e abrir_ordem_servico.
Abrir atendimento (ticket)
abrir_atendimentoAltera dadosPrévia e confirmaçãoCria um atendimento no IXC com um novo protocolo válido (gerar_protocolo_atendimento) e devolve o protocolo e o id. id_cliente vem de buscar_clientes; id_assunto e id_departamento de consultar_cadastros_auxiliares (tipos assuntos e departamentos); id_contrato/id_login são opcionais. Cada execução cria um novo ticket. A prévia mostra o cliente e o ticket que será criado.
Registrar interação no atendimento
responder_atendimentoAltera dadosPrévia e confirmaçãoRegistra uma interação em um atendimento do IXC (mensagem) e define o novo status: em_progresso (padrão), pendente, solucionado (encerra) ou cancelado. id_atendimento vem de listar_atendimentos. A prévia mostra o atendimento atual e avisa se ele já está encerrado.
Ordens de serviço
2 ferramentas
Listar ordens de serviço
listar_ordens_servicoConsultaLista ordens de serviço (O.S.) do IXC por cliente, técnico, setor, atendimento de origem ou protocolo, por situação (abertas = não finalizadas; finalizadas; todas) ou status exato (A=Aberta, AN=Análise, EN=Encaminhada, AS=Assumida, AG=Agendada, DS=Deslocamento, EX=Execução, F=Finalizada, RAG=Aguardando agendamento) e período de abertura (DD/MM/AAAA). Ids de técnico e setor vêm de consultar_cadastros_auxiliares.
Abrir ordem de serviço
abrir_ordem_servicoAltera dadosPrévia e confirmaçãoCria uma ordem de serviço (visita técnica) no IXC com novo protocolo, vinculada ao cliente e, opcionalmente, ao login, contrato e atendimento de origem. id_cliente vem de buscar_clientes; id_assunto e id_setor de consultar_cadastros_auxiliares (assuntos com finalidade OS/AM e setores; o assunto informa se login/contrato são obrigatórios). A filial padrão é a do cliente. Cada execução cria uma nova O.S. A prévia mostra o cliente e a O.S. que será criada.
Rede e conexão
7 ferramentas
Listar logins PPPoE/RADIUS
listar_loginsConsultaLista os logins de acesso (PPPoE/RADIUS/hotspot) do IXC por UM critério: cliente, contrato, login exato, MAC ou IP. Mostra se está ativo e online (S/N/SS = sem status), IP, MAC, concentrador, última conexão/desconexão e motivo, consumo atual e SSID. Senhas nunca são exibidas. O `id` de cada login é o id_login usado por diagnosticar_conexao, consultar_sinal_onu, desconectar_login e limpar_mac_login.
Diagnosticar conexão do cliente
diagnosticar_conexaoConsultaDiagnóstico de "cliente sem internet/lento" em uma chamada: situação do login (online, IP, última desconexão e motivo), status de acesso e velocidade do contrato (bloqueios), sinal da ONU (fibra) e últimas sessões RADIUS, com dicas objetivas. Informe UM: id_login (de listar_logins/obter_resumo_cliente), login PPPoE ou id_contrato.
Histórico de conexões (RADIUS)
listar_historico_conexoesConsultaLista as sessões RADIUS (radacct) de um login PPPoE ou de um IP: início, fim, duração em segundos, motivo de desconexão, MAC, IPs e concentrador, das mais recentes para as mais antigas. Útil para investigar quedas. Datas no formato DD/MM/AAAA. O login vem de listar_logins.
Sinal da ONU (fibra)
consultar_sinal_onuConsultaMostra os dados de fibra da ONU do cliente: potência RX/TX (dBm), temperatura, voltagem, data da coleta, causa da última queda, distância, OLT/slot/PON. São os valores da ÚLTIMA COLETA do IXC (campo data_sinal), não uma leitura em tempo real. Opcionalmente traz o histórico de potência. Informe UM: id_login (de listar_logins), id_contrato ou o MAC/serial da ONU.
Consultar viabilidade técnica
consultar_viabilidadeConsultaVerifica se há viabilidade técnica (cobertura) para instalação em um endereço OU em uma coordenada. Requer o módulo InMap com "Autoviabilidade" habilitado no IXC. Informe endereço, número, cidade e UF, ou latitude e longitude.
Desconectar login (derrubar sessão)
desconectar_loginAltera dadosPrévia e confirmaçãoAtivação individualAltera a conexão do cliente: derruba a sessão PPPoE/RADIUS do login no concentrador para forçar a reconexão (o "reset" clássico para problemas de navegação). O cliente fica sem internet por alguns segundos. A prévia mostra a sessão atual do login.
Limpar MAC do login
limpar_mac_loginAltera dadosPrévia e confirmaçãoAtivação individualAltera o cadastro do login: remove o MAC vinculado (necessário após troca de roteador/ONU quando o login está preso ao MAC antigo). O próximo equipamento que autenticar grava o novo MAC. A prévia mostra o MAC atual do login.
Cadastros auxiliares
3 ferramentas
Consultar cadastros auxiliares
consultar_cadastros_auxiliaresConsultaRetorna os ids e nomes dos cadastros auxiliares do IXC necessários para abrir atendimentos e O.S.: assuntos, departamentos (de atendimento), setores (de O.S.), técnicos, filiais, canais de atendimento, diagnósticos e respostas padrão. Por padrão só os ativos. Use antes de abrir_atendimento, abrir_ordem_servico e para filtrar listar_ordens_servico.
Testar conexão e permissões
testar_conexaoConsultaTesta a conexão com o IXC (URL, certificado, token, IP liberado) e verifica a quais áreas o usuário da API tem acesso de leitura (clientes, contratos, logins, fibra, financeiro, atendimentos, O.S., planos). Use quando outras ferramentas falharem por permissão ou acesso.
Consulta avançada (somente leitura)
consulta_avancadaConsultaAtivação individualConsulta de leitura para usuários avançados em uma lista fechada de tabelas do IXC, com até 5 filtros combinados por E (o IXC não aceita OU). Operadores: = != > < >= <=, L (contém), NL (não contém), IN/NI (lista separada por vírgulas), BE/NBE (entre valor e valor_final). Datas de calendário em DD/MM/AAAA; data e hora em AAAA-MM-DD HH:MM:SS. Prefira as ferramentas específicas; use `campos` para trazer só as colunas necessárias. Segredos são ocultados e campos de senha/credenciais não podem ser usados em filtros nem na ordenação.
Outras integrações
Conecte o IXC Provedor à IA da sua equipe
Teste grátis por 7 dias. Configure em minutos, sem instalar nada e sem mudar a rotina da equipe.