结束实时互动

更新时间: 2025/04/01 15:52:25

调用该接口结束一个实时互动任务。

如果您需要使用该接口,请 提交工单 联系网易云信技术支持工程师开通。

请求信息

请求 URL

客户端 API 调用示例请参考 基于 RTC SDK 实现音视频 AI 数字人互动

服务端 API 调用
  • 请求方法:POST
  • URL:https://rtc-ai.yunxinapi.com/v1/api/task/close
客户端 API 调用
  • 请求方法:POST
  • URL:https://rtc-ai.yunxinapi.com/ai/task/close

请求头参数

服务端 API 调用

请求头部的参数说明请参考 请求结构

客户端 API 调用
参数名称
类型
是否必选 说明
AppKey String 请登录 网易云信控制台 查看您的应用对应的 AppKey,具体请参考 创建应用并获取 AppKey
Token String 客户端向用户服务器请求并获取的 Token,具体请参考 获取 Token
Cname String 获取 Token 时使用的 channelName,即 RTC 房间名称。
Uid String 获取 Token 时使用的 uid,即用户在您应用中的 ID。

请求体参数

参数名称 类型 是否必选 示例 说明
cid Number 1144509608259296 房间 ID。
该 ID 为创建 AI 实时互动接口调用成功后返回的房间 ID
taskType Int 7 服务器任务类型。实时互动固定为 7。
taskId String 2a784467d647bb87b60b719f6fa56333 任务唯一标识符,房间内唯一。
调用创建 AI 实时互动接口后,可在返回 Body 中获取 taskId。

请求示例

JSON{
    "cid": 1144509608259296,
    "taskType": 7,
    "taskId": "2a784467d647bb87b60b719f6fa56333"
}

响应信息

响应参数

参数名称
类型 示例 描述
code int 200 状态码,200 表示成功,具体请参考下文状态码。

响应示例

JSON{
    "code":200,
    "errmsg":"",
}

状态码

  • 成功返回 code:返回内容中,code200 表示调用正常。
  • 异常返回 code:若 code 为其他值,请根据 codeerrmsg错误码和状态码 查看问题原因。
此文档是否对你有帮助?
有帮助
去反馈
  • 请求信息
  • 请求 URL
  • 请求头参数
  • 请求体参数
  • 请求示例
  • 响应信息
  • 响应参数
  • 响应示例
  • 状态码