Domain name for API request: trtc.intl.tencentcloudapi.com.
API description:
Enable the cloud transcription feature.
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: CreateCloudTranscription. |
| 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 corresponding to the transcribed room. |
| RoomId | Yes | String | RoomId of TRTC, which is the RoomId corresponding to the transcribed TRTC room. Note: The room ID type defaults to integer. If the room ID type is string, specify it via RoomIdType. |
| RoomIdType | Yes | Integer | Room information RoomType must be the same as the RoomId type of the corresponding transcribed room. 0 indicates an integer type room ID, and 1 indicates a string Room Number. |
| TranscriptionParam | Yes | TranscriptionParam | Parameters for transcribe service to join TRTC room. |
| AsrParam | Yes | AsrParam | Parameters used by the ASR transcribe service. |
| TranslationParam | No | TranslationParam | Translation parameters used for transcription. |
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | String | A unique identifier for the transcription task, generated by the Tencent Cloud server. The TaskID parameter is required for all subsequent query and stop requests. |
| 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: CreateCloudTranscription
<Common request parameters>
{
"SdkAppId": 14000000,
"RoomId": "295000",
"RoomIdType": 0,
"TranscriptionParam": {
"UserId": "trtc_test_1",
"UserSig": "eJjdaVgrxCdYrzkx*************BLATRT",
"SubscribeList": [
{
"UserId": "user_1"
}
],
"MaxIdleTime": 30,
"SendCustomMode": 2
},
"AsrParam": {
"Lang": "16k_zh_en",
"VadSilenceTime": 2000
},
"TranslationParam": {
"TargetLang": [
"en"
]
}
}
{
"Response": {
"TaskId": "-nE5dafd3iq51******41fnF8bp2NI65pgE.",
"RequestId": "f98cb56d-2c70******b0-213ee0ef73ac"
}
}
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.OutOfRange | Parameter value is out of range. |
| InvalidParameter.SdkAppId | SdkAppId is incorrect. |
| MissingParameter | Missing parameter. |
| MissingParameter.ASRLang | Missing required parameter: Lang (ASR model). |
| MissingParameter.AsrParam | Missing required parameter: AsrParam. |
| MissingParameter.Region | Region parameter missing. |
| MissingParameter.RoomId | RoomId is missing. |
| MissingParameter.SdkAppId | SdkAppId is missing. |
| MissingParameter.TranscriptionParam | The TranscriptionParam parameter is required. |
| MissingParameter.UserId | Missing UserId parameter. |
| MissingParameter.UserSig | UserSig parameter missing. |
| UnsupportedOperation | Unsupported operation. |
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