Toggle Call Transcription

Manually starts or stops the transcription of an ongoing call.

Request URL

POST {base_url}/uc-cconfig/api/v1/ai/transcriptions/calls/{callId}/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.
Path parameters
Parameter Required Type Description
callId Yes String The ID of the call whose transcription is toggled. This is the call session ID of an ongoing call.
Body parameters
Parameter Required Type Description
action Yes String

The toggle action.

Valid value:

  • TRANSCRIPTION_TOGGLE_ACTION_START: Start transcription.
  • TRANSCRIPTION_TOGGLE_ACTION_STOP: Stop transcription.

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 The result of the operation.