Update Prompt Preferences Setting

Updates the prompt preferences of a tenant. Fields that are not passed keep their original values.

Request URL

PUT {base_url}/uc-cconfig/api/v1/sounds/prompt-preferences

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.
Body parameters
Parameter Required Type Description
mohPlaylistId No String The ID of the default music-on-hold playlist.
musicOnCallForward No String

The waiting mode when a call is forwarded.

Valid value:

  • moh: Music on hold.
  • ring_tone: Ring tone.
invalidPhoneNumberPrompt No String The ID of the invalid phone number prompt.
busyLinePrompt No String The ID of the busy line prompt.
callFailurePrompt No String The ID of the call failure prompt.
eventNotificationPrompt No String The ID of the event notification prompt.
emergencyPrompt No String The ID of the emergency prompt.
emergencyPromptRepeatCount No Integer The number of times the emergency prompt is played, ranging from 1 to 10.
callForwardingPrompt No Integer

Whether to enable the call forwarding prompt.

Valid value:

  • 0: Disabled.
  • 1: Enabled.
callWaitingPrompt No Integer

Whether to enable the call waiting prompt.

Valid value:

  • 0: Disabled.
  • 1: Enabled.
Note:

emergencyPromptRepeatCount must be inside the range [1, 10] when passed. Omitting the field keeps the original value.

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<Prompt_Preferences> The updated prompt preferences.
Prompt_Preferences
Parameter Type Description
mohPlaylistId String The ID of the default music-on-hold playlist.
musicOnCallForward String The music played while waiting for a call forward: moh or ring_tone.
invalidPhoneNumberPrompt String The ID of the prompt played for an invalid phone number.
busyLinePrompt String The ID of the prompt played when the line is busy.
callFailurePrompt String The ID of the prompt played when a call fails.
eventNotificationPrompt String The ID of the prompt played for event notifications.
emergencyPrompt String The ID of the prompt played for emergency calls.
emergencyPromptRepeatCount Integer The number of playback times of the emergency prompt.
callForwardingPrompt Integer

Whether the call forwarding prompt is enabled.

  • 0: Disabled.
  • 1: Enabled.
callWaitingPrompt Integer

Whether the call waiting prompt is enabled.

  • 0: Disabled.
  • 1: Enabled.

Example

Request example

PUT /uc-cconfig/api/v1/sounds/prompt-preferences 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: colortest2
Content-Type: application/json
{
  "musicOnCallForward": "moh"
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "6fbe6292aa5a79f739ae85e717de7443",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "mohPlaylistId": "338596681041158144",
    "musicOnCallForward": "moh",
    "invalidPhoneNumberPrompt": "",
    "busyLinePrompt": "",
    "callFailurePrompt": "",
    "eventNotificationPrompt": "",
    "emergencyPrompt": "default",
    "emergencyPromptRepeatCount": 0,
    "callForwardingPrompt": 1,
    "callWaitingPrompt": 1,
    "createdAt": "1784776982943",
    "updatedAt": "1786501129081"
  }
}