分页查询服务器下频道分组信息。

URL

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

请求参数

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

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

参数	类型	必须	说明
serverId	Long	是	服务器唯一标识
timetag	Long	是	频道分组创建时间，单位毫秒，如果传0表示查询最近的一页，分页查询按照创建时间逆序
limit	Long	是	本次查询的数量上限
accid	String	否	操作者accid，如果不传返回服务器下频道分组，如果传入返回服务器下用户可查看的频道分组
sortField	Integer	否	排序字段。1 为自定义排序字段；其他可自行赋值。默认为“其他”。
pageToken	String	否	分页参数，使用上一次请求成功返回的分页标识。该字段只有 "sortField"=1 时才生效。

返回参数

参数	说明
pageInfo	分页信息，具体见下表
categoryInfos	频道分组列表信息，具体见下表

pageInfo 参数说明如下：

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

categoryInfos 参数说明如下

参数	类型	说明
categoryId	Long	频道分组 ID
serverId	Long	服务器 ID
name	String	频道分组名称
custom	String	频道分组自定义扩展字段
owner	String	服务器所有者
viewMode	Integer	频道的查看模式，0-公开模式(默认)，1-私密模式
channelNumber	Integer	频道数量
validFlag	Integer	有效标志：0-无效，1-有效
createTime	Long	创建时间
updateTime	Long	更新时间
reorderweight	Long	频道分组自定义排序权重值

示例

cURL 请求示例

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

返回示例

http 响应:json

json
"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "pageInfo": {
        "hasMore": true,  //是否有下一页
        "nextTimetag": 1234,  //查询下一页时需要的timetag
        "nextPageToken": ""
    },
    "categoryInfos":  [{
        "categoryId": 123,
        "serverId": 456,
        "name": "name",
        "custom": "custom",
        "owner": "zhangsan",
        "viewMode": 0,
        "channelNumber": 10,
        "validFlag": 1,
        "createTime": 1655197548301,
        "updateTime": 1655197548301,
        "reorderweight": 0
    }] //是一个数组，每一项都是一个频道分组信息
}

状态码

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

200、403、414、416、431、500