API 参考
圈组

批量查询频道分组的黑白名单成员

更新时间: 2024/07/17 17:57:35

批量查询频道分组黑白名单成员。

URL

httpPOST http://api.netease.im/nimserver/qchat/batchGetCategoryWhiteBlackIdentifyUser.action  HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8

请求参数

  • POST 请求中 Headers 的设置请参考API 调用方式

  • POST 请求中 Body 的设置如下:

参数类型必须说明
serverIdLong服务器唯一标识
categoryIdLong频道分组唯一标识
accidString操作者accid,如果传,则会校验该账号对该频道分组是否有权限,否则不校验
typeLong1表示白名单,2表示黑名单
accidsString被查询的accid列表,JSONArray格式,最多100个

返回参数

参数 说明
members 黑名单成员列表或白名单列表,具体成员参数见下表

members 参数说明如下

参数 类型 说明
serverId Long 成员所属的服务器的 ID
accid String 成员的 IM 账号
nick String 成员的昵称
avatar String 成员的头像的 URL
custom String 自定义字段
type Integer 服务器成员类型,0-普通成员,1-所有者
joinTime Long 成员被加入服务器的时间
inviter String 邀请该成员的用户的 IM 账号
validFlag Integer 有效标志,0-无效,1-有效
createTime Long 创建时间
updateTime Long 更新时间

示例

cURL 请求示例

curlcurl -X POST -H "AppKey: go9dnk4**lw0803mgq3" -H "Nonce: 4tggger**3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&categoryId=12222&type=1&timetag=0&accids=["asas"]' 'http://api.netease.im/nimserver/qchat/batchGetCategoryWhiteBlackIdentifyUser.action'

返回示例

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
        }
    ] //是一个数组,每一项都是一个服务器成员的信息
}

状态码

该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参见状态码

200、403、414、416、419、500

此文档是否对你有帮助?
有帮助
去反馈
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • cURL 请求示例
  • 返回示例
  • 状态码