VICIdialInstall

Summary

Retrieve a list of sounds from the VICIdial system.

Inputs

• baseURL (required) — Base VICIdial URL (no trailing /vicidial portion).
• function (required) — API function name, defaults to 'sounds_list'.
• user — User for authentication, sourced from VICIdial credentials.
• pass — Password for authentication, sourced from VICIdial credentials.
• source — Source for the request, defaults to the one defined in the VICIdial credential.
• format — Output format, options include 'text', 'link', or 'selectframe'.
• stage — Output format stage, options include 'csv', 'tab', 'pipe', or 'json'.
• comments — Additional comments for the request.
• requestOptions — Additional request options including batching, SSL handling, proxy, and timeout.

Output shape

a list of sounds

Returned in various formats based on 'format' and 'stage' parameters.

Examples

Example 1: To obtain a list of audio files used in campaigns, set the Base URL to your VICIdial instance, and select the format as 'text' for easy readability.

Set 'baseURL', use the default 'function', and select your desired 'format'.