VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Reporting Monitoring → Call Status Stats

AI-generated

Summary

Fetch call status statistics from the VICIdial API.

Inputs

  • baseURL (required) — Base VICIdial URL (no trailing /vicidial portion).
  • function (required) — API function name, auto-filled as 'call_status_stats'.
  • user — User credential for VICIdial, defaults to the configured username.
  • pass — Password credential for VICIdial, defaults to the configured password.
  • source — Source defined in the VICIdial credential.
  • campaigns (required) — Pipe or dash-delimited campaigns to query.
  • query_date — Query date in YYYY-MM-DD format.
  • ingroups — Dash-delimited ingroups to filter results.
  • statuses — Dash-delimited statuses to filter results.
  • requestOptions — Optional settings for request behavior, including batching and timeout options.

Output shape

a list of call status statistics

Output includes statistics for the specified campaigns, grouped and filtered as per the query parameters.

Examples

Example 1: Fetch call status statistics for specific campaigns on a given date.

Set 'campaigns' to 'Campaign1|Campaign2', 'query_date' to '2023-09-15'.

Discussion