Get Prompt Preferences Setting

Retrieves the prompt preferences of a tenant.

Request URL

GET {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.

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 prompt preferences of the tenant.
Prompt_Preferences
Parameter Type Description
mohPlaylistId String The ID of the default music-on-hold playlist.
musicOnCallForward String

The waiting mode when a call is forwarded:

  • moh: Music on hold.
  • ring_tone: Ring tone.
invalidPhoneNumberPrompt String The ID of the invalid phone number prompt. An empty string indicates that it is not configured.
busyLinePrompt String The ID of the busy line prompt. An empty string indicates that it is not configured.
callFailurePrompt String The ID of the call failure prompt. An empty string indicates that it is not configured.
eventNotificationPrompt String The ID of the event notification prompt. An empty string indicates that it is not configured.
emergencyPrompt String The ID of the emergency prompt. The value default indicates that the system default prompt is used.
emergencyPromptRepeatCount Integer The number of times the emergency prompt is played. The value 0 indicates that it is not configured.
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.
createdAt String The time when the preferences were created, in Unix timestamp format (milliseconds).
updatedAt String The time when the preferences were last updated, in Unix timestamp format (milliseconds).

Example

Request example

GET /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: jint

Response example

HTTP/1.1 200 OK
{
  "requestId": "8e5ebd986a3640c1014051fb01f87afb",
  "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"
  }
}