VICIdialInstall

Summary

Retrieve the hopper list for a specific campaign from VICIdial.

Inputs

• baseURL (required) — Base VICIdial URL (no trailing /vicidial portion).
• function (required) — API function name (auto-filled).
• user — Comes from the VICIdial credential.
• pass — Comes from the VICIdial credential.
• source — Defaults to the source defined in the VICIdial credential.
• campaign_id (required) — Campaign ID.
• stage — Output format.
• header — Include header in output.
• search_method — Method for identifying items in the hopper.
• requestOptions — Collection of request options such as batching and timeout.

Output shape

a structured list of items from the hopper for the specified campaign.

May include headers in output depending on the 'header' input parameter. The output format can vary based on the 'stage' parameter.

Examples

Example 1: Fetch hopper list for campaign with ID 123

Set 'Base URL' to 'https://example.com', 'campaign_id' to '123', and leave other parameters as defaults.

Example 2: Fetch hopper list with CSV format and include headers

Set 'Base URL', 'campaign_id', 'stage' to 'csv', and 'header' to 'YES'.