踢人出群
更新时间: 2024/07/17 17:57:35
高级群踢人出群,需要提供群主或管理员账号 accid
和被踢除人的账号 accid
。
API 使用限制
单个应用中 1 秒内所有的高级群操作 API 合计最多可调用 100 次,超过后限制调用,会返回 416 错误码。
除发送群消息 API 外,其他所有高级群 API 都属于高级群操作 API。
URL
POST https://api.netease.im/nimserver/team/kick.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求参数
- POST 请求中 Headers 的设置请参考API 调用方式。
- POST 请求中 Body 的设置如下:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
tid | Long | 是 | 云信服务器产生,群唯一标识,创建群时会返回,最大长度 64 位长整型 |
owner | String | 是 | 群主或管理员帐号,accid,最大长度 32 位字符 |
member | String | 当移除单个成员时必填 | 被移除的用户账号 accid,最大长度 32 位字符 相对于 members,优先使用 member 参数 |
members | String | 当移除多个成员时必填 | 被移除的用户账号列表,["aaa","bbb"](JSONArray 对应的 accid,如果解析出错,会报 414)一次最多操作 200 人
|
attach | String | 否 | 自定义扩展字段,最大长度 512 位字符 |
返回参数
参数 | 类型 | 说明 |
---|---|---|
code | Integer | 状态码 |
faccid | String | 踢除失败的账号 ID 列表,会返回踢除失败的 accid 以及附言(msg) |
示例
请求示例(curl)
curlcurl -X POST -H "AppKey: go9dnk4***03mgq3" -H "Nonce: 4tggg**323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&member=lisi' 'https://api.netease.im/nimserver/team/kick.action'
请求成功返回示例
json"Content-Type": "application/json; charset=utf-8"
{
"code":200
"faccid":{ //如果踢除失败,会返回faccid
"accid":["a","b","c"], // 账号 list<String>
"msg":"team count exceed"
}
}
请求失败返回示例
"Content-Type": "application/json; charset=utf-8"
{
"code": 414, // 参数错误
"desc": "xxxx is empty"
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参见状态码。
状态码 | 说明 | 处理建议 |
---|---|---|
200 | 请求成功 | - |
403 | 禁止操作:
|
根据对应提示信息做出处理 |
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
416 | 调用频率超出限制 | 降低访问频率 |
500 | 服务出错 | - |
802 | 没有权限 | - |
806 | 人数超过规定限制: 创建者加群数量超过限制 [2,200] |
根据对应提示信息做出处理 |
此文档是否对你有帮助?