云信服务端支持分页查询频道列表。

调用时机

圈组服务器内已存在频道，用户进入服务器后需要获取频道列表时。

URL

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

请求参数

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

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

参数	类型	必填	说明
serverId	Long	是	服务器 ID
timetag	Long	是	频道创建时间，单位毫秒，如果传 0 表示查询首页，分页查询按照创建时间倒序查询
limit	String	是	本次查询的数量上限，最大返回 200 条结果
accid	String	否	用户帐号，如果不传返回服务器下的频道，如果传入返回服务器下用户可查看的频道

返回参数

参数	说明
code	状态码
pageInfo	分页信息，hasMore：是否查询下一页，nextTimetag：查询下一页时需要的时间戳
channelInfos	返回的频道信息列表，具体字段说明参见修改频道基础信息的返回参数中的 channelInfo

示例

cURL 请求示例

curlcurl -X POST -H "AppKey: go9dnk**3mgq3" -H "Nonce: 4tgg**3t23t" -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/getChannelListPage.action'

返回示例

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
  "code":200,
  "pageInfo": {
      "hasMore": true,  //是否需要查询下一页
      "nextTimetag": 1234  //查询下一页时需要的时间戳
      },  
  "channelInfos": [
    {
      "channelId": 123, //频道唯一标识 
      "serverId": 123, //服务器唯一标识
      "name": "name", //频道名称
      "topic": "topic", //频道主题 
      "custom": "custom", //频道自定义扩展字段
      "type": 0, //类型：0-消息频道，1-实时互动频道，100-自定义频道
      "owner": "zhangsan", //所有者
      "viewMode": 0, //查看模式
      "validFlag": 1, //有效标志：0-无效，1-有效
      "createTime": 1234, //创建时间
      "updateTime": 1234 //更新时间
    }, 
    {
      "channelId": 123, 
      "serverId": 123, 
      "name": "name", 
      "topic": "topic", 
      "custom": "custom", 
      "type": 0, 
      "owner": "zhangsan", 
      "viewMode": 0, 
      "validFlag": 1, 
      "createTime": 1234, 
      "updateTime": 1234
    }
  ]
}

状态码

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

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