VICIdialInstall

Summary

Add a new user to VICIdial's User Agent Management.

Inputs

• baseURL (required) — Base VICIdial URL (no trailing /vicidial portion)
• function (required) — API function name (auto-filled as 'add_user')
• 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
• agent_pass (required) — Password for the agent user
• agent_user_level (required) — Level of the agent user
• agent_full_name (required) — Full name of the agent user
• agent_user_group (required) — User group for the agent
• phone_login — Phone login for the agent user
• phone_pass — Password for the phone login
• hotkeys_active — Enable or disable hotkeys (0 or 1)
• voicemail_id — Voicemail ID for the agent
• email — Email address of the agent
• wrapup_seconds_override — Override for wrapup seconds
• agent_choose_ingroups — Allow agent to choose ingroups (0 or 1)
• in_groups — Pipe-delimited ingroups for the agent
• requestOptions — Various request options such as batching and timeout

Output shape

no body — success/failure only

Requires specific parameters to be set; will not return any data upon successful execution.

Examples

Example 1: Adding a new user agent to manage calls

Set baseURL to your VICIdial server, provide agent_user, agent_pass, agent_full_name, agent_user_group, and required credentials.