SGP conversando com a sua IA
Clientes, contratos, faturas e 2ª via, Pix, liberação por confiança, status de conexão, sessões PPPoE, ONU/FTTH, Wi-Fi, chamados, O.S. e manutenções do SGP.
- Ferramentas
- 30
- Consultas
- 18
- Alterações
- 12
- Ativação individual
- 5
Integração em beta
Desenvolvida a partir da documentação oficial da API do SGP 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 SGP
A configuração é feita uma vez, pelo administrador da empresa, no painel do Provia. Nada é instalado no seu servidor.
O que você vai precisar
- URL do SGPObrigatório
- Endereço raiz do seu SGP, o mesmo usado para entrar no sistema, sem /api no final. Também aceita domínio próprio ou http://IP:porta em instalações locais. Prefira HTTPS: em http:// o token trafega sem criptografia.
- TokenObrigatório
- Gerado no SGP em Administração > Integrações > Tokens > Adicionar Token (em versões antigas: Sistema > Ferramentas > Painel Admin > Tokens). Marque "Ativo" e "Mapear Usuário".
- Nome do appObrigatório
- O nome do "App" informado ao criar o token, exatamente como cadastrado no SGP.
- Usuário do SGPOpcional
- Usuário exclusivo do SGP (Sistema > Usuários) para autenticação Basic. Quando informado, as consultas do tipo GET usam esse usuário em vez de colocar o token na URL, e o teste de conexão mostra a versão do SGP. Use um usuário com permissões mínimas.
- Senha do usuário do SGPOpcional
- Senha do usuário acima. Preencha os dois campos ou deixe os dois em branco.
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 um token exclusivo para o Provia em Administração > Integrações > Tokens, com um app próprio (por exemplo "provia"): assim você revoga o acesso sem afetar outras integrações.
- No token, marque "Ativo" e "Mapear Usuário" vinculando um usuário exclusivo com permissões mínimas. Ordens de serviço, FTTH e suporte só funcionam com token mapeado a um usuário.
- Deixe desmarcados "Permite Baixar Título" e "Permite Cancelar Título": o Provia não liquida, não estorna e não cancela títulos.
- Se o seu SGP só aceita IPs liberados ("Hosts/Rotas permitidas" ou firewall), fale com o suporte do Provia antes de ativar: o IP de saída ainda não é fixo.
- Instalações locais precisam estar acessíveis pela internet nas portas 80, 443, 8080 ou 8443; outras portas podem ser liberadas pela equipe do Provia (fale com o suporte). Prefira HTTPS.
- As ferramentas de escrita (chamados, liberação por confiança, Pix, envio de fatura, O.S., anotações) começam desligadas. A alteração do Wi-Fi do roteador e as administrativas (desconectar PPPoE, alterar status de contrato, pré-cadastro e manutenções) precisam, além disso, ser ativadas uma a uma pelo administrador.
Ferramentas
As 30 ferramentas do SGP
18 de consulta e 12 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
3 ferramentas
Buscar cliente e contratos
buscar_clienteConsultaBusca no SGP os CONTRATOS de um cliente por CPF/CNPJ, ID do contrato, nome, login PPPoE, e-mail de login, telefone, MAC ou serial da ONU. Retorna, por contrato: contratoId, clienteId, nome, status (contratoStatus/contratoStatusDisplay), plano, login do serviço (servico_login), valor em aberto, títulos a receber, promessas no mês, POP, endereço, telefones e e-mails. É o ponto de partida: contratoId e clienteId são usados pelas demais ferramentas. Um cliente sem contrato não é encontrado. Senhas (central, PPPoE, Wi-Fi) são sempre ocultadas.
Listar clientes (relatório)
listar_clientesConsultaLista clientes do SGP com paginação (até 100 por página) e filtros para relatórios: status do contrato, POP, plano, CTO/porta, tipo de serviço, datas de cadastro/alteração e situação dos títulos. Cada cliente traz contratos[] (campo contrato = ID do contrato) com servicos[] (campo id = ID do serviço, usado em consultar_wifi e alterar_wifi), plano, login, ONU, sinal e conexão. Para achar um cliente específico prefira buscar_cliente. Senhas são sempre ocultadas.
Registrar anotação interna no cliente
registrar_anotacao_clienteAltera dadosPrévia e confirmaçãoAltera dados no SGP: adiciona uma anotação interna ao cadastro de um cliente (opcionalmente vinculada a um contrato), por exemplo o resumo de um atendimento. A anotação fica visível para a equipe do provedor e, conforme alerta_modo, aparece como pop-up nas telas do SGP. O cliente_id vem de buscar_cliente (clienteId).
Contratos e planos
3 ferramentas
Listar ou pesquisar contratos
listar_contratosConsultaPesquisa contratos por cliente (cliente_id, nome, CPF/CNPJ ou login do serviço) ou lista contratos por status (1 Ativo, 4 Suspenso, 7 Ativo com velocidade reduzida), plano, tipo de pessoa e datas de cadastro/alteração. Na pesquisa por cliente, cada item traz contrato_id, cliente_id, status, plano, login do serviço, POP e endereço. A lista do SGP não é paginada: o Provia devolve páginas com offset/limit. Senhas são sempre ocultadas.
Listar planos
listar_planosConsultaLista os planos de serviço do provedor no SGP com ID, descrição, preço e quantidade de serviços ativos, opcionalmente só os de um POP. O ID do plano é usado em listar_clientes, listar_contratos e registrar_pre_cadastro.
Alterar status do contrato
alterar_status_contratoAltera dadosPrévia e confirmaçãoAtivação individualAltera o contrato do cliente no SGP: muda o status (1=Ativo, 2=Inativo, 3=Cancelado, 4=Suspenso, 5=Inviabilidade técnica, 6=Novo, 7=Ativo com velocidade reduzida), o que pode bloquear, liberar ou cancelar o serviço e afetar a cobrança. O motivo vem de listar_referencias (motivos_status_contrato). Ferramenta administrativa (opt-in): repita ao usuário o contrato e o novo status.
Financeiro
7 ferramentas
Listar faturas (títulos)
listar_faturasConsultaLista as faturas (títulos) de um cliente ou contrato no SGP, com filtros de situação e datas. Cada título traz id (use em gerar_pix_fatura), numeroDocumento, valor, valorCorrigido, dataVencimento, status, link do boleto, link_cobranca (página de pagamento), linhaDigitavel, codigoBarras e codigoPix. Informe cpfcnpj, contrato (contratoId de buscar_cliente), cliente_id (clienteId) ou titulo_id, ou então um período de datas.
Obter 2ª via atualizada
obter_segunda_viaConsultaObtém a 2ª via das faturas de um contrato ou CPF/CNPJ: a primeira fatura em aberto e todas as vencidas, com valor atualizado (juros/multa), vencimento, linha digitável e link do boleto (links[].fatura é o ID do título, usado em gerar_pix_fatura). Somente consulta: o Provia sempre pede ao SGP para NÃO abrir ocorrência/O.S. nesta chamada (para registrar o atendimento use abrir_chamado). Não funciona para contratos com cobrança unificada.
Listar promessas de pagamento
listar_promessas_pagamentoConsultaLista as promessas de pagamento (liberações por confiança) de um cliente ou contrato: data de cadastro, data prometida, usuário, se é acordo e situação (ativa, cumprida...). Use antes de liberar_por_confianca para saber se o cliente já usou o benefício. Atenção: neste endpoint o SGP responde status 0 mesmo quando encontra promessas; considere o campo promessas.
Contratos sem fatura no mês
listar_contratos_sem_faturaConsultaAuditoria de faturamento: lista os contratos ativos que não têm fatura gerada no mês informado, com cliente, ID do contrato (clientecontrato_id), status, POP, dia de vencimento e portador.
Liberar por confiança (promessa de pagamento)
liberar_por_confiancaAltera dadosPrévia e confirmaçãoAltera dados no SGP: registra uma promessa de pagamento e desbloqueia temporariamente um contrato suspenso ou com velocidade reduzida (liberação por confiança). O SGP aplica as regras do provedor (limite de títulos atrasados, quantidade de promessas no mês, dias liberados) e registra uma ocorrência; se recusar, o motivo vem em mensagem. Por padrão o cliente NÃO é avisado por SMS/WhatsApp. Consulte listar_promessas_pagamento antes. Nunca repita após erro de tempo esgotado sem conferir.
Gerar ou obter o Pix de uma fatura
gerar_pix_faturaAltera dadosPrévia e confirmaçãoAltera dados no SGP: obtém o código Pix "copia e cola" de uma fatura e, se ela ainda não tiver um Pix válido, pede ao SGP que gere um junto ao banco/PSP (pode criar uma cobrança Pix). O titulo_id vem de listar_faturas (id) ou de obter_segunda_via (links[].fatura); o contrato é o contratoId.
Enviar fatura ao cliente
enviar_faturaAltera dadosPrévia e confirmaçãoEnvia mensagem ao cliente: pede ao SGP que envie as faturas em aberto/vencidas do contrato por e-mail ou SMS/WhatsApp, sempre para os contatos já cadastrados no contrato. O SGP também abre uma ocorrência "Envio de Fatura via URA". Para enviar uma fatura específica informe numero_documento (de listar_faturas). Não é idempotente: cada chamada envia de novo.
Atendimento
2 ferramentas
Listar ocorrências (chamados)
listar_ocorrenciasConsultaLista ocorrências (chamados/tickets) do SGP com as ordens de serviço vinculadas e os comentários. Cada ocorrência traz numero (protocolo), contrato, status, tipo, método, conteúdo, responsável e datas; ordens_servicos[].id é o os_id usado em obter_ordem_servico e alterar_ordem_servico. Use antes de abrir_chamado (status 0 = abertas) para evitar chamado duplicado.
Abrir chamado (ocorrência)
abrir_chamadoAltera dadosPrévia e confirmaçãoAltera dados no SGP: abre uma ocorrência (chamado) para o contrato e, por padrão, uma ordem de serviço vinculada. Retorna o protocolo. Antes, use listar_ocorrencias com o contrato e status 0 para não duplicar um chamado aberto. Tipos, motivos, setores, métodos, técnicos e classificações são IDs do cadastro do provedor (listar_referencias); sem ocorrencia_tipo o SGP usa o tipo padrão. Não é idempotente: nunca repita após erro de tempo esgotado sem conferir em listar_ocorrencias.
Ordens de serviço
4 ferramentas
Listar ordens de serviço
listar_ordens_servicoConsultaLista ordens de serviço (O.S.) do SGP. Modo filtros (padrão): por O.S., contrato, status, motivos, POPs e datas, com paginação. Modo agenda: informe agenda_de e agenda_ate (data e hora) para a agenda técnica do período, opcionalmente por POP, contrato ou cliente; traz endereço, plano, login e situação da conexão. O id (ou os_id na agenda) é usado em obter_ordem_servico, alterar_ordem_servico e registrar_comentario_ordem_servico. Senhas são sempre ocultadas.
Detalhar ordem de serviço
obter_ordem_servicoConsultaDetalha uma ordem de serviço do SGP: cliente, contato, endereço e coordenadas, plano, login e situação da conexão, status, motivo, prioridade, técnico, datas, conteúdo, observação e serviço prestado; opcionalmente as anotações internas da O.S., os comentários da ocorrência e o checklist. O os_id vem de listar_ordens_servico ou listar_ocorrencias (ordens_servicos[].id). Requer token mapeado a um usuário no SGP. Senhas são sempre ocultadas.
Alterar ordem de serviço
alterar_ordem_servicoAltera dadosPrévia e confirmaçãoAltera dados no SGP: atualiza uma ordem de serviço: status (encerrar, pendente, em execução), serviço prestado, observação, técnico responsável, classificações e data de finalização. servico_prestado e observacao SUBSTITUEM o texto atual (para acrescentar um registro use registrar_comentario_ordem_servico). Encerrar (status 1) pode disparar avisos e cobranças configurados no provedor. O os_id vem de listar_ordens_servico.
Registrar comentário na O.S.
registrar_comentario_ordem_servicoAltera dadosPrévia e confirmaçãoAltera dados no SGP: acrescenta um registro a uma ordem de serviço, sem apagar nada: destino "os" grava uma anotação interna da O.S.; destino "ocorrencia" grava um comentário na ocorrência vinculada. O os_id vem de listar_ordens_servico ou listar_ocorrencias.
Rede e conexão
8 ferramentas
Consultar status da conexão
consultar_status_conexaoConsultaVerifica no SGP se a internet de um contrato está online, offline ou em manutenção. Informe o contrato (contratoId de buscar_cliente) ou um telefone do cliente. O campo situacao resume o resultado (online, offline, manutencao, nao_verificado). Observação: se o serviço estiver em manutenção, o próprio SGP pode registrar uma ocorrência automaticamente; o Provia nunca pede a abertura de protocolo nesta consulta.
Listar sessões PPPoE/RADIUS
listar_sessoes_radiusConsultaLista sessões RADIUS/PPPoE (radacct) com dados do cliente: se está online, IP, NAS, horários de conexão e desconexão, causa da desconexão (acctterminatecause), MAC e tráfego. Filtre pelo login PPPoE (servico_login de buscar_cliente), IP, MAC, porta do NAS, online/offline, última sessão ou período de tráfego; o CPF/CNPJ só pode ser usado junto com outro filtro. A senha PPPoE é sempre ocultada.
Consultar ONU (diagnóstico FTTH)
consultar_onuConsultaDiagnóstico FTTH: localiza a(s) ONU(s) de um contrato, login, serial, cliente ou serviço e traz OLT, slot, PON, posição, modelo, modo, VLAN, sinal óptico (RX/TX) e se está conectada; com uma única ONU também traz CTO e porta. consulta_ao_vivo=true consulta a OLT em tempo real (lento: até ~50 s, pode falhar). O campo service_id/servico das ONUs é o ID do serviço usado em consultar_wifi e alterar_wifi. Requer token mapeado a um usuário no SGP. Senhas são ocultadas.
Consultar Wi-Fi do roteador
consultar_wifiConsultaLê, pelo gerenciador de CPE (TR-069) do SGP, a configuração do roteador do cliente: nome das redes (SSID) 2,4 GHz e 5 GHz, canal, se estão ligadas, modelo, versão, IP WAN e dispositivos conectados. As senhas Wi-Fi e PPPoE são sempre ocultadas. Se o contrato tiver mais de um serviço, informe servico_id (id em contratos[].servicos[] de listar_clientes ou service_id de consultar_onu). Se o serviço não tiver gerenciador de CPE, o SGP informa em mensagem.
Listar manutenções (massivas)
listar_manutencoesConsultaLista as manutenções/massivas cadastradas no SGP com período, severidade, status, mensagens para a Central e a URA e os elementos afetados (POPs, NAS, APs, fontes, switches, OLTs, PONs, CTOs). Use para explicar uma queda que afeta vários clientes. Por padrão mostra só as ativas.
Alterar Wi-Fi do roteador
alterar_wifiAltera dadosPrévia e confirmaçãoAtivação individualAltera o roteador do cliente pelo gerenciador de CPE do SGP: liga/desliga a rede Wi-Fi e muda o nome (SSID) e/ou a senha das redes 2,4 GHz e 5 GHz. Os dispositivos do cliente podem ser desconectados e precisarão da nova senha. Só os campos informados são enviados (nada é apagado). Exige o servico_id (id em contratos[].servicos[] de listar_clientes ou service_id de consultar_onu) para não alterar o roteador errado. Ferramenta opt-in: aparece só depois que o administrador a habilita na conexão.
Desconectar sessão PPPoE
desconectar_sessao_pppoeAltera dadosPrévia e confirmaçãoAtivação individualDerruba a conexão do cliente: força a desconexão da sessão PPPoE (RADIUS CoA/PoD) do login informado. O roteador do cliente reconecta em seguida; use depois de mudanças de plano, MAC ou bloqueio. O login vem de buscar_cliente (servico_login) ou listar_sessoes_radius. Ferramenta administrativa (opt-in).
Registrar ou alterar manutenção (massiva)
registrar_manutencaoAltera dadosPrévia e confirmaçãoAtivação individualAltera dados no SGP: cadastra uma manutenção/massiva (sem manutencao_id) ou altera uma existente (com manutencao_id de listar_manutencoes). A manutenção aparece para os clientes afetados na Central do Assinante e na URA e influencia consultar_status_conexao. O Provia nunca liga o envio de SMS: ao cadastrar, o SMS fica desligado; ao alterar, a configuração de SMS que já existe na manutenção é mantida. IDs dos elementos afetados vêm de listar_referencias. Ferramenta administrativa (opt-in).
Cadastros auxiliares
1 ferramenta
Listar tabelas de referência (IDs)
listar_referenciasConsultaLista as tabelas de cadastro do provedor no SGP, que fornecem os IDs usados pelas outras ferramentas: pops, tecnicos (id e username), tipos_ocorrencia, motivos_os, setores, metodos_ocorrencia, classificacoes, portadores, motivos_status_contrato, vencimentos, vendedores, empresas, pontos_recebimento, nas, aps, fontes, switches, olts, pons (exige olt_id), ctos e feriados. Esses IDs mudam de um provedor para outro: consulte aqui em vez de supor valores.
CRM e leads
2 ferramentas
Consultar viabilidade de instalação
consultar_viabilidadeConsultaConsulta no SGP se há cobertura (viabilidade técnica) para instalar internet num endereço: por CEP, logradouro (opcionalmente com faixa de números), bairro ou cidade; ou por coordenada (latitude,longitude) e raio usando um gateway de mapas cadastrado no SGP (gateway_id). Retorna viabilidade true/false e os dados devolvidos pelo SGP.
Registrar pré-cadastro (lead)
registrar_pre_cadastroAltera dadosPrévia e confirmaçãoAtivação individualAltera dados no SGP: registra um pré-cadastro (lead de venda) de pessoa física (F) ou jurídica (J) com endereço, contatos, plano, vencimento, vendedor e POP de interesse. Não cria cliente nem contrato definitivo: a efetivação continua sendo feita pela equipe no SGP. IDs de plano, vencimento, vendedor e POP vêm de listar_planos e listar_referencias. Ferramenta administrativa (opt-in): revise os dados com o usuário.
Outras integrações
Conecte o SGP à IA da sua equipe
Teste grátis por 7 dias. Configure em minutos, sem instalar nada e sem mudar a rotina da equipe.