Search Recording Objects

Searches recording objects in a tenant.

Request URL

POST {base_url}/uc-cconfig/api/v1/recordings/objects/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 Yes Integer The page number to retrieve.
pageSize Yes Integer The number of records to retrieve per page.
user No String The keyword used to search for users, which fuzzy matches the name or the extension number of the user.
autoRecording No Boolean

Whether automatic recording is enabled, which is used to filter recording objects. Recording objects are not filtered by this condition if the parameter is omitted.

Valid value:

  • true: Automatic recording is enabled.
  • false: Automatic recording is disabled.

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 recording objects.
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<Recording_Object_Item> The list of matching recording objects.
Recording_Object_Item
Parameter Type Description
userId String The ID of the user.
extension String The extension number of the user.
name String The name of the user.
callRecording Boolean

Whether call recording is enabled for the user:

  • true: Call recording is enabled for the user.
  • false: Call recording is not enabled for the user.
autoRecording Boolean

Whether automatic recording is enabled for the user:

  • true: Automatic recording is enabled for the user.
  • false: Automatic recording is not enabled for the user.
retentionUnit String

The unit of the recording retention duration:

  • day
  • month
  • year
retentionUnitValue Integer The value of the recording retention duration.

Example

Request example

POST /uc-cconfig/api/v1/recordings/objects/search-page HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MTk4MTkwMiwiaWF0IjoxNzkxOTYwMzAyLCJqdGkiOiI5MTExMTA3YS1jODkzLTRmYjYtODJmNS0zYTFlNTUxMTVmODMiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.zMBy3Vp-AkUDnJPCXFe5fO5C3UlhaH0PtkdozQs_-EBOIVzCYRW-Y5qRiRib0_N4p7ThH-IfuNJ65cmKyKcmOyPY5vvTzLkrN-WKZIBbTMSQWahDbSZx-VAvE7fDDh8U73V0WzCXdLuQTKEXdXcNO1XZE-ZFSUaS0bGGKh3zmrRNYI_qvywRs4Yn_SIeCWxDqZ7QmZiKgNBy_8NPGb1fUBJ-eFAjAzZX-JJ9oppT-xUKP00UPqoH30ZVvFnu9veW0m6pTzQXP881Xb9ja-7Z38oTOOug3mwUkFCgPFxU3rd4d9zNnjLsmT6MQdvDxeOpfqWPez-_tejmqMTyPpm05Q
Content-Type: application/json
x-tenant-code: colortest5
{
  "pageSize": 10,
  "pageNumber": 1
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "ba87d0c003fdf361acda7d6fd1c2726a",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "pageSize": 10,
    "pageNumber": 1,
    "count": "1",
    "results": [
      {
        "userId": "347663090691891200",
        "extension": "1000",
        "name": "colortest8",
        "callRecording": true,
        "autoRecording": true,
        "retentionUnit": "month",
        "retentionUnitValue": 1
      }
    ]
  }
}