1. 接口描述
接口请求域名: trtc.tencentcloudapi.com 。
接口说明:
启动终端审核功能,完成房间内的音频审核。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateBasicModeration。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-22。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-shanghai 。 |
SdkAppId | 是 | Integer | TRTC的SdkAppId,和TRTC的房间所对应的SdkAppId相同。 示例值:140056784 |
RoomId | 是 | String | TRTC的RoomId,为TRTC房间所对应的RoomId。 示例值:67467 |
UserId | 是 | String | 目标审核用户id 示例值:wanjia1 |
RoomIdType | 否 | Integer | TRTC房间号的类型。【*注意】必须和TRTC的房间所对应的RoomId类型相同:0: 字符串类型的RoomId1: 32位整型的RoomId(默认) 示例值:1 |
AuditStorageParams | 否 | AuditStorageParams | 音频文件上传到云存储的参数 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 审核服务分配的任务ID。任务ID是对一次审核任务生命周期过程的唯一标识,结束任务时会失去意义。任务ID需要业务保存下来,作为下次针对这个任务操作的参数 示例值:-npVqpdU7pr3JUbUasDy5PLPQaHPhkPbIkDILoK-2OqyoZWQndibCtH88ztBhkWAhZCH9DwE. |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 发起基础审核任务
发起基础审核任务
输入示例
POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBasicModeration
<公共请求参数>
{
"SdkAppId": 1400188256,
"RoomId": "9236",
"UserId": "user_57481060"
}
输出示例
{
"Response": {
"RequestId": "292b38cf-205e-481b-87be-ce7df241223d",
"TaskId": "-nHp1XlU7sqylOUvA81n2e9Dynz7iLHbXHTMIoK-4pycoZWQndibXYkT4K2kvZeN3mIxUf+-RQE."
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
AuthFailure.UnRealNameAuthenticated | 未完成实名认证,不允许此操作。 |
AuthFailure.UnauthorizedOperation | CAM鉴权失败。 |
AuthFailure.UnsupportedOperation | 不支持该操作。 |
FailedOperation | 操作失败。 |
FailedOperation.CSUnsupportMethod | 云端切片方法不支持。 |
FailedOperation.RestrictedConcurrency | 单用户并发过载,请联系我们增大并发路数到合理值。 |
InternalError.CSInternalError | 云端切片内部服务错误 |
InvalidParameter.OutOfRange | 参数超出范围。 |
InvalidParameter.SdkAppId | SdkAppId参数错误。 |
MissingParameter.AccessKey | 缺少AccessKey参数。 |
MissingParameter.Bucket | 缺少Bucket参数。 |
MissingParameter.Region | 缺少Region参数。 |
MissingParameter.RoomId | 缺少RoomId参数。 |
MissingParameter.SdkAppId | 缺少SdkAppId参数。 |
MissingParameter.SecretKey | 缺少SecretKey参数。 |
MissingParameter.SliceParams | 缺少SliceParams参数。 |
MissingParameter.SliceStorageParams | 缺少SliceStorageParams参数。 |
MissingParameter.SliceType | 缺少SliceType参数。 |
MissingParameter.TaskId | 缺少TaskId参数。 |
MissingParameter.UserId | 缺少UserId参数。 |
MissingParameter.UserSig | 缺少UserSig参数。 |
MissingParameter.Vendor | 缺少Vendor参数。 |
UnsupportedOperation | 操作不支持。 |