云信服务端支持修改频道黑白名单成员。

功能介绍

频道黑白名单用于管控频道对服务器成员是否可见。

被加入黑白名单的用户，即为黑白名单成员。

频道的可见性管控是圈组消息流转中的一个环节（此处仅以 Android 的流转流程为例），管控方式根据频道的查看模式存在区分，具体如下：

频道查看模式	可见性管控
公开	通过频道黑名单进行管控，频道对黑名单中的服务器成员不可见，即这些成员无法访问该频道，其他服务器成员均可访问该频道
私密	通过频道白名单进行管控，频道对白名单中的服务器成员可见，即这些成员可访问该频道，其他服务器成员均无法访问该频道

使用限制

单个频道的黑白名单成员人数上限，默认为 1000。

可在云信控制台配置该数量上限，配置路径：在云信控制台选择应用，进入IM 免费版/专业版 > 功能权限开通 > 拓展配置 > 圈组 > 高级配置 > 公开私密频道的黑白名单成员数。

调用时机

圈组服务器内已创建频道。

URL

httpPOST https://api.netease.im/nimserver/qchat/updateWhiteBlackIdentifyUser.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	String	是	1 表示白名单，2 表示黑名单
opeType	int	是	1 表示添加，2 表示移除
accid	String	是	操作者的 IM 账号，操作者需要拥有管理黑白名单的权限，否则将返回 403
toAccids	String	是	被操作用户的 IM 账号列表，JSON Array 格式，最多可包含 100 个 accid

示例

cURL 请求示例

curlcurl -X POST -H "AppKey: go9dnk4**803mgq3" -H "Nonce: 4tggge**3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&channelId=12222&type=1&opeType=1&toAccids=["sasas"]&accid=acc' 'https://api.netease.im/nimserver/qchat/updateWhiteBlackIdentifyUser.action'

返回示例

http 响应:json

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

状态码

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

状态码	说明	处理建议
200	请求成功	-
403	非法操作或没有权限	检查是否已开通圈组功能 检查传入的 accid 是否为当前服务器和频道的成员，如非成员则无权限 检查操作者是否拥有管理黑白名单的权限
404	对象不存在	检查是否存在必传参数为空的问题 检查传入的服务器 ID 、频道 ID 或账号是否存在
414	参数错误	根据提示信息，检查传入参数的格式和限制条件
416	调用过于频繁	降低调用频率
419	数量超过上限	检查被操作用户的 IM 账号列表中，是否包含了超过上限数量（100 个）的 accid