华为云用户手册

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。 subject 是 String Body 网络研讨会主题。长度限制为128个字符。 description 否 String Body 网络研讨会描述。长度限制为1000个字符。 startTime 是 String Body 网络研讨会开始时间（UTC时间），格式“yyyy-MM-dd HH:mm”。 duration 是 Integer Body 网络研讨会持续时长，单位分钟，取值范围[15,1440]。 timeZoneId 是 Integer Body 会议通知中会议时间的时区信息。时区信息，参考时区映射关系。 说明： 举例：“timeZoneID”:"26"，则通过华为云会议发送的会议通知中的时间将会标记为如“2021/11/11 星期四 00:00 - 02:00 (GMT) 格林威治标准时间:都柏林, 爱丁堡, 里斯本, 伦敦”。 attendees 否 Array of Attendee objects Body 与会嘉宾列表。 说明： 观众只能自己通过链接或者会议ID+密码加入，不支持被邀请。 notifySetting 否 NotifySetting object Body 网络研讨会通知配置。 vmrID 是 String Body 绑定给当前创建网络研讨会账号的VMR ID。通过查询云会议室及个人会议ID接口获取。 说明： vmrID取上述查询接口中返回的id，不是vmrId 创建网络研讨会时，使用vmrMode=2的VMR guestPasswd 否 String Body 嘉宾密码（4-16位长度的纯数字)。不指定则系统自动生成。 audiencePasswd 否 String Body 观众密码（4-16位长度的纯数字)。不指定则系统自动生成。 callRestriction 否 Boolean Body 入会范围开关。 false：不限制入会范围 true：限制入会范围 scope 否 Integer Body 主持人、嘉宾入会范围 。仅callRestriction设置成true后生效。 0: 所有用户 2: 企业内用户 3: 被邀请用户 audienceScope 否 Integer Body 观众入会范围。仅callRestriction设置成true后生效。 0: 所有用户 2: 企业内用户和被邀请用户 enableRecording 否 String Body 录制是否开启。 Y: 开启 N: 不开启 liveAddress 否 String Body 主流直播推流地址，最大不超过255个字符。若仅填写liveAddress，未填写auxAddress，无人共享时直播画面显示演讲者视图，有人共享时直播画面显示共享屏幕视图。若同时填写了liveAddress和auxAddress，liveAddress对应直播画面显示演讲者视图，auxAddress对应直播画面显示共享屏幕视图。 auxAddress 否 String Body 辅流直播推流地址，最大不超过255个字符。在填写liveAddress后可增加填写auxAddress，liveAddress对应直播画面显示演讲者视图，auxAddress对应直播画面显示共享屏幕视图。 liveUrl 否 String Body 直播观看地址 表3 Attendee 数据结构 参数 是否必须 类型 描述 appId 是 String App ID。如果是APP ID鉴权场景，此项必填。参考“App ID的申请”。 userAccount 否 String 嘉宾的账号。 如果是账号/密码鉴权场景: 选填，表示华为云会议账号ID 如果是APP ID鉴权场景：必填，表示第三方的User ID，同时需要携带参数appId userName 否 String 嘉宾的名称。长度限制为96个字符。 deptName 否 String 部门名称，最大128字符。 phone 否 String 号码。支持SIP号码或者手机号码。 如果是账号/密码鉴权场景：必填 如果是APP ID鉴权场景：选填 说明： 号码可以通过查询企业通讯接口录获取。返回的number是SIP号码，phone是手机号码 填SIP号码系统会呼叫对应的软终端或者硬终端；填手机号码系统会呼叫手机 呼叫手机需要开通PSTN权限，否则无法呼叫 email 否 String 邮件地址。需要发邮件通知时填写。 sms 否 String 短信通知的手机号码。需要发短信通知时填写。 isHardTerminal 否 Boolean 是否硬终端（会议室或硬终端）。 表4 NotifySetting 数据结构 参数 是否必须 类型 描述 enableCalendar 是 String 发送邮件日历是否开启。 Y：开启 N： 不开启 enableSms 是 String 发送短信通知是否开启。 Y：开启 N： 不开启 enableEmail 是 String 发送邮件是否开启。 Y：开启 N： 不开启

开启实时字幕示例 var confToken = 获取会控Token接口; var openRealTimeSubtitle = JSON.stringify({ sequence: "000000000000000002611382273463", action: "ConfControl", type: "REALTIMESUBTITLE", data: JSON.stringify({ conferenceID: "986812232", confToken: confToken, isSubtitle: "1", subtitleType: "0" }), });

实时字幕推送示例 { "action": "RealTimeSubtitleNotify", "version": "1614936396556", "createTime": "1614936396556", "msgID": "e20544e37d9411ebbae3fd5b302953d3", "msgMode": 0, "confID": "981112355", "data": { "msgs ": [{ "subtitleLang": "Mandarin", "translateText": "实时字幕。 ", "id ": "c0196fb9-c9c3-47ba-a685-05223552de2f" }], "isFinal ": false, "timestamp ": 1614936396553, "beginTime": 1528680, "endTime": 1530900, "participantID": "984r8z9f4p6p6pry97yfan6z76681f09" } }

描述 会议中任何人都可以通过该接口首次启动会议的实时字幕。当会议处于开启实时字幕状态时，会议中任何人都可以订阅实时字幕推送消息帧。 会议结束时，会议的实时字幕才会停止。 表1 请求文本 参数 类型 描述 action String 消息类型，必须为ConfControl。 sequence String 消息序列，消息帧的唯一标识。 type String 会控类型，必须为REALTIMESUBTITLE。 data String 具体的请求JSON字符串，参考表2 data数据结构。 表2 data数据结构 参数名称 是否必须 参数类型 描述 conferenceID 是 String 会议ID。 confToken 是 String 会控Token。 isSubtitle 否 Integer 0：停止实时字幕 1：启动实时字幕 subtitleType 否 Integer 字幕显示方式： 0：声音最大的2方发言人 sisProperty 否 String 所使用的模型: chinese_16k_general：中文普通话（默认） chinese_16k_trial：庭审模式 id 否 Array of strings 字幕显示方式为“指定发言人”时必填。发言会场ID列表（6.3.5章节在线与会者推送的pid），最多4人。

邀请结果推送示例 { "data": [{ "callNumber": "+86571299676493248", "resultCode": "0" }], "confID": "900487914", "msgID": "23a4ed3a62d111eb980a8f4b46ea6930", "msgMode": 0, "version": 1611993595063, "createTime": 1611993595063, "action": "InviteResultNotify" }

会议媒体质量状态推送示例 { "data": [{ "mode": 0, "participantID": "uzr571a9brwu11cvcibvru5a7r7rryiy", "netInfo": "good", "lostPacketRate": "0", "delay": "37", "jitter": "0", "fluxIn": "2", "fluxOut": "2", "audioOutLossPacketRate": "0", "videoInLossPacketRate": "0", "videoOutLossPacketRate": "0", "assistVideoInLossPacketRate": "0", "assistVideoOutLossPacketRate": "0", "outJitter": "0", "videoFluxIn": "0", "videoFluxOut": "0", "assistVideoFluxIn": "0", "assistVideoFluxOut": "0", "bandwidth": 61440, "audioCodecType": "AACLD", "videoCodecType": "H264HP" }], "confID": "900487914", "msgID": "244720b162d111eb980a6b11e9b06158", "msgMode": 1, "version": 39, "createTime": 1611993596126, "action": "NetConditionNotify" }

发言方状态推送示例 { "data": [{ "pid": "w5v17oiroco5zy9boia91yar1a17wzvy", "name": "张三", "speakingVolume": 45 }], "confID": "900151350", "msgID": "4252aa67647f11ebb104b533eb9cd8a1", "msgMode": 0, "version": 1612178330127, "createTime": 1612178330127, "action": "SpeakerChangeNotify" }

预约与会者推送示例 { "data": [{ "mode": 0, "orgID": "44252", "thirdAccount": "zhangsan", "phone": "+86571********", "accountId": "zhangsan", "userUUID": "271682cfdbe14fa9ae3a8b25f7502627", "name": "张三", "role": 1, "isMute": 0, "isAutoInvite": 0, "type": "normal", "deptUUID": "ff808081689de0d901689df549fe0009", "deptName": "department2", "hidePhone": false, "isNotOverlayPidName": false }], "confID": "900487914", "msgID": "23a450f962d111eb980aa1747c1cf8f9", "msgMode": 0, "version": 1611993595059, "createTime": 1611993595059, "action": "AttendeesNotify" }

在线与会者推送示例 { "data": [{ "pid": "uzr571a9brwu11cvcibvru5a7r7rryiy", "mode": 0, "pinfoMap": { "CAMERASTATE": "1", "ORG_ID": "44252", "LOCKED_VIEW": "0", "MUTE": "1", "ACCOUNT_ID": "271682cfdbe14fa9ae3a8b25f7502627", "LOCALREC": "0", "TEL": "+86571299676493248", "ALLOW_CLIENT_REC": "0", "STATE": "0", "SHARE": "0", "ANONYMOUS": "0", "ADDTIME": "1611988486336", "NAME": "张三", "CLIENT_REC_STATE": "0", "CLIENT_CAPABILITIES": "1,3", "ROLE_SWITCH_OVER": "0", "RTC_USER_ID": "uzr571a9brwu11cvcibvru5a7r7rryiy", "CLIENT_ LOG IN_TYPE": "Desktop", "T": "1", "ACCOUNT": "zhangsan", "BROADCAST": "0", "IS_COHOST": "0", "HAND": "0", "IS_SVC": "1", "ROLLCALL": "0", "M": "1", "VIDEO": "1", "ROLE": "1", "THIRDACCOUNT": "zhangsan", "INVITE_SHARE_STATE": "0" } }], "confID": "900487914", "msgID": "23a429e862d111eb980a11b5be5aab3c", "msgMode": 0, "version": 1611993595058, "createTime": 1611993595058, "action": "ParticipantsNotify" }

会议状态推送示例 { "state": "Created", "endTime": "1611994784164", "mode": "FREE", "vas": 1, "picNum": 16, "lock": 0, "mute": 1, "lockSharing": 0, "canUnmute": 1, "chairView": 0, "recState": 0, "aiRecState": 0, "enableShareSetting": 1, "callInRestriction": 0, "audienceCallInRestriction": 0, "forbiddenChat": 0, "realTimeSubtitle": 0, "audienceTotalCount": 0, "simultaneousInterpretation": 0, "lanChannels": [], "allowAudience": false, "pause": false, "partViewNum": 0, "maxPartViewNum": 8, "audienceVideoLayout": "speakerVideoLayout", "recOccurred": 0, "clientRecState": 0, "clientRecMode": 0, "waitingRoomState": 0, "showAudienceMode": 0, "audienceCountMultiple": 0, "audienceCountReal": 0, "confID": "900487914", "msgID": "23a1dff762d111eb980a9172a5e3d682", "msgMode": 0, "version": 1611993595043, "createTime": 1611993595043, "action": "ConfDynamicInfoNotify" }

会议基本信息推送示例 { "displayID": "900487914", "title": "张三的会议", "startTime": "1611988484164", "guestJoinUri": "https://100.95.188.184:443/#/j/900487914/29a3cb420d228e2a507bb40f81c36157f07659389f3bf570", "pwds": [{ "role": "chair", "pwd": "******" }, { "role": "general", "pwd": "******" }], "recType": 1, "media": 2, "owner": "张三", "orgID": "44252", "aiRecType": 0, "callInRestriction": 0, "audienceCallInRestriction": 0, "confMode": "COMMON", "webinar": false, "realTimeSubtitle": 0, "bignumMultiPicSwitch": true, "partViewSwitch": true, "simultaneousInterpretation": 0, "supportWatermark": 1, "userType": 2, "ownerID": "271682cfdbe14fa9ae3a8b25f7502627", "scheduledStartTime": "1611988483700", "supportCohost": 1, "supportClientRecord": 1, "inviteShareSwitch": true, "confPortalCapabilities": "1", "supportWaitingRoom": false, "confID": "900487914", "msgID": "239fbd1662d111eb980abbd127030a68", "msgMode": 0, "version": 1611993595029, "createTime": 1611993595029, "action": "ConfBasicInfoNotify" }

请求消息示例 GET wss://100.94.23.40/cms/open/websocket/confctl/increment/conn?confID=900726255&tmpToken=cnr6e88712f1c89a7b4e3b989596fc420fd43b45bf8ef35c1db HTTP/1.1 Host: 100.94.23.40 Connection: Upgrade Pragma: no-cache Cache-Control: no-cache User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36 Upgrade: websocket Origin: https://100.94.23.40 Sec-WebSocket-Version: 13 Accept-Encoding: gzip, deflate, br Accept-Language: zh-CN,zh;q=0.9,en;q=0.8 Cookie: CONFPORTALROUTE=canary; supportCookie=1 Sec-WebSocket-Key: wJ34Os631BNGJ1R72gQ/mQ== Sec-WebSocket-Extensions: permessage-deflate; client_max_window_bits

请求消息示例 PUT /v1/mmc/control/conferences/wsToken?conferenceID=900825541 Connection: keep-alive content-type: application/json user-agent: WeLink -desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) X-Conference-Authorization: cnr351949b429a0b74b032fc2e40977ce77a2037f0391a7a122

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 39 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: 571b4dfceff545fae29aa14cea761079 Server: api-gateway X-Request-Id: f78b007ec2dabf1498620131c7bc19e0 { "webSocketToken": "cnr6e88712f1c89a7b4e3b989596fc420fd43b45bf8ef35c1db" }

请求消息示例 PUT /v1/mmc/control/conferences/updateStartedConfConfig?conferenceID=900244663 Connection: keep-alive content-type: application/json user-agent: WeLink-desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "lockSharing": 0 }

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 39 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: 571b4dfceff545fae29aa14cea761079 Server: api-gateway X-Request-Id: f78b007ec2dabf1498620131c7bc19e0

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 X-Conference-Authorization 是 String Header 会控Token，通过获取会控token接口获得。 lockSharing 否 Integer Body 锁定共享： 0：不锁定 1：锁定 callInRestriction 否 Integer Body 允许呼入的范围。 0：所有用户 2：企业内用户 3：被邀请用户 isLock 否 Integer Body 锁定会议 0：解锁。 1：锁定。 allowUnmuteByOneself 否 Integer Body 是否允许自己解除静音，默认为允许 0：不允许 1：允许 chatPermission 否 Integer Body 会中聊天权限： 1：全员禁止 2：仅允许私聊 3：仅允许公开聊天 4：允许自由聊天 audienceCallInRestriction 否 Integer Body 允许观众呼入的范围，默认为所有人。 0：所有用户 2：企业联系人以及被邀请用户 clientRecMode 否 Integer Body 客户端本地录制权限的范围，默认为仅主持人支持本地录制。 0：仅主持人可录制 1：全部人可录制 2：部分人可录制 allowOpenCamera 否 Integer Body 与会人自行开启摄像头 0: 不允许；1: 允许 allowRename 否 Integer Body 是否允许与会人改名 0: 不允许；1: 允许 freeShare 否 Integer Body 抢共享权限设置 0：仅主持人/联席 1：所有人可抢共享

响应消息示例 HTTP/1.1 200 OK Content-Length: 141 Cache-Control: no-store Connection: keep-alive Content-Type: application/json Date: Thu, 24 Dec 2020 06:25:59 GMT Server: api-gateway X-APIG-Latency: 261 X-APIG-Ratelimit-Api: remain:99,limit:100,time:1 minute X-APIG-Ratelimit-Api-Allenv: remain:199,limit:200,time:1 second X-APIG-Upstream-Latency: 259 X-Envoy-Upstream-Service-Time: 210 X-Request-Id: f991eeec77df1692c74f253d765ca146 { "usedRecStorage": 39.59, "usedAccountsCount": 1, "usedLiveCount": 0, "confCount": 4, "confLength": 57, "activeAttendeeCount": 1, "totalAttendeeCount": 2 }

响应参数 表4 响应参数 参数 类型 描述 usedRecStorage Double 当前已用录制存储空间(单位G)。 usedAccountsCount Integer 当前已用的会议并发数量。 usedLiveCount Integer 当前已用的直播推流资源。 confCount Integer 当日会议总次数。 confLength Integer 当日会议总时长。 activeAttendeeCount Integer 当日活跃用户数。 totalAttendeeCount Integer 当日总与会人数。

请求消息示例 GET /v1/mmc/management/orgRes HTTP/1.1 Connection: keep-alive X-Access-Token: ******* user-agent: WeLink-desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 id 是 String Path 云会议室ID。 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN, 英文为en-US。 allowGustFirst 否 Boolean Body 是否允许来宾先入会。 chairPwd 否 String Body 主持人密码。4~16位的数字。 gustFirstNotice 否 Boolean Body 云会议室被使用后是否通知会议室所有者。 gustPwd 否 String Body 来宾密码，设置为空字符串代表不设置来宾密码。 4~16位的数字。 vmrName 否 String Body 云会议室名称。 maxLength：128 minLength：1

请求消息示例 PUT /v1/usg/dcs/member/vmr/ff80808167ef1edf0167f33d650c0662 Connection: keep-alive X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Content-Type: application/json Content-Length: 94 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "vmrName": "test的云会议室", "chairPwd": "******", "gustPwd": "******", "allowGustFirst": false }

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 143 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: fbbc91569f0efed914e0427fc2a9c4ac

CURL命令示例 curl -k -i -v -X PUT -H "content-type: application/json" -H "X-Access-Token:cnrR5zgAjyIhNeDpfa7iDr8bYmYvN0k8q4iZ" -d "{\"vmrName\":\"test\",\"chairPwd\":\"******\",\"gustPwd\":\"******\",\"allowGustFirst\":\"false\"}" https://api.meeting.huaweicloud.com/v1/usg/dcs/member/vmr/ff80808167ef1edf0167f33d650c0662

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 143 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: fbbc91569f0efed914e0427fc2a9c4ac { "count" : 1, "data" : [ { "allowGustFirst" : true, "chairJoinUrl" : "https://bmeeting.huaweicloud.com/#/j/9******5/4***************0", "chairPwd" : "******", "gustFirstNotice" : false, "gustJoinUrl" : "https://bmeeting.huaweicloud.com/#/j/9******5", "gustPwd" : null, "id" : "ff80808167ef1ef50167f060f574139a", "status" : 0, "vmrId" : "938305104", "vmrMode" : 0, "vmrName" : "云会议室5104", "vmrPkgId" : "ff80808167e5f5aa0167e627ed970002", "vmrPkgName" : "大型云会议室-50方", "vmrPkgParties" : 25 } ], "limit" : 10, "offset" : 0 }

请求消息示例 GET /v1/usg/dcs/member/vmr?specialVmr=true&offset=0&limit=10 Connection: keep-alive X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Content-Type: application/json Content-Length: 94 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

CURL命令示例 curl -k -i -v -X GET -H "content-type:application/json" -H "X-Access-Token:cnrR5zgAjyIhNeDpfa7iDr8bYmYvN0k8q4iZ" "https://api.meeting.huaweicloud.com/v1/usg/dcs/member/vmr?specialVmr=true&offset=0&limit=10"

响应参数 表4 响应参数 参数 类型 描述 count Integer 总数量。 limit Integer 每页显示的条目数量。 默认值：10 offset Integer 页面起始页，从0开始。 data Array of QueryVmrResultDTO objects 查询到的云会议室列表。 表5 QueryVmrResultDTO数据结构 参数 类型 描述 allowGustFirst Boolean 允许来宾先入会。 chairJoinUrl String 主持人与会链接。 chairPwd String 主持人密码。 gustFirstNotice Boolean 云会议室被使用后是否通知会议室所有者。 gustJoinUrl String 来宾与会链接。 gustPwd String 来宾密码。 id String 云会议室的ID。 说明： 对应创建会议接口中的vmrID。 status Integer 云会议室状态。 0：正常 1：停用 2：未分配 vmrMode Integer VMR模式。 0：个人会议ID 1：云会议室 2：网络研讨会 vmrId String 云会议室的固定会议ID或者个人会议ID。 说明： 对应创建会议接口返回数据的vmrConferenceID。 vmrName String 云会议室名称。 vmrPkgId String 云会议室套餐包的id，仅云会议室返回。 vmrPkgName String 云会议室套餐包的名称，仅云会议室返回。 vmrPkgParties Integer 云会议室套餐包的会议并发方数，仅云会议室返回。

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 offset 否 Integer Query 查询偏移量，若超过最大数量，则返回最后一页的数据。 默认值：0 limit 否 Integer Query 查询数量。 默认值：10 searchKey 否 String Query 搜索条件。支持云会议室名称、ID模糊搜索。 specialVmr 否 Boolean Query 查询VMR的类型。不填则查询所有类型。 false：个人会议ID true：云会议室 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN, 英文为en-US。

请求消息示例 POST /v1/usg/dcs/corp/vmr/recycle-from-member/example@123?accountType=0 Connection: keep-alive X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Content-Type: application/json Content-Length: 36 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) ["ff8080816b9ec3ab016ba125aca20082"]