Update Recording Setting

Updates the recording settings of a tenant.

Request URL

PUT {base_url}/uc-cconfig/api/v1/recordings/config

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
recordingScope No Object<Recording_Scope_Input> The recording scope settings to update.
recordingTone No Object<Recording_Tone_Input> The recording tone settings to update.
recordingFile No Object<Recording_File_Input> The recording file settings to update.
Recording_Scope_Input
Parameter Required Type Description
internalCalls No Boolean

Whether internal calls are recorded. This setting is not updated if the parameter is omitted.

Valid value:

  • true: Internal calls are recorded.
  • false: Internal calls are not recorded.
externalCalls No Boolean

Whether external calls are recorded. This setting is not updated if the parameter is omitted.

Valid value:

  • true: External calls are recorded.
  • false: External calls are not recorded.
queueCalls No Boolean

Whether queue calls are recorded. This setting is not updated if the parameter is omitted.

Valid value:

  • true: Queue calls are recorded.
  • false: Queue calls are not recorded.
queueIds No Object<Queue_Ids> The IDs of the queues to be recorded, which takes effect when queueCalls is set to true.
Queue_Ids
Parameter Required Type Description
values No Array<String> The IDs of the queues to be recorded. An empty array clears all queue IDs, and an omitted queueIds parameter keeps the existing queue IDs unchanged.
Recording_Tone_Input
Parameter Required Type Description
internalStartPrompt No String The prompt tone played when recording starts for internal calls. This setting is not updated if the parameter is omitted.
internalPausePrompt No String The prompt tone played when recording is paused for internal calls. This setting is not updated if the parameter is omitted.
internalResumePrompt No String The prompt tone played when recording is resumed for internal calls. This setting is not updated if the parameter is omitted.
inboundStartPrompt No String The prompt tone played when recording starts for inbound external calls. This setting is not updated if the parameter is omitted.
outboundStartPrompt No String The prompt tone played when recording starts for outbound external calls. This setting is not updated if the parameter is omitted.
externalPausePrompt No String The prompt tone played when recording is paused for external calls. This setting is not updated if the parameter is omitted.
externalResumePrompt No String The prompt tone played when recording is resumed for external calls. This setting is not updated if the parameter is omitted.
beepEnabled No Boolean

Whether the beep tone is enabled. This setting is not updated if the parameter is omitted.

Valid value:

  • true: The beep tone is enabled.
  • false: The beep tone is disabled.
beepInterval No Integer The interval of the beep tone, in seconds. This setting is not updated if the parameter is omitted.
Recording_File_Input
Parameter Required Type Description
fileFormat No String

The format of the recording files. This setting is not updated if the parameter is omitted.

Valid value:

  • WAV
  • MP3
stereoSeparation No Boolean

Whether stereo separation is enabled, which separates the caller and the callee into the left and right channels. This setting is not updated if the parameter is omitted.

Valid value:

  • true: Stereo separation is enabled.
  • false: Stereo separation is disabled.
deleteWithCdr No Boolean

Whether the recording files are deleted together with the corresponding CDR records. This setting is not updated if the parameter is omitted.

Valid value:

  • true: The recording files are deleted together with the corresponding CDR records.
  • false: The recording files are not deleted together with the corresponding CDR records.

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<Recording_Config_Data> The recording settings after the update.
Recording_Config_Data
Parameter Type Description
recordingScope Object<Recording_Scope_Data> The recording scope settings.
recordingTone Object<Recording_Tone_Data> The recording tone settings.
recordingFile Object<Recording_File_Data> The recording file settings.
Recording_Scope_Data
Parameter Type Description
internalCalls Boolean

Whether internal calls are recorded:

  • true: Internal calls are recorded.
  • false: Internal calls are not recorded.
externalCalls Boolean

Whether external calls are recorded:

  • true: External calls are recorded.
  • false: External calls are not recorded.
queueCalls Boolean

Whether queue calls are recorded:

  • true: Queue calls are recorded.
  • false: Queue calls are not recorded.
queueIds Array<String> The IDs of the queues to be recorded, which takes effect when queueCalls is set to true.
Recording_Tone_Data
Parameter Type Description
internalStartPrompt String The prompt tone played when recording starts for internal calls.
internalPausePrompt String The prompt tone played when recording is paused for internal calls.
internalResumePrompt String The prompt tone played when recording is resumed for internal calls.
inboundStartPrompt String The prompt tone played when recording starts for inbound external calls.
outboundStartPrompt String The prompt tone played when recording starts for outbound external calls.
externalPausePrompt String The prompt tone played when recording is paused for external calls.
externalResumePrompt String The prompt tone played when recording is resumed for external calls.
beepEnabled Boolean

Whether the beep tone is enabled:

  • true: The beep tone is enabled.
  • false: The beep tone is disabled.
beepInterval Integer The interval of the beep tone, in seconds.
Recording_File_Data
Parameter Type Description
fileFormat String

The format of the recording files:

  • WAV
  • MP3
stereoSeparation Boolean

Whether stereo separation is enabled, which separates the caller and the callee into the left and right channels:

  • true: Stereo separation is enabled.
  • false: Stereo separation is disabled.
deleteWithCdr Boolean

Whether the recording files are deleted together with the corresponding CDR records:

  • true: The recording files are deleted together with the corresponding CDR records.
  • false: The recording files are not deleted together with the corresponding CDR records.

Example

Request example

PUT /uc-cconfig/api/v1/recordings/config 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
{
  "recordingScope": {
    "queueCalls": false,
    "queueIds": {
      "values": []
    }
  },
  "recordingTone": {
    "beepInterval": 15
  },
  "recordingFile": {
    "fileFormat": "WAV",
    "stereoSeparation": true
  }
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "dc01f667abccd566fa25db66677b0454",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "recordingScope": {
      "internalCalls": false,
      "externalCalls": false,
      "queueCalls": false,
      "queueIds": []
    },
    "recordingTone": {
      "internalStartPrompt": "",
      "internalPausePrompt": "",
      "internalResumePrompt": "",
      "inboundStartPrompt": "",
      "outboundStartPrompt": "",
      "externalPausePrompt": "",
      "externalResumePrompt": "",
      "beepEnabled": false,
      "beepInterval": 15
    },
    "recordingFile": {
      "fileFormat": "WAV",
      "stereoSeparation": true,
      "deleteWithCdr": false
    }
  }
}