删除AI对话任务
1. 接口描述
接口请求域名: trtc.intl.tencentcloudapi.com 。
成功开启对话后,可以使用此接口来停止对话任务。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DeleteVoiceConversation。 |
| Version | 是 | String | 公共参数,本接口取值:2019-07-22。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-hongkong, ap-singapore 。 |
| SdkAppId | 是 | Integer | TRTC的SdkAppId,和对话的房间所对应的SdkAppId相同。 |
| TaskId | 是 | String | 对话任务的唯一Id,在启动对话成功后会返回。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 对话任务的唯一Id。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 停止对话任务
输入示例
POST / HTTP/1.1
Host: trtc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteVoiceConversation
<公共请求参数>
{
"SdkAppId": 1400704311,
"TaskId": "-nG0xCFU7lbAnrSOAsc22iFg4v*************************b7S+nNiUvm6EPLEY7SC+VIAE."
}输出示例
{
"Response": {
"TaskId": "-nG0xCFU7lbAnrSOAsc22iFg4v*************************b7S+nNiUvm6EPLEY7SC+VIAE.",
"RequestId": "222dbe7b-e1e4-45e5-b08a-43699e3493e4"
}
}5. 开发者资源
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnRealNameAuthenticated | 未完成实名认证,不允许此操作。 |
| AuthFailure.UnauthorizedOperation | CAM鉴权失败。 |
| AuthFailure.UnsupportedOperation | 不支持该操作。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.OutOfRange | 参数超出范围。 |
| InvalidParameter.SdkAppId | SdkAppId参数错误。 |
| MissingParameter | 缺少参数错误。 |
| MissingParameter.RoomId | 缺少RoomId参数。 |
| MissingParameter.SdkAppId | 缺少SdkAppId参数。 |
| MissingParameter.TaskId | 缺少TaskId参数。 |
| MissingParameter.UserId | 缺少UserId参数。 |
| ResourceNotFound | 资源不存在。 |
