API 参考
圈组

修改频道分组相关信息

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

云信服务端支持修改频道的分组相关信息,包括所属的频道分组和同步模式。

服务器创建者以外的用户,需要拥有管理频道的权限,才可修改频道的分组相关信息。

调用时机

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

URL

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

请求参数

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

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

参数
类型
是否必填 说明
accid String 用户帐号
channelId Long 频道 ID,频道唯一标识
categoryId Long 频道分组 ID,频道分组唯一标识
syncMode int 同步模式,0-不与频道分组同步数据,1-与频道分组同步数据

syncModecategoryId不能同时为空。

返回参数

参数
类型
说明
code int 状态码,表示 API 调用的结果状态
channelInfo String 修改后的频道信息,具体字段信息参见修改频道基础信息的返回参数中的 channelInfo

示例

cURL请求示例

curl -X POST -H "AppKey: go9dnk**0803mgq3" -H "Nonce: 4tggg**23t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'channelId=1513535&accid=zhangsan&syncMode=0' 'http://api.netease.im/nimserver/qchat/updateCategoryInfoOfChannel.action'

返回示例

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

状态码

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

状态码 说明 处理建议
200 请求成功 -
403 非法操作或没有权限
  • 检查是否已开通圈组功能
  • 检查是否拥有相应的权限,如频道管理权限
404 对象不存在
  • 检查是否存在必传参数为空的问题
  • 检查传入的账号、频道 ID、频道分组 ID 等是否存在
414 参数错误 根据提示信息,检查传入参数的格式和限制条件
416 调用频率超限 降低调用频率
431 HTTP 重复请求 -
此文档是否对你有帮助?
有帮助
去反馈
  • 调用时机
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • cURL请求示例
  • 返回示例
  • 状态码