频道分组可以对频道进行分组管理，主要用于将频道分组的数据（包括身份组数据）同步到该分组内开启同步模式的频道。因此，您可创建频道分组身份组，作为该分组内开启同步模式的频道的身份组模板。

创建频道分组身份组

创建频道分组身份组。

服务器创建者以外的用户，需要拥有频道分组下的管理角色权限，才能创建频道分组身份组。

URL

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

请求参数

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

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

参数	类型	必须	说明
accid	String	是	操作者accid
serverId	String	是	服务器唯一标识
serverRoleId	String	是	继承的服务器身份组ID
categoryId	String	是	频道分组唯一标识

示例

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk**lw0803mgq3" -H "Nonce: 4tggg**3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&serverRoleId=2&categoryId=10001' 'http://api.netease.im/nimserver/qchat/createChannelCategoryIdentify.action'

返回示例

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "identify": {
        "serverId": 2, //服务器唯一标识
        "categoryId": 1, //频道分组唯一标识
        "createtime": 1, //频道分组创建时间
        "roleId": 1,  //频道分组身份组唯一标识
        "auths": "{\"1\":-1, \"2\":1}", //频道分组身份组的权限项，key为权限项的枚举值，value为 1 表示该权限项“开启”，为 -1 表示该权限项“关闭”，为 0 表示继承服务器身份组的权限配置
        "serverRoleId": 1, //所继承的服务器身份组的唯一标识
        "name": "name", // 频道分组身份组的名称
        "icon": "icon", //频道分组身份组的头像
        "ext": "ext", //频道分组身份组的扩展字段
        "type": 1, //频道分组身份组的类型，，1 标识@everyone身份组，2 表示自定义身份组
        "updatetime": 1 // 频道分组身份组的修改（更新）时间
    }
}

状态码

该 API 在 HTTPS Body 中返回请求的状态码，状态码详情请参见状态码。

该 API 的主要状态码包括： 200、403、414、416、431、500

修改频道分组身份组

修改频道分组身份组的信息，如名称和权限项配置。

• 服务器创建者以外的用户，需要拥有频道分组下的管理角色权限，才能修改频道分组身份组。
• 单次最多可批量修改权限数为12。

URL

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

请求参数

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

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

参数	类型	必须	说明
accid	String	是	操作者accid
serverId	String	是	服务器唯一标识
roleId	String	是	频道分组身份组唯一标识
categoryId	String	是	频道分组唯一标识
auths	String	是	用于修改权限的 JSON 字段, 其格式为 {resource1:type1,resource2:type2,resource3:type3}。 resource 表示权限, 其取值代表的具体权限如下： 2：管理频道的权限，拥有该权限可创建、修改或删除频道 3：管理角色的权限，拥有该权限可创建、修改或删除身份组 4：发送消息的权限 9：撤回他人消息的权限 10：删除他人消息的权限 11：@ 他人的权限，拥有该权限可在发送消息时@他人 12：@ 所有人的权限，拥有该权限可在发送消息时@所有人 13：管理频道黑白名单的权限，拥有该权限可将服务器成员加入或移出频道黑名单 15：实时互动频道：建立自己连接的权限 16：实时互动频道：断开他人连接的权限 17：实时互动频道：开启自己麦克风的权限 18：实时互动频道：开启自己摄像头的权限 19：实时互动频道：开启/关闭他人麦克风的权限 20：实时互动频道：开启/关闭他人摄像头的权限 21：实时互动频道：开启/关闭全员麦克风的权限 22：实时互动频道：开启/关闭全员摄像头的权限 23：实时互动频道：打开自己屏幕共享的权限 24：实时互动频道：关闭他人屏幕共享的权限 27：@身份组的权限，拥有该权限可在发送消息时@指定几个身份组的所有成员 type 表示操作类型，其取值代表的操作如下： -1：关闭权限（deny） 1：开启权限（allow） 0：继承服务器身份组的对应权限

示例

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk4**03mgq3" -H "Nonce: 4tgggerg**3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&roleId=2&categoryId=10010&auths="{\"1\":1}"' 'http://api.netease.im/nimserver/qchat/updateChannelCategoryIdentify.action'

返回示例

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "identify": {
        "serverId": 2,  //服务器唯一标识
        "categoryId": 1,  //频道分组唯一标识
        "createtime": 1, //频道分组创建时间
        "roleId": 1,  //频道分组身份组唯一标识
        "auths": "{\"1\":-1, \"2\":1}", //频道分组身份组的权限项，key为权限项的枚举值，value为 1 表示该权限项“开启”，为 -1 表示该权限项“关闭”，为 0 表示继承服务器身份组的权限配置
        "serverRoleId": 1, //所继承的服务器身份组的唯一标识
        "name": "name", //频道分组身份组名称
        "icon": "icon", //频道分组身份组头像
        "ext": "ext", //频道分组身份组扩展字段
        "type": 1, //频道分组身份组的类型，，1 标识@everyone身份组，2 表示自定义身份组
        "updatetime": 1 // 频道分组身份组的修改（更新）时间
    }
}

状态码

该 API 在 HTTPS Body 中返回请求的状态码，状态码详情请参见状态码。

该 API 的主要状态码包括： 200、403、414、416、431、500

删除频道分组身份组

删除频道分组身份组。

服务器创建者以外的用户，需要拥有频道分组下的管理角色权限，才能删除频道分组身份组。

URL

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

参数说明

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

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

参数	类型	必须	说明
accid	String	是	操作者accid
serverId	String	是	服务器唯一标识
roleId	String	是	频道分组身份组唯一标识
categoryId	String	是	频道分组唯一标识

示例

curl请求示例

curlcurl -X POST -H "AppKey: go9dn**03mgq3" -H "Nonce: 4tggger**t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&roleId=2&categoryId=10001' 'http://api.netease.im/nimserver/qchat/deleteChannelCategoryIdentify.action'

返回示例

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
    "code":200
}

状态码

该 API 在 HTTPS Body 中返回请求的状态码，状态码详情请参见状态码。

该 API 的主要状态码包括： 200、403、414、416、431、500

分页查询频道分组身份组列表

分页查询频道分组身份组列表，反回的信息包括频道分组身份组的权限信息、ID 和更新时间等。

URL

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

请求参数

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

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

参数	类型	必须	说明
accid	String	是	操作者accid
serverId	String	是	服务器唯一标识
categoryId	String	是	频道分组唯一标识
timetag	String	是	分页起始时间
limit	String	是	每页限制查询的数量，不传时默认为200，最大限制为200

示例

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49b**lw0803mgq3" -H "Nonce: 4tgg**323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&channelId=10010&timetag=1111111111111&limit=10' 'http://api.netease.im/nimserver/qchat/getChannelCategoryIdentify.action'

返回示例

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
        "serverId": 2,  //服务器唯一标识
        "categoryId": 1,  //频道分组唯一标识
        "createtime": 1, //频道分组创建时间
        "roleId": 1,  //频道分组身份组唯一标识
        "auths": "{\"1\":-1, \"2\":1}", //频道分组身份组的权限项，key为权限项的枚举值，value为 1 表示该权限项“开启”，为 -1 表示该权限项“关闭”，为 0 表示继承服务器身份组的权限配置
        "serverRoleId": 1, //所继承的服务器身份组的唯一标识
        "name": "name", //频道分组身份组名称
        "icon": "icon", //频道分组身份组头像
        "ext": "ext", //频道分组身份组扩展字段
        "type": 1, //频道分组身份组的类型，，1 标识@everyone身份组，2 表示自定义身份组
        "updatetime": 1 // 频道分组身份组的修改（更新）时间
    }]
}

状态码

该 API 在 HTTPS Body 中返回请求的状态码，状态码详情请参见状态码。

该 API 的主要状态码包括： 200、403、414、416、431、500