Documentation

Quick reference for the VoIP Health Check Windows client and hosted dashboard. Looking for the deeper reference (REST API, schema, security model)? See the full archived docs.

What it does

VoIP Health Check is a portable Windows app that scans a phone system's network for the things that cause one-way audio, choppy calls, and registration failures — then uploads a structured report to this site so you (or the next technician) can see exactly what was found.

  • Quick Scan — one-click diagnostics: SIP ALG, port reachability, latency / jitter, DHCP, VLAN.
  • Advanced Scan — same checks plus a deeper SIP/RTP port sweep and longer latency sampling. Tucked under Advanced options so it stays out of the way.
  • Packet capture — Start / Stop buttons capture .pcapng via Wireshark/Npcap when present, with a non-admin pktmon evidence fallback so something always lands on disk.
  • Stop Scan — cancel a running scan cleanly without closing the app.
  • Auto-upload — the report, raw log, and any captures are sent to the hosted dashboard automatically. Local copies are always kept too.

Install & run

  1. Download the latest portable Windows package from the GitHub Releases page — pick VoIPHealthCheck-windows-package-<version>.zip.
  2. Unzip into a fresh folder (e.g. C:\Tools\VoIPHealthCheck\). No installer required.
  3. Launch the versioned VoIPHealthCheck-<version>.exe so the file name confirms which build you are running.

Using the app

  1. Click the red Quick Scan button. The gateway is auto-detected; nothing else is required.
  2. Optionally fill in the Problem Experienced dropdown or the free-text field, or open Advanced options to set a hosted platform, gateway / firewall / starbox IP, or a SIP test endpoint. Every field is optional.
  3. Use Start Packet Capture / Stop Packet Capture if you want a .pcapng alongside the report. Capture runs independently of a scan.
  4. If you need to abort, click Stop Scan.
  5. When the scan finishes the log pane switches to a plain-English summary. The report and any captures are uploaded automatically.

Dashboard

The Dashboard aggregates every uploaded scan. Each row shows latency and jitter ratings, the top issues, and suggested fixes, plus the relevant IPs and any blocked ports. Click a row to open the per-scan detail page with the full evidence and downloadable report / log / capture files.

Troubleshooting

Scan hangs or shows the wrong version

You are almost certainly running an old executable from a previous install. Delete any old VoipScanner_Desktop folder and stale shortcuts, download the latest package zip, extract to a fresh folder, and launch the versioned .exe. The startup banner should report the current version and an Executable: path inside the new folder.

Packet capture won't start

dumpcap needs Wireshark/Npcap. Without it, the app falls back to Windows pktmon; on most builds pktmon needs Administrator. Either install Npcap or run the app elevated. Either way an evidence file is written.

Upload returns 401

The server is configured with an upload token. Set the same value via the VOIPSCAN_UPLOAD_TOKEN environment variable or %LOCALAPPDATA%\VoipScan\upload.json on the client.

More