VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

User Agent Management → User Group Status

AI-generated

Summary

Retrieve the status of user groups in VICIdial.

Inputs

  • baseURL (required) — Base VICIdial URL (no trailing /vicidial portion).
  • function (required) — API function name (auto-filled as 'user_group_status').
  • user — Username for VICIdial (auto-filled from credentials).
  • pass — Password for VICIdial (auto-filled from credentials).
  • source — Source specified in the VICIdial credential (auto-filled).
  • user_groups — Pipe-delimited user groups to check status.
  • stage — Output format; options include 'Csv', 'Tab', 'Pipe', or 'Json'.
  • header — Specify whether to include header in output ('YES' or 'NO').
  • requestOptions — Collection for additional request settings like batching, timeout, etc.

Output shape

a list of user group statuses

Returns a structured output based on the specified 'stage' format, and includes details for each user group specified.

Examples

Example 1: Check the status of specific user groups in VICIdial.

Set baseURL to your VICIdial instance, specify user_groups as 'sales, support', and choose 'Json' for output.

Discussion