创建频道分组
更新时间: 2024/07/17 17:57:34
频道分组是对服务器下频道的分类管理。您可通过创建,删除,修改,查询等操作,实现对频道以及成员的精细化管理。
功能介绍
频道分组根据查看模式分为公开和私密两种。
查看模式 |
说明 |
---|---|
公开 | 除频道分组的黑名单成员和黑名单身份组成员以外,服务器中的其他成员都能看到公开频道分组。 |
私密 | 除频道分组的白名单成员和白名单身份组成员以外,服务器中的其他成员都无法看到私密频道分组。 |
被加入黑白名单的用户,即为黑白名单成员;被加入黑名单或白名单的身份组即为黑白名单身份组。
圈组服务器中的成员都可以查询该服务器下的频道分组信息。
除查询频道分组信息外,其他频道分组的相关操作,都需要拥有满足两个前提条件。
- 能够查看到该频道分组信息。是否能够查看,与频道分组的查看模式和黑白名单相关,具体可以查看上述表格进行判断。
- 拥有管理频道权限。
创建频道分组
创建频道分组。
URL
httpPOST http://api.netease.im/nimserver/qchat/createChannelCategory.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参考 API 调用方式。
-
POST 请求中 Body 的设置如下:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
accid | String | 是 | 操作者accid |
serverId | String | 是 | 服务器唯一标识 |
name | String | 否 | 名称,最大长度64字符 |
custom | String | 否 | 自定义扩展,最大长度1024字符 |
viewMode | String | 否 | 查看模式:0-公开(默认),1-私密。 |
reorderweight | Long | 否 | 频道分组自定义排序权重值,默认为 0。 |
返回参数
参数 | 说明 |
---|---|
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: go9dnk***0803mgq3" -H "Nonce: 4tggger**t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan&serverId=1513535' 'http://api.netease.im/nimserver/qchat/createChannelCategory.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
此文档是否对你有帮助?