批量查询频道黑白名单成员
更新时间: 2024/07/17 17:57:35
云信服务端支持通过传入一批 IM 账号查询这些账号是否被加入了频道的黑白名单。
功能介绍
如果传入的 IM 账号,最终在查询到的 members 成员列表中,则表示该账号已被加入了频道的白名单或黑名单。
URL
httpPOST https://api.netease.im/nimserver/qchat/batchGetWhiteBlackIdentifyUser.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 表示黑名单 |
accids | String | 是 | 被查询的 IM 账号列表,JSON Array 格式,最多 100 个 |
返回参数
参数 | 说明 |
---|---|
code | 状态码 |
members | 成员信息,具体的字段信息参见分页查询频道成员列表的返回参数中的 members 字段说明 |
示例
cURL 请求示例
curlcurl -X POST -H "AppKey: go9dnk**03mgq3" -H "Nonce: 4tggg**3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&channelId=12222&type=1&timetag=0&accids=["asas"]' 'https://api.netease.im/nimserver/qchat/batchGetWhiteBlackIdentifyUser.action'
返回示例
http 响应:json
json"Content-Type": "application/json; charset=utf-8"
{
"code": 200,
"members": [
{
"serverId": 123,
"accid": "lisi", /
"nick": "nick",
"avatar": "avatar",
"custom": "custom",
"type": 0,
"joinTime": 1234,
"inviter": "zhangsan",
"validFlag": 1,
"createTime": 1234,
"updateTime": 1234
},
{
"serverId": 123,
"accid": "lisi",
"nick": "nick",
"avatar": "avatar",
"custom": "custom",
"type": 0,
"joinTime": 1234,
"inviter": "zhangsan",
"validFlag": 1,
"createTime": 1234,
"updateTime": 1234
}
] //是一个数组,每一项都是一个服务器成员信息
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参见状态码。
状态码 | 说明 | 处理建议 |
---|---|---|
200 | 请求成功 | - |
403 | 非法操作或没有权限 |
|
404 | 对象不存在 |
|
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
416 | 调用过于频道 | 降低调用频率 |
419 | 数量超限 | 检查 accids 所包含的账号数量是否超过了上限 100 |
此文档是否对你有帮助?