IM 即时通讯
服务端
API 参考
圈组

分页查询频道黑白名单成员列表

更新时间: 2022/12/15 19:46:56

云信服务端支持按时间分页查询某个频道的黑白名单成员列表。

URL

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

请求参数

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

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

参数类型必须说明
serverIdLong服务器 ID
channelIdLong频道 ID
accidString操作者的 IM 账号,操作者需要拥有管理黑白名单的权限,否则将返回 403 错误码
typeString1 表示白名单,2 表示黑名单
timetagLong时间戳,单位:毫秒,如传 0 则表示查询最近的一页
limitString本次查询的条数上限

返回参数

参数 说明
code 状态码
pageInfo 分页信息,hasMore:是否查询下一页,nextTimetag:查询下一页时需要的时间戳
members 查询到的成员列表,包含的字段信息见分页查询频道成员列表接口的 members 字段说明

示例

cURL 请求示例

curl -X POST -H "AppKey: go9dnk**lw0803mgq3" -H "Nonce: 4tg**t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&channelId=12222&type=1&timetag=0&limit=10&accid=acc' 'https://api.netease.im/nimserver/qchat/queryWhiteBlackIdentifyUser.action'

返回示例

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "pageInfo": {
        "hasMore": true,  
        "nextTimetag": 1234 
    },
    "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 非法操作或没有权限
  • 检查是否已开通圈组功能
  • 检查传入的 accid 是否为当前服务器和频道的成员,如非成员则无权限查询
  • 检查操作者是否拥有管理黑白名单的权限
404 对象不存在
  • 检查是否存在必传参数为空的问题
  • 检查传入的服务器 ID 、频道 ID 或账号是否存在
414 参数错误 根据提示信息,检查传入参数的格式和限制条件
416 调用过于频道 降低调用频率
此文档是否对你有帮助?
有帮助
去反馈
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • cURL 请求示例
  • 返回示例
  • 状态码