VICIdialInstall

Summary

Retrieve the status of a specific agent from the VICIdial system using the Agent Status operation.

Inputs

• baseURL (required) — Base VICIdial URL (no trailing /vicidial portion)
• function (required) — API function name, defaults to 'agent_status'.
• user — User ID, fetched from the VICIdial credential.
• pass — Password, fetched from the VICIdial credential.
• source — Defaults to the source defined in the VICIdial credential.
• agent_user (required) — Agent user ID to fetch the status for.
• stage — Output format, with options like 'csv', 'tab', 'pipe', and 'json'.
• header — Include header in output, options are 'YES' or 'NO'.
• include_ip — Include IP in output, options are 'YES' or 'NO'.
• requestOptions — Additional request options, including batching, SSL settings, proxy, and timeout.

Output shape

a status report of the specified agent, typically including fields such as their current state and other related information.

Output format depends on the 'stage' parameter. Defaults may vary based on settings.

Examples

Example 1: Get the status of a specific agent identified by their user ID

Set the 'baseURL' to your VICIdial server URL and provide the 'agent_user' ID.