OLT, Concentradora e WhatsApp

Lista as OLTs cadastradas, com a opção de incluir todas as ONTs de cada uma.

Cada OLT traz id, name, execution_cronogram, ip, brand (V-Solution, Huawei, Fiberhome, ZTE, Ubiquiti, PARKS, NOKIA, Phyhome, C-DATA, Intelbras, Digistar, DATACOM, Cianet) e sync_date. Cada ONT traz, entre outros: slot, pon, ont, interface, nome, desc, mac, ns (serial), rxpower, txpower, oltrx, voltagem, temperatura, distancia, biascurrent, dataconn, reason (motivo da queda), data (data e hora da leitura daquela ONT na última sincronização) e status (código bruto de status da ONT: 0 = rompimento de fibra, 1 = ONT ativa, 2 e 4 = offline). O status calculado usado em status_summary deriva desse código combinado ao nível de sinal (rxpower) frente ao limiar configurado na OLT.

curl -s "https://ravi.seuprovedor.com.br/api/api.php?token=CHAVE&action=olt&operation=search_olt&olt=3&include_onts=true"

{
  "olts": [
    {
      "id": 3,
      "name": "OLT-CENTRO",
      "execution_cronogram": "Run every 5 minutes",
      "ip": "10.0.0.10",
      "brand": "NOKIA",
      "sync_date": "2026-07-03 10:05:02",
      "onts": [
        { "slot": "1", "pon": "2", "ont": "14", "nome": "cliente-joao", "ns": "ALCL:F0AB12CD",
          "rxpower": "-19.8", "txpower": "2.1", "status": "1", "mac": "AA:BB:CC:DD:EE:FF" }
      ]
    }
  ]
}

Erros: No OLTs found, OLT not found.

Busca ONTs de uma OLT por MAC, serial ou posição física. Útil para localizar o cliente a partir do dado que o sistema de gestão tem em mãos.

curl -s "https://ravi.seuprovedor.com.br/api/api.php?token=CHAVE&action=olt&operation=search_ont&olt=3&ns=ALCL:F0AB12CD"

{
  "onts": [
    { "slot": "1", "pon": "2", "ont": "14", "name": "cliente-joao", "description": "Rua A, 123",
      "rx_ont": "-19.8", "tx_ont": "2.1", "rx_olt": "-21.4", "voltage": "3.2", "temperature": "45",
      "distance": "1830", "biascurrent": "9", "status": "1", "sync_date": "2026-07-03 10:05:02", "reason": "" }
  ]
}

Erros: At least one parameter must be provided: 'mac', 'ns', or 'slot', OLT ID or name is required, OLT not found, ONT not found.

Resumo de saúde da OLT: total de ONTs e contagem por status calculado (tabela acima).

curl -s "https://ravi.seuprovedor.com.br/api/api.php?token=CHAVE&action=olt&operation=status_summary&olt=3"

{
  "total_onts": 412,
  "status_counts": {
    "online": 396, "signal-alert": 6, "low-signal": 4,
    "offline": 4, "break": 1, "no-data": 1
  }
}

Erros: OLT ID or name is required, OLT not found.

Consulta a OLT ao vivo, atualiza a lista de ONTs pendentes do sistema e retorna as ONTs aguardando autorização. Primeiro passo do fluxo de provisionamento.

curl -s "https://ravi.seuprovedor.com.br/api/api.php?token=CHAVE&action=olt&operation=unprovisioned&olt=3"

{
  "msg": "Search completed successfully",
  "ONTs": [
    { "pon": "2", "slot": "1", "serial": "ALCL:F0AB99EE" }
  ]
}

Erros: OLT ID is required, OLT not found, Service not available for this OLT model (marca diferente de Nokia) ou msg contendo Error connecting. IP: ... (falha de conexão com a OLT).

Retorna a próxima posição livre em uma PON. Use para descobrir o valor de ont antes de chamar activation.

curl -s "https://ravi.seuprovedor.com.br/api/api.php?token=CHAVE&action=olt&operation=search_position&olt=3&slot=1&pon=2"

{ "msg": "Search completed successfully", "position": 15 }

Erros: Missing required parameter: slot, Missing required parameter: pon, OLT ID is required, OLT not found, Service not available for this OLT model (marca diferente de Nokia) ou msg contendo Error connecting. IP: ... (falha de conexão com a OLT).

Autoriza (ativa) uma ONT na OLT Nokia, executando o modelo de autorização escolhido, e já cadastra a ONT no monitoramento, removendo-a da lista de pendentes.

curl -s -X POST "https://ravi.seuprovedor.com.br/api/api.php" \
  -d "token=CHAVE" -d "action=olt" -d "operation=activation" \
  -d "olt=3" -d "serial_number=ALCLF0AB99EE" -d "model_id=2" \
  -d "slot=1" -d "pon=2" -d "ont=15" -d "vlan=100" \
  -d "description=cliente-maria"

{ "msg": "ONT activated successfully" }

Erros: Missing required parameter: X, OLT ID is required, OLT not found, Model id N not found, Service not available for this OLT model (marca diferente de Nokia) ou msg contendo Error connecting. IP: ... (falha de SSH: confira credenciais e porta na tela da OLT).

Remove a ONT da OLT Nokia e do monitoramento do Ravi.

curl -s -X POST "https://ravi.seuprovedor.com.br/api/api.php" \
  -d "token=CHAVE" -d "action=olt" -d "operation=exclusion" \
  -d "olt=3" -d "slot=1" -d "pon=2" -d "ont=15"

{ "msg": "ONT removed successfully", "log": "..." }

O campo log traz a saída da sessão no equipamento, útil para auditoria. Os erros são os mesmos de activation.

Lista todas as concentradoras ativas. Sem parâmetros extras.

Campos por concentradora: id, nome, ip, marca, tipo, status, status_descricao, ultima_sincronizacao, tempo_sincronizacao, alerta_pppoe_ativo, ping_ativo, dias_offline, cron_ativo, dados_historicos_ativo, alerta_linkdown_ativo, usuarios_online, total_usuarios.

curl -s "https://ravi.seuprovedor.com.br/api/api.php?token=CHAVE&action=concentradora&operation=list"

{
  "success": true,
  "data": [
    { "id": 1, "nome": "BNG-01", "ip": "10.0.0.1", "marca": "Mikrotik", "tipo": "PPPoE",
      "status": 2, "status_descricao": "Normal", "ultima_sincronizacao": "2026-07-03 10:04:00",
      "usuarios_online": 388, "total_usuarios": 512 }
  ]
}

Detalha uma concentradora: tudo do list mais a configuração SNMP (herdar_pai, snmp, versao_snmp, porta_snmp), tamanho_pacotes, quantidade_pacotes e historico_trafego_ativo. O detalhe também inclui o campo ativo (sempre true, pois apenas concentradoras habilitadas são retornadas pela API).

curl -s "https://ravi.seuprovedor.com.br/api/api.php?token=CHAVE&action=concentradora&operation=get&id=1"

Erros: ID da concentradora não fornecido (HTTP 400), Concentradora não encontrada (HTTP 404).

Retorna as sessões PPPoE da concentradora, com filtro opcional por status.

Por usuário: username, ip, vlan, status, data_desconexao (só para offline), download_bytes, upload_bytes, ping_ms, jitter_ms, packet_loss.

Os campos ping_ms, jitter_ms e packet_loss são retornados como texto (ex.: "15.2") ou null quando não há medição, caso comum em usuários offline. O campo tempo_sincronizacao também é texto (ex.: "0.523"). Já download_bytes e upload_bytes são numéricos.

curl -s "https://ravi.seuprovedor.com.br/api/api.php?token=CHAVE&action=concentradora&operation=get_users&id=1&status=online"

{
  "success": true,
  "data": [
    { "username": "joao.silva", "ip": "100.64.1.23", "vlan": "110", "status": "online",
      "download_bytes": 5382190342, "upload_bytes": 812009344,
      "ping_ms": "8.2", "jitter_ms": "1.1", "packet_loss": "0" }
  ]
}

Se a concentradora nunca sincronizou, a resposta é sucesso com data vazio.

Detalha um usuário PPPoE específico: tudo do get_users mais concentradora_id, concentradora_nome, linkdown_count (número de sessões registradas, ou seja, reconexões) e historico_ping, que hoje retorna sempre uma lista vazia.

curl -s "https://ravi.seuprovedor.com.br/api/api.php?token=CHAVE&action=concentradora&operation=get_user_details&username=joao.silva&concentradora_id=1"

Erros: Username e concentradora_id são obrigatórios (400), Concentradora não encontrada (404), Dados da concentradora não encontrados (sem sincronização), Usuário não encontrado (404).

Histórico de sessões do usuário, das mais recentes para as mais antigas: data_conexao, data_desconexao, duracao (texto "N dias, HH:MM:SS"), duracao_segundos, ip, vlan, download_bytes, upload_bytes.

curl -s "https://ravi.seuprovedor.com.br/api/api.php?token=CHAVE&action=concentradora&operation=get_user_history&username=joao.silva&concentradora_id=1"

Mantida apenas por compatibilidade: retorna sempre data vazio com a mensagem "Dados de tráfego granular não disponíveis. Use get_user_history para obter tráfego por sessão.". Use get_user_history para obter o tráfego por sessão.

Mesmo sendo apenas de compatibilidade, a operação ainda exige username e concentradora_id; sem eles responde HTTP 400 com o erro Username e concentradora_id são obrigatórios.

Busca concentradoras por nome ou IP (busca parcial).

curl -s "https://ravi.seuprovedor.com.br/api/api.php?token=CHAVE&action=concentradora&operation=search&query=BNG"

Cada resultado traz um conjunto reduzido em relação ao list: id, nome, ip, marca, tipo, status, status_descricao, ultima_sincronizacao, tempo_sincronizacao e usuarios_online. Não retorna total_usuarios nem os campos de configuração de alertas; para o detalhe completo, use o get com o id retornado.

Erro: Query de busca não fornecida (400).

Visão geral do ambiente PPPoE. Sem parâmetros.

curl -s "https://ravi.seuprovedor.com.br/api/api.php?token=CHAVE&action=concentradora&operation=statistics"

{
  "success": true,
  "data": {
    "total_concentradoras": 4,
    "concentradoras_por_status": [
      { "status": 2, "status_descricao": "Normal", "total": 3 },
      { "status": 3, "status_descricao": "Aviso", "total": 1 }
    ],
    "total_usuarios_pppoe": 2048,
    "usuarios_online": 1874,
    "usuarios_offline": 174,
    "top_concentradoras": [ { "id": 1, "nome": "BNG-01", "ip": "10.0.0.1", "usuarios_online": 388 } ]
  }
}

Envia uma mensagem de texto para um ou mais destinatários.

Informe cada número completo, com código do país e DDD, apenas dígitos (ex.: 5531999999999 para um número do Brasil). A API não valida o formato: número incompleto ou com sinais vira um destinatário inexistente no WhatsApp.

curl -s -X POST "https://ravi.seuprovedor.com.br/api/api.php" \
  -d "token=CHAVE" -d "action=whatsapp" -d "operation=send" \
  -d "contacts=5531988887777,5531977776666" \
  -d "message=Backup concluído com sucesso"

{ "msg": "ok" }

Possíveis respostas:

Erros de validação: Message cannot be empty, Please provide contacts, No valid contacts provided. Todos chegam com HTTP 200: verifique o campo msg.

Consulta o status da integração. Bom health-check antes de disparar um lote de mensagens.

curl -s "https://ravi.seuprovedor.com.br/api/api.php?token=CHAVE&action=whatsapp&operation=status"

{
  "status": {
    "system_enabled": true,
    "service_connected": true,
    "connection_status": "connected"
  }
}

system_enabled indica a flag ligada nas Configurações; service_connected indica se a sessão do WhatsApp está realmente conectada (consulta viva ao serviço). connection_status assume apenas dois valores, connected ou disconnected, espelhando o booleano service_connected: para decidir programaticamente, prefira testar service_connected.