Add a Recording Object

Adds a recording object for a user.

Request URL

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

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
userId Yes String The ID of the user. You can obtain the ID using the Get Unrecorded Users for Recording Objects interface.
retentionUnit Yes String

The unit of the recording retention duration.

Valid value:

  • day
  • month
  • year
retentionUnitValue Yes Integer The value of the recording retention duration, for example 1, 3, or 6.
autoRecording No Boolean

Whether automatic recording is enabled for the user.

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.

Example

Request example

POST /uc-cconfig/api/v1/recordings/objects 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
{
  "userId": "347663090691891200",
  "retentionUnit": "month",
  "retentionUnitValue": 1,
  "autoRecording": true
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "c15c4e981062ab25580f71a5d7c489ac",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": ""
}