VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

User Agent Management → User Details

AI-generated

Summary

Fetches details for a specified agent user in VICIdial.

Inputs

  • baseURL (required) — Base VICIdial URL (no trailing /vicidial portion)
  • function (required) — API function name (auto-filled) - 'user_details'
  • user — Comes from the VICIdial credential
  • pass — Comes from the VICIdial credential
  • source — Defaults to the source defined in the VICIdial credential
  • agent_user (required) — Agent user ID to fetch details for
  • stage — Output format for the response
  • header — Include header in output
  • requestOptions — Collection of additional request options including batching and timeout settings.

Output shape

a single record containing the agent user details

Output format is determined by the 'stage' parameter, with options such as 'csv', 'tab', 'pipe', or 'json'. Parameter 'header' controls inclusion of headers in the output.

Examples

Example 1: Fetch details for user 'agent01'

Use a valid base URL, set 'agent_user' to 'agent01', choose preferred output format.

Discussion