API 参考
圈组

分页查询封禁成员列表

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

云信服务端支持按时间分页查询某个服务器的被封禁成员列表。

URL

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

请求参数

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

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

参数类型必须说明
serverIdLong服务器 ID
timetagLong时间戳,毫秒对应的字符串。如需从近及远查询,第一次查询时 timgtag 传 0, 第二次传第一页最后一条的时间戳
limitString本次查询的条数上限,默认和最大都为 100
accidString用户的 IM 帐号。如传入则检验用户是否在服务器内

示例

请求示例(cURL)

curl -X POST -H "AppKey: go9dnk49bk**803mgq3" -H "Nonce: 4tggger**23t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&timetag=1558938768520&limit=10' 'http://imtest.netease.im/nimserver/qchat/getServerMemberBanListPage.action'

返回示例

请求成功的返回示例如下。

{
  "code": 200, //状态码
  "pageInfo": { //分页信息
      "hasMore": true, //是否需要再查下一页
      "nextTimetag": 1234 //查询下一页时需要的timetag
  },
  "serverMemberBans": [ //查询到的封禁成员列表
      {
          "banTime": 1660902890827, //成员被封禁的时间
          "validFlag": 1, //有效标志:0-无效,1-有效
          "createTime": 1660902890827, //服务器创建时间
          "custom": "custom", //自定义字段
          "accid": "accid", // 被封禁成员的云信IM账号
          "updateTime": 1660902890827, //封禁状态更新时间
          "serverId": 867746856 // 服务器ID
      }
  ]
}

状态码

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

状态码 说明 处理建议
200 请求成功 -
403 非法操作或没有权限 检查是否已开通圈组功能
404 对象不存在
  • 检查是否存在必传参数为空的问题
  • 检查传入的 IM 账号或服务器 ID 是否存在
414 参数错误 根据提示信息,检查传入参数的格式和限制条件
416 调用频率超限 降低调用频率
431 HTTP 重复请求 -
此文档是否对你有帮助?
有帮助
去反馈
  • URL
  • 请求参数
  • 示例
  • 请求示例(cURL)
  • 返回示例
  • 状态码