Get MOH Playlist Options

Retrieves the list of music-on-hold playlists that are available as options in the current tenant, including the system default playlists.

Request URL

GET {base_url}/uc-cconfig/api/v1/sounds/options/moh-playlists

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<MOH_Playlist_Options> The list of MOH playlist options.
MOH_Playlist_Options
Parameter Type Description
options Array<MOH_Playlist_Option> The list of MOH playlist options.
MOH_Playlist_Option
Parameter Type Description
id String The ID of the MOH playlist.
name String The name of the MOH playlist.
isDefault Boolean

Whether the playlist is the system default playlist.

  • true: The playlist is the system default playlist.
  • false: The playlist is a custom playlist.
tag String The tag of the playlist. An empty string indicates that no tag is set.

Example

Request example

GET /uc-cconfig/api/v1/sounds/options/moh-playlists HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MzM3Mzc0NiwiaWF0IjoxNzkzMzUyMTQ2LCJqdGkiOiI4ODZlOTNhYS03YjU4LTQ0YmMtYTc2MS1lZmRlYTQ4ZThjZGMiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.Qer2s1XtlMW2QjET3dn3LpkVdV7u-8JM-Xu-kqt3fXvAKU_oC6bcYmI4WDj1hOxxxedrmlWsVficK9GfCkN04A400eDTcS5ZzTA84Wwr_atew0M8H-uZMQLVPyLTplBlSHaXUzQLw1_UMYMzhiujWsbd17CiY8agw25m51KLnaQgNxa5lGNP1Uma3sjau6UXPQ7lXJQmGLP3RBccxqL9MpxF4Q5ai7q-muOscl1s_pf-2qskOx_yoLMaa5sZYdm_tOeQHRgqVGYvl85fJJMbhSJBfzZG1D-K452pwwndR7txwdKxHFEMCGPoJDkzFRhINLFcyMi-oJyTAwNjeFoYxg
x-tenant-code: jint

Response example

HTTP/1.1 200 OK
{
  "requestId": "cdbba3b0691f9841f778090aed39c23f",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "options": [
      {
        "id": "330931373987872768",
        "name": "Default",
        "isDefault": true,
        "tag": ""
      },
      {
        "id": "374482427330256896",
        "name": "TestPlaylist-Upd",
        "isDefault": false,
        "tag": ""
      },
      {
        "id": "338596681041158144",
        "name": "Waiting",
        "isDefault": false,
        "tag": ""
      }
    ]
  }
}