Update AI Transcription Setting

Request URL

PUT {base_url}/uc-cconfig/api/v1/ai/transcriptions/settings

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
version	Yes	String	The optimistic-lock version number, which must match the current latest version. You can obtain the version using the Get AI Transcription Setting interface.
callTranscription	Yes	Object<Call_Transcription_Block_Input>	The call transcription configuration block input.
voicemailTranscription	Yes	Object<Voicemail_Transcription_Block_Input>	The voicemail transcription configuration block input.

Call_Transcription_Block_Input


Parameter	Required	Type	Description
enabled	No	Boolean	Whether call transcription is enabled. Valid value: `true`: Enabled. `false`: Disabled.
automaticTranscriptionEnabled	No	Boolean	Whether automatic transcription is enabled. Valid value: `true`: Enabled. `false`: Disabled.
serverType	No	String	The transcription server type: Valid value: `SERVER_TYPE_BUILT_IN`: Built-in transcription server. `SERVER_TYPE_CUSTOM`: Custom transcription server. If not specified, `SERVER_TYPE_UNSPECIFIED` is used.
language	No	String	The transcription language in BCP-47 format.
extensionScope	Yes	String	The extension scope of the transcription configuration block. Valid value: `TRANSCRIPTION_EXTENSION_SCOPE_ALL`: All extensions. `TRANSCRIPTION_EXTENSION_SCOPE_SPECIFIC`: Specific extensions, configured through userIds. Call transcription is subject to quota limits; the scope only supports SPECIFIC.
userIds	No	Array<String>	The list of user IDs that take effect when extensionScope is `TRANSCRIPTION_EXTENSION_SCOPE_SPECIFIC`.

Voicemail_Transcription_Block_Input


Parameter	Required	Type	Description
enabled	No	Boolean	Whether voicemail transcription is enabled. Valid value: `true`: Enabled. `false`: Disabled.
serverType	No	String	The transcription server type: Valid value: `SERVER_TYPE_BUILT_IN`: Built-in transcription server. `SERVER_TYPE_CUSTOM`: Custom transcription server. If not specified, `SERVER_TYPE_UNSPECIFIED` is used.
language	No	String	The transcription language in BCP-47 format.
extensionScope	Yes	String	The extension scope of the transcription configuration block. Valid value: `TRANSCRIPTION_EXTENSION_SCOPE_ALL`: All extensions. `TRANSCRIPTION_EXTENSION_SCOPE_SPECIFIC`: Specific extensions, configured through userIds. Voicemail transcription has no quota limit; the scope supports ALL and SPECIFIC.
userIds	No	Array<String>	The list of user IDs that take effect when extensionScope is `TRANSCRIPTION_EXTENSION_SCOPE_SPECIFIC`. This list must be empty when extensionScope is `TRANSCRIPTION_EXTENSION_SCOPE_ALL`.

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<Update_Result>	The save result with scope diff summary.

Update_Result


Parameter	Type	Description
version	String	The version number after the update.
callTranscription	Object<Scope_Diff>	The scope change summary of the call transcription.
voicemailTranscription	Object<Scope_Diff>	The scope change summary of the voicemail transcription.

Scope_Diff


Parameter	Type	Description
addedUserIds	Array<String>	The user IDs that are added to the scope in this update.
removedUserIds	Array<String>	The user IDs that are removed from the scope in this update.

Example

Request example

PUT /uc-cconfig/api/v1/ai/transcriptions/settings HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MzYwOTgwMCwiaWF0IjoxNzkzNTg4MjAwLCJqdGkiOiJiNjQ1ZDk3YS03OWFlLTRjNGItOTA4Yi0wZDczOWNjZjg5MTMiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.E1mNLKH5D1o4bqvWeTv4vfA7KJuzxAFISGC5sxWJOxRwaCzggM3J44eREQ03u_9brsuXad2mqy_JeQcjO6CzoLk1amlggEOh88kzNemGAHH8IWpK50yttSvwdaI_ypINe6jX-SnjBrDhpE9yB-C-ad2_z8e5pO90LjwXPzYJQLZaPTZR_BsbpVzSQN_tJnreGZ3tpQFtLWrTiPRTZssG8dehPQbcRwEvbUYT3qC6gIuiOEGzwuQ8FdMPFtIfvwBQl0lbooWexrATXSScRJpAzq62TaSqXKOqhB2X9P7soRpjdBCCy5O7I88sAiOzW-vZFNu3jDfDju20ZaE7CTpdfQ
x-tenant-code: jint
Content-Type: application/json
{
  "version": "3",
  "callTranscription": {
    "enabled": true,
    "automaticTranscriptionEnabled": false,
    "serverType": "SERVER_TYPE_BUILT_IN",
    "language": "en",
    "extensionScope": "TRANSCRIPTION_EXTENSION_SCOPE_SPECIFIC",
    "userIds": [
      "338136731335409664"
    ]
  },
  "voicemailTranscription": {
    "enabled": true,
    "serverType": "SERVER_TYPE_BUILT_IN",
    "language": "en",
    "extensionScope": "TRANSCRIPTION_EXTENSION_SCOPE_SPECIFIC",
    "userIds": [
      "338136731335409664"
    ]
  }
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "e54a730c4ac7356d605ca6a68fe36889",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "version": "3",
    "callTranscription": {
      "addedUserIds": [],
      "removedUserIds": []
    },
    "voicemailTranscription": {
      "addedUserIds": [],
      "removedUserIds": []
    }
  }
}