API 参考
圈组

分页查询服务器成员列表

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

云信服务端提供 API,支持用户按时间分页查询服务器的成员列表。

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API调用方式
  • POST 请求中 Body 的设置如下:
参数类型必须说明
serverIdString服务器 ID
timetagString用户加入服务器时间,单位毫秒,如果传 0 表示查询首页,按照成员加入服务器时间的逆序进行分页查询
limitString本次查询的数量上限,最大数量 200
accidString待查询用户的 IM 帐号,如果传入校验该用户是否为服务器成员

返回参数

参数
说明
code 状态码
pageInfo 分页信息,hasMore:是否查询下一页,nextTimetag:查询下一页时需要的时间戳
serverMembers 返回的服务器成员列表,具体字段说明参见“修改自己的成员信息”接口返回参数中的 serverMember 字段说明

示例

cURL 请求示例

curlcurl -X POST -H "AppKey: go9dnk**lw0803mgq3" -H "Nonce: 4tggge**323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&timetag=1558938768520&limit=10' 'https://api.netease.im/nimserver/qchat/getServerMemberListPage.action'

返回示例

HTTP 响应:JSON

json"Content-Type": "application/json; charset=utf-8"
{
  "code":200,
  "pageInfo": {
      "hasMore": true,  //是否需要查询下一页
      "nextTimetag": 1234  //查询下一页时需要的时间戳
      },  
  "serverMembers": [  
    {
      "serverId": 123, //服务器唯一标识 
      "accid": "lisi", //成员的用户帐号
      "nick": "nick", //昵称
      "avatar": "avatar", //头像
      "custom": "custom", //自定义扩展
      "type": 0, //类型:0-普通成员,1-所有者
      "joinTime": 1234, //加入时间
      "inviter": "zhangsan", //邀请者的用户帐号
      "validFlag": 1, //有效标志:0-无效,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 对象不存在
  • 检查是否存在必传参数为空的问题
  • 检查传入的 IM 账号或服务器 ID 是否存在
414 参数错误 根据提示信息,检查传入参数的格式和限制条件
416 调用频率超限 降低调用频率
431 HTTP 重复请求 -
此文档是否对你有帮助?
有帮助
去反馈
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • cURL 请求示例
  • 返回示例
  • 状态码