请求方式: PUT (HTTPS)
请求地址: https://open.welink.huaweicloud.com/api/meeting/v1/updateconference
认证方式: access_token,请参考获取access_token。
请求头部:
Content-Type: application/json
x-wlk-Authorization: access_token
请求参数示例:
{
"conferenceType":0,
"mediaTypes":"Video,Voice",
"startTime": "2020-04-03 06:30",
"length": 120,
"subject":"技术讨论会"
}
请求param参数说明:
参数名 | |||
---|---|---|---|
conferenceid | 会议标识 | String | 是 |
userId | 用户帐号 | String | 是 |
请求body参数说明:
参数名 | 参数说明 | 类型 | 必选 |
---|---|---|---|
conferenceType | 0 : 普通会议(默认); 1 : 周期会议,此时cycleParams必须填写。 |
Int | 否 |
startTime | 会议开始时间。采用UTC时间。 会议本地的开始时间要通过startTime和timeZoneID计算得到。比如startTime为UTC 2020-03-20 02:00, timeZoneID为56,对应东八区, 则本地会议开始时间为东八区的2020-03-20 10:00。预定创建会议时,如果没有指定开始时间,或填空串,则表示会议马上开始。格式:YYYY-MM-DD HH:MM | String | 否 |
length | 会议持续时长。单位分钟,最长1440,最短15,默认为30。 | Int | 否 |
subject | 会议主题。长度限制为128个字符。 | String | 否 |
groupuri | 软终端创建即时会议时在当前字段带临时群组ID,由服务器在邀请其他与会者时在或者conference-info头域中携带。长度限制为31个字符。 | String | 否 |
mediaTypes | 会议的媒体类型。 由1个或多个枚举String组成,多个枚举时,每个枚举值之间通过”,”逗号分隔,枚举值如下: “Voice”:语音 “Video”:标清视频 “HDVideo”:高清视频(与Video互斥,如果同时选择Video、HDVideo,则系统默认选择Video) “Telepresence”:智真(与HDVideo、Video互斥,如果同时选择,系统使用Telepresence)—暂不支持 “Data”:多媒体(AS会根据系统配置决定是否自动添加Data) |
String | 是 |
attendees | 预定会议时,指定的与会者列表。该与会者列表可以用于发送会议通知、会议提醒、会议开始时候进行自动邀请。请参考RestAttendeeDTO 。 |
RestAttendeeDTO [0..*] | 否 |
isAutoRecord | 会议是否自动启动录制,在录播类型为:录播、直播+录播时有效。1 :true:自动启动录制;0 :false:不自动启动录制。(默认) | Int | 否 |
encryptMode | 会议媒体加密模式。0 : auto:自适应加密;1 : must:强制加密;2 : 不出现:不加密 | Int | 否 |
language | 会议的默认语言,默认值由会议AS定义,MediaX是“zh-CN”,对于系统支持的语言,按照RFC3066规范传递。zh-CN:简体中文;en-US:美国英文 | String | 否 |
timeZoneID | 开始时间的时区信息。时区信息参考时区映射关系 | String | 否 |
recordType | 录播类型。0: 禁用;1: 直播;2: 录播;3: 直播+录播 | Int | 否 |
liveAddress | 主流直播地址。最大不超过255个字符。在录播类型为 :直播、直播+录播时有效。 | String | 否 |
auxAddress | 辅流直播地址。最大不超过255个字符。在录播类型为: 直播、直播+录播时有效。 | String | 否 |
recordAuxStream | 是否录制辅流。在录播类型为:录播、直播+录播时有效。0:否;1:是 | Int | 否 |
confConfigInfo | 会议其他配置信息,用于其他会议配置参数。后续新增的会议配置参数都在该结构中定义。 | RestConfConfigDTO | 否 |
vmrFlag | 是否使用VMR召开预约会议。0:不使用VMR;1:使用VMR | Int | 否 |
vmrID | 用于识别用户开会时绑定的VMR会议室。不为空,则用ID查询VMR信息;为空,则查用户所有VMR,如果有个人VMR,用个人;没有,取最小VMRID | String | 否 |
请求示例:
curl -X PUT \
'https://open.welink.huaweicloud.com/api/meeting/v1/updateconference?conferenceid=914014479&userId=zhangshan@example' \
-H 'Content-Type: application/json' \
-H 'x-wlk-Authorization: dc63dfa2-d338-47f4-84d9-12345678909' \
-d '{"请求参数 json格式"}'
响应格式说明
返回结果示例:
{
"code": "0",
"message": "Success",
"data": [
{
"conferenceID": "914267387",
"mediaTypes": "Video,Voice,Data",
"subject": "技术会议",
"size": 2,
"timeZoneID": "56",
"startTime": "2020-04-03 06:30",
"endTime": "2020-04-03 08:30",
"conferenceState": "Schedule",
"accessNumber": "+991117",
"language": "zh-CN",
"passwordEntry":
[
{
"conferenceRole": "chair",
"password": "46xxx"
},
{
"conferenceRole": "general",
"password": "58XXXX"
}
],
"userId": "zhangsan@example",
"scheduserName": "张三",
"multiStreamFlag": 1,
"conferenceType": 0,
"confType": "FUTURE",
"isAutoMute": 1,
"isAutoRecord": 0,
"chairJoinUri": "https://bmeeting.huaweicloud.com:36443/#/j/914267387/b0ec89d57ff2e0380c466fb4f6e085b298f96afb98911ca7",
"guestJoinUri": "https://bmeeting.huaweicloud.com:36443/#/j/914267387/b600a2dcfee37c6db263f6a102c6e9f61d6452d8fc10e821",
"recordType": 0,
"recordAuxStream": 0,
"confConfigInfo":
{
"inviteMode": "AUTO_INVITE",
"prolongLength": 15,
"dispatchMode": "AUTO_DISPATCH",
"isGuestFreePwd": false,
"isSendNotify": true,
"isSendSms": true,
"isSendCalendar": true,
"isAutoMute": true
},
"vmrFlag": 0,
"scheduleVmr": false,
"isHasRecordFile": false,
"partAttendeeInfo": null,
"terminlCount": 0,
"normalCount": 0,
"deptName": "XXX有限公司"
}
]
}
返回参数说明:
参数名 | 必选 | 类型 | 参数说明 |
---|---|---|---|
code | 是 | string | 数据正常返回“0”,如果发生错误,会返回对应的错误码 |
message | 否 | string | 返回信息,包括接口请求发生错误时的详细信息 |
data | 否 | ConferenceInfo [0..1] | 会议信息,见 |