云信服务端支持修改频道的基础信息，如频道名称、频道主题和查看模式（是否公开）等。

服务器创建者以外的用户，需要拥有管理频道的权限，才可修改频道的基础信息。

调用时机

圈组服务器内已存在频道。

URL

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

请求参数

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

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

参数	类型	是否必填	说明
accid	String	是	用户的 IM 帐号
bid	String	否	安全通的自定义反垃圾（即内容审核）业务的 ID。自定义反垃圾业务主要用来针对圈组的资料信息进行除了默认反垃圾业务以外的内容审核开通安全通后，云信控制台会自动生成默认反垃圾业务。您的应用不需要配置业务 ID 就能默认采用安全通的默认反垃圾业务，如果需要自定义反垃圾业务，请先通过云信官网首页提供的微信、在线聊天和电话等方式跟商务经理发出申请，获取对应的业务 ID。
channelId	Long	是	频道 ID，频道唯一标识
custom	String	否	频道的自定义扩展字段，最大长度 1024 字符
name	String	否	频道名称，最大长度 64 字符
topic	String	否	频道主题，最大长度 64 字符
viewMode	int	否	0 表示公开，1 表示私密，默认为 0
visitorMode	int	否	频道是否对游客可见 0：对游客可见 1：对游客不可见 2：跟随模式（默认），即如果该频道的查看模式（viewMode）被设置为“公开”则该频道对游客可见，如果被设置为“私密”则对游客不可见 如果频道的 visitorMode 为跟随模式，且同步模式（syncMode）为“与频道分组同步”，则当该频道所属的频道分组的查看模式（viewMode）变更后，该频道对游客的可见性也将变更。例如，在这种情况下，频道分组的查看模式由公开变为私密，则此时该频道对游客从“可见”变为“不可见”。 游客相关功能介绍，请参见游客功能。

返回参数

参数	类型	说明
code	int	状态码，表示 API 调用的结果状态
channelInfo	String	修改后的频道信息

其中 channelInfo 包含的字段信息如下：

参数	类型	说明
owner	String	服务器所有者（即创建者）
+ validFlag	int	有效标志：0-无效，1-有效。如果频道已被删除则为无效
reorderweight	String	自定义排序权重值，频道自定义排序权重配置相关说明请参见修改频道自定义排序权重值。
custom	String	自定义字段
updateTime	long	频道信息更新时间
type	int	频道类型：0-消息频道，1-实时互动频道，100-自定义频道
viewMode	int	频道的查看模式：0-公开，1-私密
visitorMode	int	频道是否对游客可见，0：对游客可见，1：对游客不可见，2：跟随模式（默认），具体见上文的请求参数
serverId	String	频道所属服务器的ID
createTime	long	频道创建时间
name	String	频道名称
syncMode	int	频道与所在的频道分组是否同步数据，0-不与分组同步(默认)，1-与分组同步。
topic	String	频道主题
channelId	long	频道唯一标识
categoryId	long	频道分组唯一标识

示例

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk**glw0803mgq3" -H "Nonce: 4tggge**323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'channelId=1513535&accid=zhangsan&name=update' 'http://api.netease.im/nimserver/qchat/updateChannel.action'

返回示例

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
    "channelInfo": {
        "owner": "test",
        "validFlag": 1,
        "reorderweight": 0,
        "custom": null,
        "updateTime": 1663759233016,
        "type": 1,
        "viewMode": 0,
        "visitorMode": 0,
        "serverId": 1460012,
        "createTime": 1663746443592,
        "name": "testname",
        "syncMode": 0,
        "topic": "test",
        "channelId": 1836129,
        "categoryId": 0
    },
    "code": 200
 
}

状态码

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

状态码	说明	处理建议
200	请求成功	-
403	非法操作或没有权限	检查是否已开通圈组功能 检查是否拥有相应的权限，如频道管理权限
404	对象不存在	检查是否存在必传参数为空的问题 检查传入的账号、服务器 ID、频道 ID、反垃圾业务 ID 等是否存在
414	参数错误	根据提示信息，检查传入参数的格式和限制条件
416	调用频率超限	降低调用频率
431	HTTP 重复请求	-