Search Custom Prompts

Searches custom prompts in a tenant.

Request URL

POST {base_url}/uc-cconfig/api/v1/sounds/custom-prompts/search-page

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
pageNumber No Integer The page number to retrieve.
pageSize No Integer The number of records to retrieve per page.
keyword No String The keyword used to search for custom prompts by name.
panelSource No String The panel module to filter by. This parameter is used only by the voicemail panel, and the value is user_mailbox.
sourceTypes No Array<String>

The list of prompt sources to filter by.

Valid value:

  • SOURCE_TYPE_UPLOAD: The prompt is uploaded.
  • SOURCE_TYPE_USER_RECORD: The prompt is recorded from a mobile phone.

If not specified, all prompts are returned.
panelResourceId No String The resource ID of the specific panel module to filter by. This parameter is used together with panelSource.

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<Search_Result> The search result of custom prompts.
Search_Result
Parameter Type Description
pageSize Integer The number of records per page.
pageNumber Integer The current page number.
count String The total number of matching records.
results Array<Custom_Prompt> The list of custom prompts on the current page.
Custom_Prompt
Parameter Type Description
id String The ID of the custom prompt.
name String The name of the custom prompt.
sourceType String

The source of the custom prompt:

  • SOURCE_TYPE_UPLOAD: The prompt is uploaded.
  • SOURCE_TYPE_USER_RECORD: The prompt is recorded from a mobile phone.
fileSize String The size of the prompt file, in bytes.
panelSource String The panel module that the custom prompt is associated with, such as queue, ring_group, or extension. An empty string indicates that it is not associated with a panel module.
panelResourceId String The resource ID of the panel module. The value 0 indicates that it is not associated with a panel module.
resourceId String The ID of the audio file resource in the resource service.
createdAt String The time when the custom prompt was created, in Unix timestamp format (milliseconds).
updatedAt String The time when the custom prompt was last updated, in Unix timestamp format (milliseconds).
durationMs Integer The duration of the prompt, in milliseconds.

Example

Request example

POST /uc-cconfig/api/v1/sounds/custom-prompts/search-page 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
{
  "pageNumber": 1,
  "pageSize": 10
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "f9336ebc67efe7b429aa83a21bec83b2",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "pageSize": 10,
    "pageNumber": 1,
    "count": "2",
    "results": [
      {
        "id": "345815317434331136",
        "name": "Emergency.wav",
        "sourceType": "SOURCE_TYPE_USER_RECORD",
        "fileSize": "53858",
        "panelSource": "",
        "panelResourceId": "0",
        "resourceId": "2087425500304121857",
        "createdAt": "1786515996614",
        "updatedAt": "1787189222180",
        "durationMs": 3360
      },
      {
        "id": "338579055770443776",
        "name": "Welcome.wav",
        "sourceType": "SOURCE_TYPE_UPLOAD",
        "fileSize": "127054",
        "panelSource": "",
        "panelResourceId": "0",
        "resourceId": "2080189235888902145",
        "createdAt": "1784790737390",
        "updatedAt": "1784790737390",
        "durationMs": 7936
      }
    ]
  }
}