VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

List Management → Moh List

AI-generated

Summary

Retrieve the list of Music on Hold (MOH) settings from a VICIdial server.

Inputs

  • baseURL (required) — Base VICIdial URL (no trailing /vicidial portion).
  • function (required) — API function name, auto-filled as 'moh_list'.
  • user — User credential for VICIdial.
  • pass — Password credential for VICIdial.
  • source — Defaults to the source defined in the VICIdial credential.
  • format — Output format, can be 'text', 'link', or 'selectframe'.
  • comments — Optional comments for the request.
  • requestOptions — Options for the request, including batching, SSL handling, proxy settings, and timeout.

Output shape

a list of MOH settings

Returns the list in the specified format. Response shape may vary based on the selected output format.

Examples

Example 1: Retrieve MOH settings for a VICIdial system using specified credentials and options.

Set Base URL, select 'MOH List' function, and define output format to 'text'.

Discussion