批量查询频道黑白名单身份组
更新时间: 2024/07/17 17:57:35
云信服务端支持批量查询频道黑白名单身份组。被加入黑名单或白名单的身份组即为黑白名单身份组。
功能介绍
如果传入的身份组,最终在查询到的 roleids 身份组列表中,则表示该身份组已被加入了频道的白名单或黑名单。
URL
httpPOST https://api.netease.im/nimserver/qchat/batchGetWhiteBlackIdentify.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参考API调用方式。
-
POST 请求中 Body 的设置如下:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
serverId | Long | 是 | 服务器 ID |
channelId | Long | 是 | 频道 ID |
accid | String | 是 | 操作者的 IM 账号 |
type | int | 是 | 1 表示白名单,2 表示黑名单 |
roleids | String | 是 | 服务器身份组 ID 列表,JSON Array格式,最多 100 个 |
返回参数
参数 | 说明 |
---|---|
code | 状态码 |
identities | 查询到的身份组列表,单个身份组所包含的字段信息参见修复服务器身份组的返回参数中 identify 的字段说明 |
示例
cURL 请求示例
curlcurl -X POST -H "AppKey: go9dnk49**0803mgq3" -H "Nonce: 4tggg**23t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&channelId=12222&type=1&timetag=0&roleids=["10"]' 'https://api.netease.im/nimserver/qchat/batchGetWhiteBlackIdentify.action'
返回示例
http 响应:json
json"Content-Type": "application/json; charset=utf-8"
{
"code": 200,
"identifies": [{
"ext": "ext",
"membercount": 1,
"createtime": 1,
"roleId": 1,
"auths": "{\"1\":-1, \"2\":1}",
"name": "name",
"icon": "icon",
"priority": 1,
"type": 1,
"updatetime": 1
}] //是一个数组,每一项都是一个服务器身份组信息
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参见状态码。
状态码 | 说明 | 处理建议 |
---|---|---|
200 | 请求成功 | - |
403 | 非法操作或没有权限 |
|
404 | 对象不存在 |
|
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
416 | 调用过于频道 | 降低调用频率 |
419 | 数量超限 | 检查 roleids 所包含的账号数量是否超过了上限 100 |
此文档是否对你有帮助?