Query Platform CDR Transcription Records

Queries the transcription records of a platform CDR and returns the transcription records of each call leg.

Request URL

GET {base_url}/uc-creport/api/v1/platform/cdr/calltranscription/transcription

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.
Query parameters
Parameter Required Type Description
uid Yes String The UID of the CDR. You can obtain the UID using the Query Platform CDRs 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<Transcription_Records_Result> The transcription records of the CDR.
Transcription_Records_Result
Parameter Type Description
legRecords Array<Platform_CDR_Leg_Records_Item> The transcription records of each call leg.
Platform_CDR_Leg_Records_Item
Parameter Type Description
leg Object<Platform_CDR_Leg_Info> The basic information of the call leg.
records Array<Transcription_Record> The transcription records of the call leg.
effectiveSource String

The source of the displayed transcription:

  • NONE
  • LIVE
  • RECORDING

An empty string indicates that no transcription source exists.
displaySessionId String The ID of the display session.
displaySessionStatus String The status of the display session. An empty string indicates that no display session exists.
recordingTranscriptionStatus String

The status of the recording transcription task:

  • NOT_SUBMITTED
  • PENDING
  • PROCESSING
  • COMPLETED
  • FAILED

An empty string indicates that no transcription task exists.
liveCoverageStatus String

The coverage of the live transcription over the call:

  • UNSPECIFIED: No live transcription.
  • COVERED: The call is fully covered by the live transcription.
  • INSUFFICIENT: The live transcription does not fully cover the call.
  • UNDETERMINED: The coverage cannot be determined.

An empty string indicates that the coverage is not applicable.
Platform_CDR_Leg_Info
Parameter Type Description
id String The ID of the CDR leg record.
mainId String The ID of the associated main record.
transactionId String The transaction ID, which is used to associate multiple call legs.
Transcription_Record
Parameter Type Description
id String The ID of the transcription record.
content String The transcribed text content.
createdAt String The time when the transcription record was created, in Unix timestamp format.
timestamp String The time of the speech segment, in Unix timestamp format.
duration Integer The duration of the speech segment, in seconds.
sourceNumber String The number of the speaker.
type String The type of the speaker.
avatar String The avatar URL of the speaker.
name String The display name of the speaker.
confidence Number The confidence score of the transcription, ranging from 0 to 1.
absEndTimeMs String The absolute end time of the speech segment, in Unix timestamp format (milliseconds).

Example

Request example

GET /uc-creport/api/v1/platform/cdr/calltranscription/transcription?uid=20261021113356LG1BE HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MzM2MDcxNCwiaWF0IjoxNzkzMzM5MTE0LCJqdGkiOiIwYzU4YTVjMS1hNTMwLTQ1MjUtOTMzMS1hMTQ1NzQ1MjkxZTQiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.rd9xVGzJcc2NyEZ1PJtMnMtmk4-ovkSPt7c1z75SvaND72UXsHLJ4pN-I83fEJRU06MFrSBRWsU4vUzaZ4nikEmUzHfuTuXARORPBf-SGvh65FwPR6nPB3a9DeWQVOToRukOE71hgJrY8n9d0z8W8wFFc8_7d0Uv4J9CZqZFK073YAhzoZCG6hQzsI_u9Z5MzGRiLbMotGM1YGejEOKCswE3MuiXy_Ka9bUNTw9ISlAYFl0V52_JXYGPmpc3zw-TWTK1J8FCMysvR4QD6KTPoY9MHOfzvD1GiQCWiFuuI2DipfxCWop5I4Lg1qzrXV5W-MVieZYaD0kwFcvmj78xOw

Response example

HTTP/1.1 200 OK
{
  "requestId": "a17b5644efb5739453d0232b4104e97e",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "legRecords": [
      {
        "leg": {
          "id": "371139016054157313",
          "mainId": "371139016054157312",
          "transactionId": "31001"
        },
        "records": [],
        "effectiveSource": "",
        "displaySessionId": "0",
        "displaySessionStatus": "",
        "recordingTranscriptionStatus": "",
        "liveCoverageStatus": ""
      },
      {
        "leg": {
          "id": "371139016054157314",
          "mainId": "371139016054157312",
          "transactionId": "20002"
        },
        "records": [],
        "effectiveSource": "",
        "displaySessionId": "0",
        "displaySessionStatus": "",
        "recordingTranscriptionStatus": "",
        "liveCoverageStatus": ""
      }
    ]
  }
}