Diagnosing API integration failures with the API Log Report

When an integration breaks, the symptom is usually vague — leads stop loading, dispositions stop syncing to the CRM, a dashboard quietly goes stale. The integration sits between two systems, so neither side obviously owns the failure, and each team is quick to point at the other. The API Log Report is where you find out which call actually failed and why, instead of guessing across two codebases and two sets of logs.

What the API actually is here

The API (application programming interface) is the set of web functions that outside systems call to make the dialer do things — add a lead, change a Disposition, log an agent in, pull a status. Some functions act on behalf of an agent and some are server-to-server; the latter is the Non-agent API, used by your CRM or middleware over a plain URL (in VICIdial). Every one of those calls leaves a record, which is what makes failures findable.

Filtering the API Log Report

The report displays API log entries for a date and time range, and you narrow the noise with four filters:

• API User — the account the calling system authenticated as. Start here when one integration broke and the rest are fine.
• Agent User — useful when the calls are made on behalf of a specific agent.
• Function — the specific call, such as a lead add or a disposition update, so you can isolate the one operation that is failing.
• Result — the outcome of each call, which is the field that separates success from failure at a glance.

Working from a failed result back to a cause

flowchart LR
  A[Open API Log Report] --> B[Filter by API User]
  B --> C[Filter by Function]
  C --> D{Result success or error?}
  D -->|Error| E[Read the result text]
  E --> F{Auth or IP problem?}
  F -->|Yes| G[Fix API user or IP authorization]
  F -->|No| H[Bad parameters from the caller]
  D -->|No entry at all| I[Call never reached the dialer]

Filter to the API User for the broken integration, then to the Function that should be firing, and read down the Result column. If you see error results, read what the result actually says — an authentication or IP-authorization rejection means the calling system or its source IP changed, which happens quietly when a server is rebuilt or a firewall rule is edited. A parameter error means the caller is sending bad data, such as a missing list ID or a malformed phone number, and the fix lives in the integration, not the dialer. If there is no entry at all for the window the integration was active, the call never reached the dialer, and the problem is on the network or the caller's side, not yours.

Where to go next

For a full tour of the filters and result codes, see reading the API Log Report. If the failures turn out to be authorization rather than bad data, the access and IP angle in the VICIdial troubleshooting playbook carries it forward.

Stable API users, a fixed IP, and a box that does not move under you make integrations far less fragile. VICIfast runs hardened, managed VICIdial that is live in under 40 seconds. See our plans and pricing.