云信服务端支持分页查询圈组中已创建的服务器。

URL

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

请求参数

• POST 请求中 Headers 的设置请参考API调用方式。
• POST 请求中 Body 的设置如下：

参数	类型	必须	说明
accid	String	是	操作者的 IM 帐号
timetag	Long	是	查询 timetag 之后加入的服务器，单位毫秒，传 0 表示查询首页。分页会按照加入时间倒序排序
limit	String	是	本次查询的数量上限，最大数量 200

示例

cURL 请求示例

curlcurl -X POST -H "AppKey: go9dnk**803mgq3" -H "Nonce: 4tgggergi**t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan&timetag=1558938768520&limit=10' 'https://api.netease.im/nimserver/qchat/getServerListPage.action'

返回示例

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
  "code":200, 
  "pageInfo": {
      "hasMore": true,  //是否需要查询下一页
      "nextTimetag": 1234  //查询下一页时需要的时间戳
      },  
  "serverInfos": [
    {
      "serverId": 123, //服务器唯一标识
      "name": "name", //名称
      "icon": "icon", //图标 
      "custom": "custom", //自定义扩展
      "owner": "zhangsan", //所有者的用户帐号
      "memberNumber": 1, //成员数量
      "inviteMode": 0, //邀请模式
      "applyMode": 0, //申请模式
      "channelNumber": 0, //频道数量
      "validFlag": 1, //有效标志：0-无效，1-有效
      "createTime": 1234, //创建时间
      "updateTime": 1234 //更新时间
    }, 
    {
      "serverId": 123, 
      "name": "name", 
      "icon": "icon", 
      "custom": "custom", 
      "owner": "zhangsan", 
      "memberNumber": 1, 
      "inviteMode": 0, 
      "applyMode": 0, 
      "channelNumber": 1, 
      "validFlag": 1, 
      "createTime": 1234, 
      "updateTime": 1234
    }
  ]
}

状态码

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

状态码	说明	处理建议
200	请求成功	-
403	非法操作或没有权限	检查是否已开通圈组功能
404	对象不存在	检查是否存在必传参数为空的问题 检查传入的 IM 账号是否存在
414	参数错误	根据提示信息，检查传入参数的格式和限制条件
416	调用频率超限	降低调用频率
431	HTTP 重复请求	-