API 参考
圈组

修改频道分组信息

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

修改频道分组信息。

该接口支持修改频道分组自定义排序值,用于后续查询频道分组列表结果的自定义排序。

URL

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

请求参数

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

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

参数类型必须说明
accidString操作者accid
categoryIdString频道分组唯一标识
nameString名称,最大长度64字符
customString自定义扩展,最大长度1024字符
viewModeint查看模式:0-公开(默认),1-私密。
reorderweightLong频道分组自定义排序权重值,默认为 0。该参数需配合 SDK 支持圈组功能的各端的排序规则参数生效。如排序规则字段为默认倒序,则匹配的频道分组列表以权重值倒序排列。

返回参数

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

categoryInfo 参数如下:

参数 类型 说明
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: go9dn**3mgq3" -H "Nonce: 4tggge**23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'categoryId=1513535&accid=zhangsan&name=update' 'http://api.netease.im/nimserver/qchat/updateChannelCategory.action'

返回示例

json"Content-Type": "application/json; charset=utf-8"
{
    "code":200,
    "categoryInfo":{
        "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 请求示例
  • 返回示例
  • 状态码