Get Unrecorded Users for Recording Objects

Retrieves the users who are not configured as recording objects, which can be used to select users when adding recording objects.

Request URL

POST {base_url}/uc-cconfig/api/v1/recordings/objects/unrecorded-users

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.
keyword No String The keyword used to search for users, which fuzzy matches the name or the extension number of the user.

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<Unrecorded_User_Search_Data> The query result of unrecorded users.
Unrecorded_User_Search_Data
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<Unrecorded_User_Item> The list of matching unrecorded users.
Unrecorded_User_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.

Example

Request example

POST /uc-cconfig/api/v1/recordings/objects/unrecorded-users 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: jint
{
  "pageSize": 10,
  "pageNumber": 1
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "c76abb2d8ff8c903d9d301159ca0c4dd",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "pageSize": 10,
    "pageNumber": 1,
    "count": "1",
    "results": [
      {
        "userId": "366488799060709376",
        "extension": "1001",
        "name": "qq Hu"
      }
    ]
  }
}