批量查询频道分组的黑白名单身份组
更新时间: 2024/07/17 17:57:35
批量查询频道分组黑白名单身份组。
URL
httpPOST http://api.netease.im/nimserver/qchat/batchGetCategoryWhiteBlackIdentify.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参考API 调用方式。
-
POST 请求中 Body 的设置如下:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
serverId | Long | 是 | 服务器唯一标识 |
categoryId | Long | 是 | 频道分组唯一标识 |
accid | String | 否 | 操作者accid,如果传,则会校验该账号对该频道分组是否有权限,否则不校验 |
type | Long | 是 | 1表示白名单,2表示黑名单 |
roleids | String | 是 | 服务器身份组id列表,JSONArray格式,最多100个 |
返回参数
参数 | 说明 |
---|---|
identifies | 黑名单身份组列表或白名单身份组列表,具体成员参数见下表 |
identifies 参数说明如下:
参数 | 类型 | 说明 |
---|---|---|
ext | String | 身份组的自定义扩展字段 |
membercount | Number | 身份组成员数量 |
createtime | Number | 创建时间 |
roleId | Integer | 身份组 ID |
auths | String | 身份组的权限项,key为权限项的枚举值,value 为 1 开启(身份组成员拥有该权限),-1 关闭(身份组成员无该权限) |
name | String | 身份组名称 |
icon | String | 身份组图标的 URL |
priority | String | 身份组的优先级,正数。数字越小,优先级越大,最小为1,everyone 身份组为 0,但不参与比较 |
type | Integer | 身份组类型,1 为 @everyone 身份组,2 为自定义身份组 |
updatetime | String | 更新时间 |
示例
cURL 请求示例
curlcurl -X POST -H "AppKey: go9dnk49bk**lw0803mgq3" -H "Nonce: 4tggg**3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&categoryId=12222&type=1&timetag=0&roleids=["10"]' 'http://api.netease.im/nimserver/qchat/batchGetCategoryWhiteBlackIdentify.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、414、416、419、500
此文档是否对你有帮助?