VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

User Agent Management → Logged In Agents

AI-generated

Summary

Fetch logged-in agents from the VICIdial system.

Inputs

  • baseURL (required) — Base VICIdial URL (no trailing /vicidial portion).
  • function (required) — API function name (auto-filled, should be 'logged_in_agents').
  • user — Username from the VICIdial credential.
  • pass — Password from the VICIdial credential.
  • source — Source defined in the VICIdial credential.
  • campaigns — Pipe or dash-delimited campaigns.
  • user_groups — Pipe-delimited user groups.
  • show_sub_status — Specify whether to show sub status (default: NO).
  • stage — Output format (e.g., CSV, JSON).
  • header — Include header in output ('YES' or 'NO').
  • requestOptions — Additional options for request handling.

Output shape

a list of logged-in agents

Ensure to provide the required baseURL. The response format depends on the selected 'stage' option.

Discussion