API 参考
圈组

批量查询频道分组信息

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

批量查询频道分组信息。

URL

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

请求参数

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

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

参数类型必须说明
categoryIdsString频道唯一标识列表,JSONArray格式,最多100个

返回参数

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

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 更新时间

示例

cURL 请求示例

curlcurl -X POST -H "AppKey: go9dnk49b**lw0803mgq3" -H "Nonce: 4tggger**t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'categoryIds=%5B%22123%22%2C%22234%22%5D' 'http://api.netease.im/nimserver/qchat/getChannelCategorys.action'

返回示例

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "categoryInfos": [{
        "categoryId": 123,
        "serverId": 456,
        "name": "name",
        "custom": "custom",
        "owner": "zhangsan",
        "viewMode": 0,
        "channelNumber": 10,
        "validFlag": 1,
        "createTime": 1655197548301,
        "updateTime": 1655197548301
    }]
}
 

状态码

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

200、403、414、416、431、500

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