更改会中成员昵称

最近更新时间:2024-09-10 16:16:21

我的收藏

接口描述

描述:
会中修改参会者昵称,支持创建者、主持人和联席主持人对会中成员进行改名。
此接口支持对云会议已入会成员和 Webinar 观众进行改名。
操作者必须为创建者或已在会中的主持人与联席主持人。
支持 MRA 设备和 PSTN 设备作为被操作者时的改名操作。
企业 secret 鉴权用户可管理任何该企业该用户创建的有效会议,OAuth2.0 鉴权用户只能管理通过 OAuth2.0 鉴权创建的有效会议。
说明:
1:操作者必须是会议的创建者、主持人或者联席主持人才可以设置。
2:调用该接口需要权限项:MANAGE_MEETING 查看和管理您的会议。
3:仅调用者身份为会中主持人时,才可以修改会中主持人或联席主持人的昵称。
请求方式:PUT
接口请求域名
https://api.meeting.qq.com/v1/real-control/meetings/{meetingId}/names


输入参数

请求路径参数

参数名称
必选
参数类型
参数描述
meetingId
String
会议 ID,周期性会议传总会议 ID。

请求 body

参数名称
必选
参数类型
参数描述
operator_id
String
操作者 ID。
1:operator_id 必须与 operator_id_type 配合使用。根据 operator_id_type 的值,operator_id 代表不同类型。
2:如果 operator_id_type=2,operator_id 必须和公共参数的 openid 一致。
operator_id_type
Integer
操作者 ID 的类型:
1:userid
2:openid
4:ms_open_id
instanceid
Integer
用户的终端设备类型:
0:PSTN
1:PC
2:Mac
3:Android
4:iOS
5:Web
6:iPad
7:Android Pad
8:小程序
9:voip、sip 设备
10:Linux
20:Rooms for Touch Windows
21:Rooms for Touch MacOS
22:Rooms for Touch Android
30:Controller for Touch Windows
32:Controller for Touch Android
33:Controller for Touch iOS
users
User 对象数组
被操作用户对象信息列表。(一次最多处理20个对象)

User 对象

参数名称
必选
参数类型
参数描述
ms_open_id
String
被操作者在当场会议的用户临时 ID,可用于会控操作,适用于所有用户。
instanceid
Integer
用户的终端设备类型:
0:PSTN
1:PC
2:Mac
3:Android
4:iOS
5:Web
6:iPad
7:Android Pad
8:小程序
9:voip、sip 设备
10:Linux
20:Rooms for Touch Windows
21:Rooms for Touch MacOS
22:Rooms for Touch Android
30:Controller for Touch Windows
32:Controller for Touch Android
33:Controller for Touch iOS
说明:请与被操作者的设备类型保持一致,否则不生效。
nick_name
String
用户昵称字符串,限制20个字符。

输出参数

成功返回空消息体,失败返回 错误码 和错误信息。
注意:
若有部分成员不在会中、传入的 instanceid 与成员入会终端不符等成员信息不匹配情况,将会导致本次调用失败,本次改名均不生效。

错误码列表

状态码
错误码
错误描述
400
190455
非会议中不允许操作。
400
190004
参数非法,请对照接口文档检查您的参数。
400
190301
请求重放错误,请求头里的 X-TC-Timestamp 和 X-TC-Nonce 每次请求时需重新生成,不能使用和过去五分钟内相同的 timestamp 和 nonce。
400
9042
无权限进行该操作,建议检查操作者身份或资源归属。
400
202007
成员不在会中。
500
9002
非法请求。
500
9040
成员不存在。
500
41
网络错误,请稍后重试。
500
190001
存在未注册的用户。
500
190456
查询用户不存在,请检查该用户是否注册。
500
190310
每分钟总接口调用次数超过限制。

示例

输入示例

PUT https://api.meeting.qq.com/v1/real-control/meetings/1232132132131/names
{
"operator_id" : "test1",
"operator_id_type" : 4,
"instanceid" : 1,
"user":[{
"ms_open_id" : "agaqwwgdkkddd",
"instanceid":2,
"nick_name": "tester1"
},
{
"ms_open_id" : "agaqwwgdkkddd",
"instanceid":2,
"nick_name": "tester2"
}
]
}