Get a Platform CDR Summary

Retrieves the AI-generated summary of a platform CDR, including the summary of the whole call and the summary of each call leg.

Request URL

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

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<CDR_Summary_Result> The summary of the CDR.
CDR_Summary_Result
Parameter Type Description
callSummary Object<Platform_CDR_Summary_Info> The summary of the whole call. This parameter is null when the call summary is not generated.
legSummaries Array<Platform_CDR_Leg_Summary_Item> The summary of each call leg.
Platform_CDR_Summary_Info
Parameter Type Description
id Integer The ID of the summary.
summary String The summary content.
createdAt String The time when the summary was created, in Unix timestamp format.
updatedAt String The time when the summary was last updated, in Unix timestamp format.
templateId String The ID of the summary template used to generate the summary.
status String

The generation status of the summary:

  • NOT_GENERATED: The summary is not generated.
  • PENDING: The summary waits to be generated (leg level).
  • PENDING_SEGMENTS: The call segments wait to be ready (call level).
  • GENERATING: The summary is being generated.
  • COMPLETED: The summary is generated.
  • PARTIAL_COMPLETED: The summary is partially generated after a timeout (call level).
  • FAILED: The generation failed.
version String The optimistic-lock version of the summary. You must pass this value when you update the summary.
manuallyEdited Boolean

Whether the summary has been manually edited.

  • true: The summary has been manually edited.
  • false: The summary has not been manually edited.
Platform_CDR_Leg_Summary_Item
Parameter Type Description
leg Object<Platform_CDR_Leg_Info> The basic information of the call leg.
summary Object<Platform_CDR_Summary_Info> The summary of the call leg. This parameter is null when the leg summary is not generated.
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.

Example

Request example

GET /uc-creport/api/v1/platform/cdr/calltranscription/summary?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": "4cca9a62307177edaaf334baf124d76f",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "callSummary": null,
    "legSummaries": [
      {
        "leg": {
          "id": "371139016054157313",
          "mainId": "371139016054157312",
          "transactionId": "31001"
        },
        "summary": null
      },
      {
        "leg": {
          "id": "371139016054157314",
          "mainId": "371139016054157312",
          "transactionId": "20002"
        },
        "summary": null
      }
    ]
  }
}