管理聊天室用户角色
更新时间: 2024/07/17 17:57:35
网易云信 IM 服务端支持设置和变更用户角色。
设置角色
功能描述
将聊天室内指定用户设置为管理员、普通等级用户、黑名单用户或禁言用户。各设置操作均有相应的权限要求,具体参见下文的请求参数。
URL
httpPOST https://api.netease.im/nimserver/chatroom/setMemberRole.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参考API调用方式。
-
POST 请求中 Body 的设置如下:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
roomid | long | 是 | 聊天室id |
operator | String | 是 | 操作者账号accid |
target | String | 是 | 被操作者账号accid |
opt | int | 是 |
操作: 1: 设置为管理员,operator必须是创建者 2:设置普通等级用户,operator必须是创建者或管理员 -1:设为黑名单用户,operator必须是创建者或管理员 -2:设为禁言用户,operator必须是创建者或管理员 |
optvalue | boolean | 是 |
true或false,true:设置;false:取消设置; 执行“取消”设置后,若成员非禁言且非黑名单,则变成游客 |
notifyExt | String | 否 | 通知扩展字段,长度限制2048,请使用json格式 |
示例
cURL请求示例
curlcurl -X POST -H "CheckSum: 51eb13e***61c65c7866c366" -H "AppKey: fe416640c8e**847ad2547" -H "Nonce: 1" -H "CurTime: 1451207708" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=66&operator=zhangsan&target=lisi&opt=2&optvalue=true' 'https://api.netease.im/nimserver/chatroom/setMemberRole.action'
请求成功返回示例
json"Content-Type": "application/json; charset=utf-8"
{
"desc": {
"roomid": 16,
"level": 10,
"accid": "zhangsan",
"type": "COMMON"
},
"code": 200
}
备注:
返回的type字段可能为:
LIMITED, //受限用户,黑名单+禁言
COMMON, //普通固定成员
CREATOR, //创建者
MANAGER, //管理员
TEMPORARY, //临时用户,非固定成员
变更角色
功能描述
变更聊天室内指定用户的角色信息。
URL
httpPOST https://api.netease.im/nimserver/chatroom/updateMyRoomRole.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参考API调用方式。
-
POST 请求中 Body 的设置如下:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
roomid | long | 是 | 聊天室 ID |
accid | String | 是 | 需要变更角色信息的 IM 账号 |
save | boolean | 否 | 变更的信息是否需要持久化,默认false,仅对聊天室固定成员生效 |
needNotify | boolean | 否 |
是否需要下发通知消息 |
notifyExt | String | 否 | 通知消息的内容,长度限制 2048 |
nick | String | 否 | 聊天室室内的角色信息:昵称,不超过 64 个字符 |
avator | String | 否 | 聊天室室内的角色信息:头像 |
ext | String | 否 | 聊天室室内的角色信息:开发者扩展字段 |
bid | String | 否 | 安全通的自定义反垃圾(即内容审核)业务的 ID。自定义反垃圾业务主要用来针对单条消息或单次操作的资料信息进行除了默认反垃圾业务以外的内容审核。如需配置自定义反垃圾,请通过云信官网首页提供的微信、在线聊天和电话等方式联系商务经理进行配置,并获取对应的业务 ID。JSON字符串,形式如 {"textbid":"","picbid":""}。若不填则使用默认的反垃圾配置 |
示例
cURL请求示例
curlcurl -X POST -H "CheckSum: 51eb13ea5**c65c7866c366" -H "AppKey: he516640c8e**47ad2547" -H "Nonce: 1" -H "CurTime: 1451207708" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=36&accid=hzyangfeng201403&save=true&needNotify=true&nick=myNick' "https://api.netease.im/nimserver/chatroom/updateMyRoomRole.action"
请求成功返回示例
json
"Content-Type": "application/json; charset=utf-8"
{
"code": 200
}
状态码
上述 API 在 HTTPS Body 中返回请求的状态码,状态码详情请参见状态码。
此文档是否对你有帮助?