第三方集成者可以使用该api实现会中修改某个参会者的显示名称(仅在本次会议生效)
默认接口请求频率限制:20次/秒。
REST URL
POST https://sdk.xylink.com/api/rest/external/{version}/conferenceControl/updateName?enterpriseId=XXX&meetingRoomNumber=XXX&meetingId=XXX&signature=XXX
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 | 初始平台 |
version | String | Path | 是 | 无 | v1 | 3.9不支持该接口 6.0不支持该接口 公有云不支持该接口 |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 | 5.2 (2024-0329版本) |
signature | String | Query | 签名鉴权1.0(旧):是 签名鉴权2.0:否 | 无 | API签名,参见签名规则 | 5.2 (2024-0329版本) |
meetingRoomNumber | String | Query | 是 | 无 | 当前会议的云会议号 | 5.2 (2024-0329版本) |
meetingId | String | Query | 是 | 无 | 会议id(可在查看全体成员会议状态中获取) | 5.2 (2024-0329版本) |
name | String | Query | 是 | 无 | 显示名称 | 5.2 (2024-0329版本) |
device | JSON | Query | 是 | 无 | 参会端 | 5.2 (2024-0329版本) |
└id | int | Body | 是 | 无 | 会中参会者Id(可在查看全体成员会议状态中获取) | 5.2 (2024-0329版本) |
└type | String | Body | 是 | 无 | 会中参会者类型(可在查看全体成员会议状态中获取) | 5.2 (2024-0329版本) |
└participantNumber | String | Body | 否 | 无 | 对于硬件设备为终端号(可在查看全体成员会议状态中获取) | 5.2 (2024-0329版本) |
请求消息体示例(Json)
{
"name": "xxxxxx",
"device": {
"id": xxx,
"type": xxx,
"participantNumber": "xxx"
}
}
返回结果示例:
成功时返回HTTP200,失败时返回小鱼RESTAPI错误码