Query MOH Audio File List

Query the list of MOH (music on hold) files in a specified MOH playlist.

Request URL

GET {base_url}/{api_path}/moh_files/list?list_name={list_name}&access_token={access_token}

Request parameters

Parameter Required Type Description
list_name Yes String The name of the MOH playlist.
Note: You can query the name of the MOH playlist using Query MoH Playlists.

Response parameters

Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
prompt_list Array<Moh_Audio_Files> The list of audio files in the MOH playlist.
Moh_Audio_Files
Parameter Type Description
file String The name of the audio file.

Example

Request example

GET /openapi/v1.0/moh_files/list?list_name=demo_list&access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

Response example

HTTP/1.1 200 OK
{
  "errcode": 0,
  "errmsg": "SUCCESS",
  "prompt_list": [
    {
      "file": "demo_track.wav"
    }
  ]
}