移除房间成员

更新时间: 2024/03/25 11:00:40

从指定房间中移除成员,即将该成员加入黑名单。

如果 URL 中未指定拉黑时长,则表示此房间内永久拉黑该成员,该成员会被移出此房间、且无法再次进入。适用于主播、房主或管理员踢人、拉黑等场景。

开通消息抄送服务后,若您成功调用此服务端接口移除房间成员,会触发 eventType=5(用户离开房间)的抄送。

URL

  • 请求方法:POST

  • URL:

    网易云信为该功能提供以下多个 API 请求地址,使用 V2 地址需在 URL 中指定 cid 或指定 cidduration,使用 V3 地址需在 URL 中指定 cname 或指定 cnameuid,您可以根据业务需求调用任一接口。

    • https://logic-dev.netease.im/v2/api/kicklist/{cid}/members/{uid}
    • https://logic-dev.netease.im/v2/api/kicklist/{cid}/members/{uid}/{duration}
    • https://logic-dev.netease.im/v3/api/kicklist/members?cname={cname}&uid={uid}
    • https://logic-dev.netease.im/v3/api/kicklist/members?cname={cname}&uid={uid}&duration={duration}

URL 中参数说明:

参数名称 类型 示例 描述
cid int64 6207760637435905 房间 ID。该 ID 为创建房间接口调用成功后返回的房间 ID。
仅在调用 V2 接口时需要设置。
uid int64 193992653091841 需要被移除出房间的用户 ID。
在 V2 和 V3 接口中均需要设置。
cname String abc 房间名称。仅在调用 V3 接口时需要设置。
duration Number 600 拉黑时长。单位为秒(s)。最短可设置为 3 秒钟,表示 3 秒钟后该成员可再次加入房间。
如果 URL 中未指定拉黑时长,则表示此房间内永久拉黑该成员,该成员无法再次进入这个房间。
在 V2 和 V3 接口中均需要设置。

接口请求频率

默认上限为 50 次/秒,若请求频率超出限制,可能会返回 429 错误码。
若您需要上调上限,请参考如何处理调用服务端 RESTful API 超出频率限制

请求参数

  • 请求中 Header 的设置请参考请求结构描述。

  • 该 API 的 Body 中无需指定任何请求参数。

返回参数

Body 中不返回任何参数。

示例

请求示例

https://logic-dev.netease.im/v2/api/kicklist/6207760637435905/members/193992653091841

https://logic-dev.netease.im/v3/api/kicklist/members?cname=abc&uid=193992653091841

正常返回示例

该接口返回的消息中,Header 中的 code 为 200,表示请求成功。

错误码

该接口仅在 HTTP header 中返回状态码,状态码列表请参考 header 中的 HTTP 状态码

此文档是否对你有帮助?
有帮助
去反馈
  • URL
  • 接口请求频率
  • 请求参数
  • 返回参数
  • 示例
  • 请求示例
  • 正常返回示例
  • 错误码