VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Campaign Management → Campaigns List

AI-generated

Summary

Lists campaigns from VICIdial by querying the API.

Inputs

  • baseURL (required) — Base VICIdial URL (no trailing /vicidial portion)
  • function (required) — API function name, fixed to 'campaigns_list'.
  • user — VICIdial credential username.
  • pass — VICIdial credential password.
  • source — Source defined in VICIdial credential.
  • campaign_id — Specific Campaign ID to retrieve.
  • stage — Output format (e.g., CSV, JSON).
  • header — Include header in output.
  • requestOptions — Additional request options, including batching and timeout settings.

Output shape

A list of campaigns available in the VICIdial system.

Output will be based on the selected format in the 'stage' parameter and may include headers if specified.

Examples

Example 1: Retrieve all campaigns without specifying a campaign ID.

Set 'baseURL' and use the default values for other parameters.

Example 2: Get a specific campaign's details by ID.

Fill in 'campaign_id' with the desired Campaign ID.

Discussion