更新用户角色

最近更新时间:2023-08-08 14:54:52

我的收藏

功能说明

管理员可以通过该接口,切换用户角色。
说明:
房间里必须存在房主,所以在改变角色时,不允许将房主转变为别的角色。

接口说明

请求URL示列

https://xxxxxx/room_api/v1/userctl/update/user_role?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参考 REST API 简介
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名:
中国:roomkit.trtc.tencent-cloud.com
room_api/v1/roomctl/destroy
请求接口
sdkappid
创建应用时控制台分配的 SDKAppID
identifier
使用 IM 的管理员账号
usersig
App 管理员账号生成的签名,具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数,取值范围 0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

{
"roomId": "xxx", // 房间Id
"userId": "Alice", // 需改变角色的userId
"changeRole": 1 // 改变的角色
}

请求包字段说明

字段
类型
属性
说明
roomId
String
必填
房间 ID
userId
String
必填
需改变角色的 userId
changeRole
Integer
必填
角色类型:0为房主,1为管理员,2为普通成员,具体请参见:角色

响应包字段

{
"errorCode": 0, // 错误码
"errorMessage": "Success", // 错误信息
"requestId": "3fdc344c7a67461c6af3cfc3e77744b5", // 请求的唯一Id
"data": {
"roleList": [
{"userId": "111", "role", 1}
]
} // 请求的数据,为空时则无数据
}

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。实际的错误码、错误信息是通过应答包体中的 errorCode、errorMessage 来表示的。 公共错误码(70000到79999)请参见 错误码
错误码
含义说明
0
请求成功
84002
房间不存在
84004
用户不在房间
87002
权限错误,例如不允许房主变更为管理员。
未知错误码
未知错误,请联系技术人员

可能触发的回调

更新用户角色回调。