Domain name for API request: trtc.intl.tencentcloudapi.com.
This API is used to query the transcription status after starting a transcription task. It is effective only when the transcription task is in process. Querying after termination will return an error.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeCloudTranscription. |
| Version | Yes | String | Common Params. The value used for this API: 2019-07-22. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou, ap-hongkong, ap-singapore. |
| SdkAppId | Yes | Integer | SDKAppId of TRTC, which is the same as the SDKAppId of the room being transcribed. |
| TaskId | Yes | String | The unique Id of the transcription task will be returned upon successful startup. |
| Parameter Name | Type | Description |
|---|---|---|
| StartTime | Integer | Time of starting the transcription task. |
| Status | String | Transcription task status. - Idle: Indicates the current transcription task is idle. - InProgress: Indicates the current transcription task is in progress. - Exited: Indicates the current transcription task is in the process of exiting. |
| TaskId | String | Unique Id of the transcribe task. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: trtc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCloudTranscription
<Common request parameters>
{
"TaskId": "m9-bVVU7nhKM5X3GsED6KNGVG********ndibWSn631uT6pbhE4PcPDSsggE.",
"SdkAppId": 1400000000
}
{
"Response": {
"StartTime": 1772433534515,
"Status": "Idle",
"RequestId": "f83001c5-7e3c-dfac-ba3e-236bf063c8d1",
"TaskId": "m9-bVVU7nhKM5X3GsED6KNGVG********ndibWSn631uT6pbhE4PcPDSsggE."
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| AuthFailure.UnauthorizedOperation | CAM authentication failed. |
| AuthFailure.UnsupportedOperation | Unsupported operation. |
| FailedOperation | Operation failed. |
| FailedOperation.CTUnsupportMethod | The cloud transcription method does not support this. |
| InternalError | Internal error. |
| InternalError.CTInternalError | Internal errors. |
| InvalidParameter | Parameter error. |
| InvalidParameter.SdkAppId | SdkAppId is incorrect. |
| MissingParameter.RoomId | RoomId is missing. |
| MissingParameter.SdkAppId | SdkAppId is missing. |
| MissingParameter.TaskId | TaskId parameter is missing. |
| MissingParameter.UserId | Missing UserId parameter. |
| ResourceNotFound | The resource does not exist. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback