Update a MOH Playlist Item Name

Renames an audio item of a music-on-hold playlist and returns the updated audio item.

Request URL

PUT {base_url}/uc-cconfig/api/v1/sounds/moh-playlists/{id}/item/{itemId}/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.
Path parameters
Parameter Required Type Description
id Yes String The ID of the MOH playlist. You can obtain the ID using the Search MOH Playlists interface.
itemId Yes String The ID of the audio item to rename. You can obtain the ID using the Search MOH Playlist Items interface.
Body parameters
Parameter Required Type Description
name No String The new name of the audio item.

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<Renamed_Item> The updated audio item.
Renamed_Item
Parameter Type Description
id String The ID of the audio item.
sourceType String

The source of the audio item:

  • SOURCE_TYPE_UPLOAD
  • SOURCE_TYPE_USER_RECORD
name String The new name of the audio item.
fileName String The name of the audio file in the storage.
fileSize String The size of the audio file, in bytes.
durationMs Integer The duration of the audio file, in milliseconds.
resourceId String The ID of the audio file resource in the resource service.
text String The text content of the audio item.
createdAt String The time when the audio item was created, in Unix timestamp format (milliseconds).

Example

Request example

PUT /uc-cconfig/api/v1/sounds/moh-playlists/338596681041158144/item/338596802441093120/name 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
Content-Type: application/json
{
  "name": "welcome.wav-renamed"
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "583397924db9306ff9d245f7bc485cbf",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "id": "338596802441093120",
    "sourceType": "SOURCE_TYPE_UPLOAD",
    "name": "welcome.wav-renamed",
    "fileName": "d8cbba8a-ed21-443b-849a-3f4198933507.wav",
    "fileSize": "127054",
    "durationMs": 7936,
    "resourceId": "2080206982001709057",
    "text": "",
    "createdAt": "1784794968526"
  }
}