API 参考
圈组

分页查询频道分组下的频道列表

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

分页查询频道分组下频道信息。

URL

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

请求参数

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

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

参数类型必须说明
serverIdLong服务器唯一标识
categoryIdLong频道分组唯一标识
timetagLong频道分组创建时间,单位毫秒,如果传0表示查询最近的一页,分页查询按照创建时间逆序
limitString本次查询的数量上限
accidString操作者accid,如果传,则会校验该账号对该频道分组是否有权限,否则不校验

返回参数

参数 类型 说明
pageInfo Object 分页信息,具体见下表
channelInfos Array of objects 频道分组列表信息,具体参见修改频道基础信息的返回参数中的 channelInfo

pageInfo 参数说明如下:

参数 类型 说明
hasMore Boolean 是否有下一页
nextTimetag 查询下一页时需要传入的时间戳

示例

cURL 请求示例

curlcurl -X POST -H "AppKey: go9dnk49b**803mgq3" -H "Nonce: 4tggge**3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&categoryId=12222&timetag=1558938768520&limit=10' 'http://api.netease.im/nimserver/qchat/getChannelListByChannelCategoryPage.action'

返回示例

json"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "pageInfo": {
        "hasMore": true,
        "nextTimetag": 1234
    },
    "channelInfos": [
        {
            "owner": "wm1",
            "validFlag": 1,
            "reorderweight": 101,
            "updateTime": 1655197548301,
            "type": 0,
            "viewMode": 1,
            "visitorMode": 0,
            "serverId": 2704441,
            "createTime": 1655197548301,
            "name": "chl-2704441-2k",
            "syncMode": 0,
            "topic": "test",
            "channelId": 2459262,
            "categoryId": 0
        }
    ] //是一个数组,每一项都是一个频道信息
}

状态码

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

200、403、414、416、431、500

此文档是否对你有帮助?
有帮助
去反馈
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • cURL 请求示例
  • 返回示例
  • 状态码