踢出成员
更新时间: 2024/07/17 17:57:35
云信服务端提供 API, 支持将服务器的一些成员踢出。
功能介绍
拥有“踢出他人权限”的服务器成员,可调用本 API 一次性将最多 200 位其他成员踢出服务器。踢人者和被踢者,都将收到“踢出服务器成员”(SERVER_MEMBER_KICK(12)
)的系统通知。被踢出的用户,将不再能进入服务器和接收服务器内的消息和系统通知。
如果您的应用需要其他服务器成员也能够接收该系统通知,请通过云信官网提供的联系方式咨询商务经理开通。开通后,其他服务器成员接收该系统通知的条件,参见服务器相关事件通知。
URL
httpPOST https://api.netease.im/nimserver/qchat/kickServerMember.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8
请求参数
- POST 请求中 Headers 的设置请参考API调用方式。
- POST 请求中 Body 的设置如下:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
accid | String | 是 | 操作者的 IM 帐号 |
serverId | Long | 是 | 服务器 ID |
kickedAccids | JSON Array | 是 | 被踢出者的 IM 帐号列表,JSON Array 格式,最大数量 200
|
示例
cURL 请求示例
curlcurl -X POST -H "AppKey: go9dnk49bk**03mgq3" -H "Nonce: 4tggg**23t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan&serverId=1513535&kickedAccids=["lisi","wangwu"]' 'https://api.netease.im/nimserver/qchat/kickServerMember.action'
返回示例
HTTP 响应:JSON
json"Content-Type": "application/json; charset=utf-8"
{
"code":200
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务强相关的状态码。完整状态码请参见状态码。
状态码 | 说明 | 处理建议 |
---|---|---|
200 | 请求成功 | - |
403 | 非法操作或没有权限 |
|
404 | 对象不存在 |
|
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
416 | 调用频率超限 | 降低调用频率 |
431 | HTTP 重复请求 | - |
此文档是否对你有帮助?