Trigger a Call Log Summary

Triggers the generation of an AI summary for a call log.

Request URL

POST {base_url}/uc-creport/api/v1/calllog/calltranscription/trigger-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.
Body parameters
Parameter Required Type Description
id Yes String The ID of the call log whose summary is generated. You can obtain the ID using the Query Call Logs interface.
templateId Yes String The ID of the summary template used to generate the summary. You can obtain the ID using the Query Summary Templates 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<Trigger_Summary_Result> The result of the request.
Trigger_Summary_Result
Parameter Type Description
status String

The acceptance status of the request:

  • ACCEPTED: The summary generation task is accepted and runs asynchronously.
  • REJECTED: The request is rejected.
rejectReason String The reason why the request is rejected. This parameter is returned only when status is REJECTED.
taskId String The ID of the asynchronous summary generation task. This parameter is returned only when status is ACCEPTED.