修改频道黑白名单身份组
更新时间: 2024/07/17 17:57:34
云信服务端支持修改频道的黑白名单身份组。
功能介绍
圈组支持选择某个身份组并将其所有成员批量加入黑名单或白名单,从而实现频道的可见性管控。被加入黑名单或白名单的身份组即为黑白名单身份组。
频道的可见性管控是圈组消息流转中的一个环节(此处仅以 Android 的消息流转为例),管控方式根据频道的查看模式存在区分,具体如下:
频道查看模式 |
可见性管控 |
---|---|
公开 | 通过频道黑名单进行管控,频道对黑名单中的服务器成员不可见,即这些成员无法访问该频道,其他服务器成员均可访问该频道 |
私密 | 通过频道白名单进行管控,频道对白名单中的服务器成员可见,即这些成员可访问该频道,其他服务器成员均无法访问该频道 |
调用时机
圈组的服务器内已创建频道,且服务器内已创建自定义身份组。
使用限制
单个频道可设置的黑白名单身份组的数量上限,默认为 20。
可在云信控制台配置该数量上限。(在云信控制台选择应用,进入IM 即时通讯 > 功能配置 > 圈组 > 子功能配置 > channel公开私密频道的黑白名单身份组对象数即可配置。
URL
httpPOST https://api.netease.im/nimserver/qchat/updateWhiteBlackIdentify.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参考API调用方式。
-
POST 请求中 Body 的设置如下:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
serverId | Long | 是 | 服务器 ID |
channelId | Long | 是 | 频道 ID |
type | int | 是 | 1 表示白名单,2 表示黑名单 |
opeType | int | 是 | 操作类型,1 表示将用户添加到白名单或黑名单,2 表示移除 |
accid | String | 是 | 操作者的 IM 账号,操作者需要拥有管理黑白名单的权限,否则将返回 403 状态码 |
roleid | String | 是 | 被操作的服务器身份组 ID |
示例
cURL 请求示例
curlcurl -X POST -H "AppKey: go9dnk49**w0803mgq3" -H "Nonce: 4tgg**23t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&channelId=12222&type=1&opeType=1&roleid=12&accid=acc' 'https://api.netease.im/nimserver/qchat/updateWhiteBlackIdentify.action'
返回示例
http 响应:json
json"Content-Type": "application/json; charset=utf-8"
{
"code": 200
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参见状态码。
状态码 | 说明 | 处理建议 |
---|---|---|
200 | 请求成功 | - |
403 | 非法操作或没有权限 |
|
404 | 对象不存在 |
|
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
416 | 调用过于频繁 | 降低调用频率 |
此文档是否对你有帮助?