Get AI Transcription Setting

Retrieves the AI transcription settings aggregate configuration, including the call transcription block and the voicemail transcription block.

Request URL

GET {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.

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<AI_Transcription_Setting> The AI transcription settings aggregate configuration.
AI_Transcription_Setting
Parameter Type Description
version String The optimistic-lock version number. This value must be passed back when updating.
callTranscription Object<Transcription_Block> The call transcription configuration block.
voicemailTranscription Object<Transcription_Block> The voicemail transcription configuration block.
Transcription_Block
Parameter Type Description
enabled Boolean

Whether the transcription type is enabled.

  • true: Enabled.
  • false: Disabled.
automaticTranscriptionEnabled Boolean Whether automatic transcription is enabled. This parameter is meaningful only for call transcription.
serverType String

The transcription server type:

  • SERVER_TYPE_BUILT_IN: Built-in transcription server.
  • SERVER_TYPE_CUSTOM: Custom transcription server.
language String The transcription language in BCP-47 format.
extensionScope String

The extension scope of the transcription configuration block:

  • TRANSCRIPTION_EXTENSION_SCOPE_ALL: All extensions.
  • TRANSCRIPTION_EXTENSION_SCOPE_SPECIFIC: Specific extensions, configured through userIds.
userIds Array<String> The list of user IDs that take effect when extensionScope is TRANSCRIPTION_EXTENSION_SCOPE_SPECIFIC.
quota Object<Transcription_Quota> The quota summary of the transcription.
Transcription_Quota
Parameter Type Description
used String The used quota.
limit String The quota limit. The value -1 indicates that there is no limit.

Example

Request example

GET /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

Response example

HTTP/1.1 200 OK
{
  "requestId": "fe14082b1dc83ef28806a82fef8e5482",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "version": "3",
    "callTranscription": {
      "enabled": true,
      "automaticTranscriptionEnabled": false,
      "serverType": "SERVER_TYPE_BUILT_IN",
      "language": "en",
      "extensionScope": "TRANSCRIPTION_EXTENSION_SCOPE_SPECIFIC",
      "userIds": [
        "338136731335409664"
      ],
      "quota": {
        "used": "1",
        "limit": "4"
      }
    },
    "voicemailTranscription": {
      "enabled": true,
      "automaticTranscriptionEnabled": false,
      "serverType": "SERVER_TYPE_BUILT_IN",
      "language": "en",
      "extensionScope": "TRANSCRIPTION_EXTENSION_SCOPE_SPECIFIC",
      "userIds": [
        "338136731335409664"
      ],
      "quota": {
        "used": "1",
        "limit": "-1"
      }
    }
  }
}