Check for Duplicate MOH Playlists

Checks whether a music-on-hold playlist name already exists in the current tenant.

Request URL

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

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.
Query parameters
Parameter Required Type Description
name No String The name to check for duplicates.
excludeId No String The ID of an existing playlist to exclude from the duplicate check.

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<Duplicate_Check_Result> The duplicate check result.
Duplicate_Check_Result
Parameter Type Description
duplicate Boolean

Whether the name already exists in the current tenant.

  • true: The name already exists.
  • false: The name does not exist.

Example

Request example

GET /uc-cconfig/api/v1/sounds/moh-playlists/check-name?name=Waiting HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MzM3MjM2NiwiaWF0IjoxNzkzMzUwNzY2LCJqdGkiOiJhYmM1M2JhNC1jM2RhLTQ3NWEtOTJiYi1hNGVhYzYxYjJhNWUiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.ZZkUU4v0bILJ01O4E2XXnyKr1FtMZiwdzdRZVuqgRe6s68jttCX15-bKV5DDjoRlCaD-oy4T1KuuEMps_bBpnI9kRYJ6GiJSXwaUkUQATbwEWNWpwIUBQ1fIxFGTiLEA58DERy9Fjl9LRRVvdvhz1RtWS_RNMqFPfbGbON2cl8J6jBGIxb3AVpy_fOwhXSGaPYCGxmKOJalbeZ_LuwQ_SFUcQsaO8kftD09rtmZvXnA9hadhrF1qDvV8VTvd5xlbJDlKvkeo7HgYuLdigFbENuD3zgjJPTEZe9qrVCqWhlvTtNa_YIeMS2p05DWCF7zM0NwPOPLRmOLe_Uq35SMsGw
x-tenant-code: jint

Response example

HTTP/1.1 200 OK
{
  "requestId": "1d4960e8319ecf8e74f9903958053242",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "duplicate": true
  }
}