VICIdialInstall

Summary

Retrieve a call disposition report from the VICIdial API.

Inputs

• baseURL (required) — Base VICIdial URL (no trailing /vicidial portion)
• function (required) — API function name, defaults to call_dispo_report.
• user — Comes from the VICIdial credential.
• pass — Comes from the VICIdial credential.
• source — Defaults to the source defined in the VICIdial credential.
• query_date — Query date (YYYY-MM-DD) for filtering reports.
• end_date — End date (YYYY-MM-DD) for filtering reports.
• ingroups — Dash-delimited ingroups for filtering.
• did_patterns — Patterns to filter DIDs.
• status_breakdown — Indicates if status breakdown is required (0 or 1).
• show_percentages — Indicates if percentages should be shown (0 or 1).
• file_download — Indicates if the report should be downloadable as a file (0 or 1).
• requestOptions — Additional request options like batching and timeout.

Output shape

a report containing call dispositions based on the specified parameters

Includes various filters such as dates and ingroups; may also return options for file download.

Examples

Example 1: Fetch call disposition report for a specified date range

Set base URL and specify query_date and end_date to retrieve the report.