查询房间移除成员列表
更新时间: 2024/03/25 11:00:40
查看指定房间中,所有被移除的成员列表。
URL
-
请求方法:GET
-
URL:
网易云信为该功能提供以下两个 API 请求地址,使用 V2 地址需在 URL 中指定
cid
,使用 V3 地址需在 URL 中指定cname
,您可以根据业务需求调用任一接口。https://logic-dev.netease.im/v2/api/kicklist/{cid}
https://logic-dev.netease.im/v3/api/kicklist?cname={cname}
URL 中参数说明:
参数名称 | 类型 | 示例 | 描述 |
---|---|---|---|
cid | int64 | 6207760637435905 | 房间 ID。该 ID 为 创建房间 接口调用成功后返回的房间 ID。 仅在调用 V2 接口时需要设置。 |
cname | String | abc | 房间名称。仅在调用 V3 接口时需要设置。 |
接口请求频率
默认上限为 50 次/秒,若请求频率超出限制,可能会返回 429 错误码。
若您需要上调上限,请参考如何处理调用服务端 RESTful API 超出频率限制。
请求参数
-
请求中 Header 的设置请参考请求结构描述。
-
该 API 的 Body 中无需指定任何请求参数。
返回参数
参数名称 | 类型 | 示例 | 描述 |
---|---|---|---|
uids | int64 | - | 被移除出房间的成员用户 ID 列表。 |
示例
请求示例
https://logic-dev.netease.im/v2/api/kicklist/6207760637435905
https://logic-dev.netease.im/v3/api/kicklist?cname=abc
正常返回示例
{
"uids":[
193992653091841,
193992653091842
]
}
错误码
该接口仅在 HTTP header 中返回状态码,状态码列表请参考 header 中的 HTTP 状态码。
此文档是否对你有帮助?