VICIdialInstall

Summary

Add a list to VICIdial's List Management system.

Inputs

• baseURL (required) — Base VICIdial URL (no trailing /vicidial portion) such as https://example.com.
• function (required) — API function name, defaults to 'add_list'.
• user — User associated with the VICIdial credential.
• pass — Password associated with the VICIdial credential.
• source — Source, defaults to the source defined in the VICIdial credential.
• list_id (required) — The ID for the new list.
• list_name (required) — The name for the new list.
• campaign_id (required) — The ID of the associated campaign for the new list.
• active — Indicates if the list is active (Y/N), defaults to 'Y'.
• list_description — Description for the new list.
• outbound_cid — Outbound caller ID associated with the list.
• script — Script associated with the list.
• reset_time — Time to reset the list.
• xferconf_one — Transfer configuration one.
• xferconf_two — Transfer configuration two.
• custom_fields_copy — Custom fields to copy.
• requestOptions — Additional request options such as batching and timeout.

Output shape

no body — success/failure only

Successful addition of a list yields no body; errors may be returned. Consider error handling in workflows.

Examples

Example 1: Creating a new list for a marketing campaign

Using baseURL as https://vicidial.example.com, with a list_id of '123', list_name as 'Marketing List', and campaign_id as '456'.

Example 2: Adding an inactive list

Set baseURL, list_id, list_name, and campaign_id, with active set to 'N'.