查询未在频道分组中的频道信息
更新时间: 2024/07/17 17:57:34
云信服务端支持分页查询不在频道分组中的频道信息列表。
URL
httpPOST https://api.netease.im/nimserver/qchat/queryHasNoCategoryChannelPage.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参考 API 调用方式。
-
POST 请求中 Body 的设置如下:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
serverId | Long | 是 | 服务器 ID |
accountId | Long | 是 | 用户帐号 ID,返回服务器下用户可查看的频道分组 |
limit | Integer | 否 | 本次查询的数量上限,最多返回 200 条结果 |
pageToken | String | 否 | 分页参数,使用上一次请求成功返回的分页标识 |
返回参数
参数 | 说明 |
---|---|
code | 状态码 |
pageInfo | 分页信息,具体见下表 |
data | 频道列表信息,具体见下表 |
pageInfo 参数说明如下:
参数 | 类型 | 说明 |
---|---|---|
hasMore | Boolean | 是否有下一页 |
nextPageToken | String | 分页标识 |
data 参数说明如下
参数 | 类型 | 说明 |
---|---|---|
channelId | Long | 频道 ID |
serverId | Long | 服务器 ID |
name | String | 频道名称 |
topic | String | 频道主题 |
custom | String | 频道自定义扩展字段 |
owner | String | 服务器所有者 |
type | Integer | 频道类型,0-消息频道,1-实时互动频道,100-自定义频道 |
viewMode | Integer | 频道的查看模式,0-公开模式(默认),1-私密模式 |
validFlag | Integer | 有效标志:0-无效,1-有效 |
createTime | Long | 创建时间 |
updateTime | 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&accountId=zhangsan&limit=10' 'http://api.netease.im/nimserver/qchat/queryHasNoCategoryChannelPage.action'
返回示例
json
"Content-Type": "application/json; charset=utf-8"
{
"code":200,
"pageInfo":{
"hasMore":true,
"nextPageToken":"dsfdsfsdf"
},
"data": [
{
"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 //更新时间
}
]
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参见 状态码。
200、403、404、414、416、431
此文档是否对你有帮助?