Update a CDR Summary

Updates the AI-generated summary of a CDR.

Request URL

POST {base_url}/uc-creport/api/v1/cdr/calltranscription/updatesummary

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
uid Yes String The UID of the CDR whose summary is updated. You can obtain the UID using the Query CDRs interface.
summary No String The updated summary content.
version No String The optimistic-lock version of the summary. You can obtain the version using the Get a CDR Summary 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<Update_Result> The result of the request.
Update_Result
Parameter Type Description
summary Object<CDR_Summary_Info> The updated summary of the CDR.
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.