批量查询频道信息
更新时间: 2024/07/17 17:57:35
云信服务端支持传入最多 200 个频道 ID 查询这些频道的信息,如频道主题、频道类型、所属的频道分组的 ID 等。
URL
httpPOST https://api.netease.im/nimserver/qchat/getChannels.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参考API调用方式。
-
POST 请求中 Body 的设置如下:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
channelIds | JSON Array | 是 | 频道 ID 列表,JSON Array 格式,最大数量 200,示例:["123","234"] |
返回参数
参数 |
说明 |
---|---|
code | 状态码 |
channelInfos | 返回的频道信息列表,具体字段说明参见修改频道基础信息的返回参数中的 channelInfo |
示例
curl请求示例
curlcurl -X POST -H "AppKey: go9dn**glw0803mgq3" -H "Nonce: 4tgg**3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'channelIds=["123","234"]' 'https://api.netease.im/nimserver/qchat/getChannels.action'
返回示例
http 响应:json
json"Content-Type": "application/json; charset=utf-8"
{
"channelInfos": [
{
"owner": "wm1", //所有者
"validFlag": 1, //有效标志:0-无效,1-有效
"reorderweight": 101, //频道自定义排序权重值
"updateTime": 1655197548301, //更新时间
"type": 0, //频道类型:0-消息频道,1-实时互动频道,100-自定义频道
"viewMode": 1, //查看模式
"serverId": 2704441, //服务器唯一标识
"createTime": 1655197548301, //创建时间
"name": "chl-2704441-2k", //频道名称
"syncMode": 0, // 频道分组同步模式
"topic": "test", //频道主题
"channelId": 2459262, //频道唯一标识
"categoryId": 0 //所属的频道分组的 ID
}
],
"code": 200
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参见状态码。
状态码 | 说明 | 处理建议 |
---|---|---|
200 | 请求成功 | - |
403 | 非法操作或没有权限 | 检查是否已开通圈组功能 |
404 | 对象不存在 |
|
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
416 | 调用频率超限 | 降低调用频率 |
431 | HTTP 重复请求 | - |
此文档是否对你有帮助?