华为云用户手册

请求消息示例 DELETE /v1/mmc/management/cycleconferences?conferenceID=984697426 Connection: keep-alive X-Access-Token: cnr1510zTBhrfUsymQ0srhW2RYS99r9G5SQoTLWN user-agent: WeLink -desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

响应消息示例 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 http_proxy_id: 40c9d32a92b43f85e5cd12617b49535b Server: api-gateway X-Request-Id: a02164ff20cbc841c6c0e9ab38a07e5b

请求消息示例 PUT /v1/mmc/management/conferences/cyclesubconf?conferenceID=985325849 Connection: keep-alive X-Access-Token: cnr1510zTBhrfUsymQ0srhW2RYS99r9G5SQoTLWN Content-Type: application/json user-agent: WeLink-desktop Content-Length: 372 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "cycleSubConfID": "393439b00a2e11ecbe71d7c576a87729", "mediaTypes": "Video", "startTime": "2021-09-01 07:36", "length": 45, "description": "" }

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 2164 Connection: keep-alive http_proxy_id: 462abfcfa8a41c2c5450eb7648bf5ad2 Server: api-gateway X-Request-Id: 7ba6f742610c03a64262b126fb336a5d

CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token:cnr1510zTBhrfUsymQ0srhW2RYS99r9G5SQoTLWN' -d '{"cycleSubConfID": "393439b00a2e11ecbe71d7c576a87729","mediaTypes": "Video","startTime": "2021-09-01 07:36","length": 45,"description": ""}' 'https://api.meeting.huaweicloud.com/v1/mmc/management/conferences/cyclesubconf?conferenceID=985325849'

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 userUUID 否 String Query 用户的UUID。 说明： 该参数将废弃，请勿使用。 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Authorization-Type 否 String Header 标识是否为第三方portal过来的请求。 说明： 该参数将废弃，请勿使用。 X-Site-Id 否 String Header 用于区分到哪个H CS O站点鉴权。 说明： 该参数将废弃，请勿使用。 cycleSubConfID 是 string Body 子会议UUID。 mediaTypes 是 string Body 会议的媒体类型。 Voice：语音会议 HDVideo：视频会议 startTime 是 string Body 会议开始时间（UTC时间）。格式：yyyy-MM-dd HH:mm。 说明： 如果没有指定开始时间或填空串，则表示会议马上开始 时间是UTC时间，即0时区的时间 length 是 Integer Body 会议持续时长，单位分钟。默认30分钟。 最大1440分钟（24小时），最小15分钟。 isAutoRecord 否 Integer Body 会议是否自动启动录制，在录播类型为：录播、录播+直播时才生效。默认为不自动启动。 1：自动启动录制 0：不自动启动录制 confConfigInfo 否 ConfConfigInfo object Body 会议其他配置信息。 recordAuthType 否 Integer Body 录播观看鉴权方式，在录播类型为:录播、直播+录播时有效。 0：可通过链接观看/下载 1：企业用户可观看/下载 2：与会者可观看/下载 description 否 string Body 会议描述，长度限制为200个字符。 表3 ConfConfigInfo 数据结构 参数 是否必须 类型 位置 描述 callInRestriction 否 Integer Body 允许加入会议的范围。 0: 所有用户 2: 企业内用户 3: 被邀请用户 audienceCallInRestriction 否 Integer Body 允许加入网络研讨会的观众范围。 0：所有用户 2：企业内用户和被邀请用户 allowGuestStartConf 否 Boolean Body 是否允许来宾启动会议。 true: 允许来宾启动会议 false: 禁止来宾启动会议 说明： 仅随机会议ID有效。 enableWaitingRoom 否 Boolean Body 是否启用等候室。 showAudienceCountInfo 否 ShowAudienceCountInfo object Body 网络研讨会观众数显示策略。 表4 ShowAudienceCountInfo 数据结构 参数 是否必须 类型 位置 描述 showAudienceMode 否 Integer Body 观众显示策略:服务端用来计算观众人数下发给客户端控制观众显示。 0: 不显示 1: 倍增显示与会人数。基于实时与会人数或累计与会人次（假设为N），可以再进行倍增设置。支持设置倍增倍数X和基础人数Y，设置后，显示的人数为：N*X+Y baseAudienceCount 否 Integer Body 基础人数。范围是0~10000。 multiple 否 Double Body 倍增倍数。范围是1~10, 支持设置到小数点后1位。

启用验证示例 请求消息： POST /openapi/meetingevent Date: Tue, 17 Dec 2019 09:32:47 GMT Content-Type: application/json;charset=UTF-8 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache X-Request-ID: 539e8b710378987ffc5eb844b5e5c290 { "appID": "1988692299", "timestamp": 1629183619116, "nonce": "85262798", "signature": "262ccb5f8854f824c41ea5854ba1798bfa850706fbc85b2be9fd7535ed6b8ff3", "eventInfo": { "event": "meeting.verify", "timestamp": 1629183619116 } } 响应消息 HTTP/1.1 200 Date: Tue, 17 Dec 2019 09:32:47 GMT Content-Type: application/json;charset=UTF-8 Connection: keep-alive X-Request-ID: 539e8b710378987ffc5eb844b5e5c290 { "event":"meeting.verify", "nonce":"85262798" } 响应消息中的nonce必须跟请求消息中的nonce相同，否则会导致启动失败。

推送会议结束事件示例 请求消息： POST /openapi/meetingevent Date: Tue, 17 Dec 2019 09:32:47 GMT Content-Type: application/json;charset=UTF-8 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache X-Request-ID: 539e8b710378987ffc5eb844b5e5c290 { "appID": "123456789", "timestamp": 1629813991351, "nonce": "60426560", "signature": "e3945cab9c583f394ae5e4957b83905e779cacaa2377d9542e19e011cc60a139", "eventInfo": { "event": "meeting.end", "timestamp": 1629813991351, "payload": { "meetingInfo": { "meetingID": "987446316", "meetingUUID": "0307e0400f0a11eca58a9fcb8e69dde8", "meetingCycleSubID": "6038a614321511ecaf39ffbe33ed54dc" } } } } 响应消息： HTTP/1.1 200 Date: Tue, 17 Dec 2019 09:32:47 GMT Content-Type: application/json;charset=UTF-8 Connection: keep-alive X-Request-ID: 539e8b710378987ffc5eb844b5e5c290

推送会议开始事件示例 请求消息： POST /openapi/meetingevent Date: Tue, 17 Dec 2019 09:32:47 GMT Content-Type: application/json;charset=UTF-8 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache X-Request-ID: 539e8b710378987ffc5eb844b5e5c290 { "appID": "123456789", "timestamp": 1629813991351, "nonce": "60426560", "signature": "e3945cab9c583f394ae5e4957b83905e779cacaa2377d9542e19e011cc60a139", "eventInfo": { "event": "meeting.started", "timestamp": 1629813991351, "payload": { "meetingInfo": { "meetingID": "987446316", "meetingUUID": "0307e0400f0a11eca58a9fcb8e69dde8", "meetingCycleSubID": "6038a614321511ecaf39ffbe33ed54dc" } } } } 响应消息： 响应： HTTP/1.1 200 Date: Tue, 17 Dec 2019 09:32:47 GMT Content-Type: application/json;charset=UTF-8 Connection: keep-alive X-Request-ID: 539e8b710378987ffc5eb844b5e5c290

概述 购买了华为云会议旗舰版后，华为云会议将支持开通企业会议事件订阅能力。开通后，华为云会议服务端会主动把该企业的会议事件推送给企业开发者的回调服务地址。 当前已支持的推送会议事件包括： 会议开始 会议结束 会议关闭 录制结束 预约会议 编辑会议 取消会议 用户入会 用户离会 免费试用企业无法开通“会议事件推送”，请联系华为销售人员，并提供华为云会议企业ID，将企业升级为旗舰版。 第三方开发者如果使用SP模式，需要在华为云会议后台开通“会议事件推送”，请联系华为销售人员，并提供华为云会议SP ID。 给指定的回调地址推送事件时，如果推送失败时，间隔30秒后再重试。重试3次失败后，间隔30分钟再重试，一共重试24小时。24小时后将推送不成功的事件丢弃。 父主题： 企业级会议事件推送

请求消息示例 GET /v1/metrics/dashboard/statistic/user/info?timeUnit=D&startTime=2021-03-19&endTime=2021-03-20&category=user_login_device_info&offset=0&limit=10 Connection: keep-alive X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC user-agent: WeLink-desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

CURL命令示例 curl -k -i -X GET -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -s "https://api.meeting.huaweicloud.com/v1/metrics/dashboard/statistic/user/info?timeUnit=D&startTime=2021-03-19&endTime=2021-03-20&category=user_login_device_info&offset=0&limit=10"

响应参数 表4 响应参数 参数 类型 描述 count Integer 总记录数。 limit Integer 查询条目数量。 offset Integer 查询偏移量。 data Array of StatisticUserDataItem objects 会议用户数据按时间点统计的查询结果数组。 表5 StatisticUserDataItem数据结构 参数名称 参数类型 描述 time String 日期/月份。 userLoginCount String 登录用户数。 category = user_login_info时有效。 userPCLoginCount String PC端登录用户数。 category = user_login_info时有效。 userMobileLoginCount String 移动端登录用户数。 category = user_login_info时有效。 userActivatedCount String 激活用户数。 category = user_activate_info时有效。 userLoginDevicesName String 用户登录设备名称。 category = user_login_device_info时有效。 userLoginDevicesCount String 用户登录设备数。 category = user_login_device_info时有效。

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 2450 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: 6fba0eff9f832b463580fb06c5b0ff9c Server: api-gateway X-Request-Id: ac9f75ec3c97c823f128526a924532b2 { "count": 4, "limit": 10, "offset": 0, "data": [{ "time": "2021-03-19", "userLoginDevicesName": "安卓", "userLoginDevicesCount": "177" }, { "time": "2021-03-20", "userLoginDevicesName": "Windows", "userLoginDevicesCount": "178" }, { "time": "2021-03-20", "userLoginDevicesName": "ios", "userLoginDevicesCount": "178" }, { "time": "2021-03-20", "userLoginDevicesName": "安卓", "userLoginDevicesCount": "178" } ] }

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 offset 否 Integer Query 查询偏移量。 取值：大于等于0，默认值为0 若offset大于等于最大条目数量，则返回最后一页数据，页数根据总条目数和limit计算得出 limit 否 Integer Query 查询的条目数量。 取值：1-500，默认值为20 timeUnit 是 String Query 查询时间维度，取值： D: 按日查询 M: 按月查询 startTime 是 String Query 查询时间范围的开始时间，格式根据timeUnit的取值而定。 timeUnit = D，格式：yyyy-MM-dd，此情况下startTime与endTime间隔最多31日 timeUnit = M，格式：yyyy-MM，此情况下startTime与endTime间隔最多12个月 endTime 是 String Query 查询时间范围的结束时间，格式根据timeUnit的取值而定。 timeUnit = D，格式：yyyy-MM-dd，此情况下startTime与endTime间隔最多31日 timeUnit = M，格式：yyyy-MM，此情况下startTime与endTime间隔最多12个月 category 是 String Query 查询分类，取值： user_login_info: 用户登录数据 user_activate_info: 用户激活数据 user_login_device_info: 用户登录设备数据 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。

请求消息示例 GET /v1/metrics/dashboard/statistic/resource/info?timeUnit=D&startTime=2021-03-18&endTime=2021-03-20&category=used_record_info&offset=0&limit=10 Connection: keep-alive X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC user-agent: WeLink-desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 2450 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: 6fba0eff9f832b463580fb06c5b0ff9c Server: api-gateway X-Request-Id: ac9f75ec3c97c823f128526a924532b2 { "count": 3, "limit": 10, "offset": 0, "data": [{ "time": "2021-03-18", "recordUsedSize": "0.23" }, { "time": "2021-03-19", "recordUsedSize": "4035.24" }, { "time": "2021-03-20", "recordUsedSize": "4036.24" } ] }

CURL命令示例 curl -k -i -X GET -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -s "https://api.meeting.huaweicloud.com/v1/metrics/dashboard/statistic/resource/info?timeUnit=D&startTime=2021-03-18&endTime=2021-03-20&category=used_record_info&offset=0&limit=10"

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 offset 否 Integer Query 查询偏移量。 取值：大于等于0，默认值为0 若offset大于等于最大条目数量，则返回最后一页数据，页数根据总条目数和limit计算得出 limit 否 Integer Query 查询的条目数量。 取值：1-500，默认值为20 timeUnit 是 String Query 查询时间维度，取值： D: 按日查询 M: 按月查询 startTime 是 String Query 查询时间范围的开始时间，格式根据timeUnit的取值而定。 timeUnit = D，格式：yyyy-MM-dd，此情况下startTime与endTime间隔最多31日 timeUnit = M，格式：yyyy-MM，此情况下startTime与endTime间隔最多12个月 endTime 是 String Query 查询时间范围的结束时间，格式根据timeUnit的取值而定。 timeUnit = D，格式：yyyy-MM-dd，此情况下startTime与endTime间隔最多31日 timeUnit = M，格式：yyyy-MM，此情况下startTime与endTime间隔最多12个月 category 是 String Query 查询分类，取值： used_vmr_info: 已购VMR资源使用统计数据 used_live_info: 已购直播端口资源使用统计数据 used_record_info: 已购录播资源使用统计数据 used_pstn_info: 已购电话外呼资源使用统计数据 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。

响应参数 表4 响应参数 参数 类型 描述 count Integer 总记录数。 limit Integer 查询条目数量。 offset Integer 查询偏移量。 data Array of StatisticResourceDataItem objects 会议已购资源使用数据按时间点统计的查询结果数组。 表5 StatisticResourceDataItem数据结构 参数名称 参数类型 描述 time String 日期/月份。 vmrParties String VMR方数。 category = used_vmr_info时有效。 maxConcurrencyVmrCount String VMR并发使用数。 category = used_vmr_info时有效。 livePortUsedCount String 直播端口并发使用数。 category = used_live_info时有效。 recordUsedSize String 录播使用空间(G)。 category = used_record_info时有效。 pstnUsedDuration String PSTN外呼时长(分钟)。 category = used_pstn_info时有效。

查询会议用户登录指标统计数据 应用场景 面向第三方应用，提供查询指定时间段内，会议用户统计数据下，用户登录指标统计数据的操作。 业务流程 图1 查询会议登录指标统计数据 步骤一：登录鉴权 1-5、第三方通过执行App ID鉴权， 获取Token 。 步骤二：获取指定时间段内会议登录指标统计数据 6、填入时间单位，起始时间，结束时间，分类等参数 7、第三方携带这些参数向网关APIG发送查询会议登录指标统计数据请求。 8、网关接收请求后，向仪表盘发送查询会议登录指标统计数据请求。 9、仪表盘返回会议登录指标统计数据给网关APIG。 10、网关APIG将会议登录指标统计数据返回给第三方。 父主题： 应用示例

CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -d '{"share": 1}' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/participants/share/invite ?conferenceID=986947855&participantID=4a5rg64ag5p8pvvnam1rr6m8lqra6a61

响应消息示例 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。 participantID 是 String Query 被邀请的与会者标识。 X-Conference-Authorization 是 String Header 会控Token，通过获取会控token接口获得。 share 是 Integer Body 邀请标志。 0：取消邀请 1：邀请

请求消息示例 PUT /v1/mmc/control/conferences/participants/share/invite?conferenceID=986947855&participantID=4a5rg64ag5p8pvvnam1rr6m8lqra6a61 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: Basic Y25yYjQyNmNhMzgyMWY4YTE4ZTc4ZDU5ZGE1NzJhNDIxNjQ0YzUyZGZkOWE0NzMwMjk4 { "share":1 }

响应消息示例 HTTP/1.1 200 Date: Tue, 17 Dec 2019 09:32:47 GMT Content-Type: application/json;charset=UTF-8 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: 539e8b710378987ffc5eb844b5e5c290 { "offset": 0, "limit": 10, "count": 1, "data": [ { "id": "1747cfe902c34631999975417bf6bc1a", "type": "VMR", "typeId": 2001000, "typeDesc": "网络研讨会_1000观众", "vmrMode": 2, "count": 10, "expireDate": 1640966400000, "orderId": "95152407f7f147149e7f3e8e5e4a84bc", "status": 0, "editable": true } ] }

CURL命令示例 curl -k -i -X GET -H 'X-Access-Token: stbdOWTjFFPAoDfJaWFGWnOTtepUlEsfhQSC' /v1/usg/dcs/corp/resource-list?searchKey=&startExpireDate=&endExpireDate=&type=VMR&typeId=&orderId=&status=&vmrMode=2&offset=0&limit=10

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。 offset 否 Integer Query 查询偏移量，若超过最大数量，则返回最后一页。 默认值：0 limit 否 Integer Query 查询数量。 默认值：10 searchKey 否 String Query 搜索条件，支持resourceId模糊查询。 startExpireDate 否 Integer Query 查询过期时间在该时间戳之后的资源项。 endExpireDate 否 Integer Query 查询过期时间在该时间戳之前的资源项。 type 否 String Query 资源类型。 VMR：云会议室 CONF_CALL：会议并发数 HARD_1080P：1080P硬终端 HARD_720P：720P硬终端 SOFT：软终端用户数 ROOM：大屏软终端 LIVE：直播推流 RECORD：录播空间 HARD_THIRD_PARTY ：第三方硬终端账号 HUAWEI_VISION：智慧屏 说明： 查询网络研讨会资源时type字段为VMR。 vmrMode 否 Integer Query VMR模式，type为VMR时传递该参数。 0：个人会议ID 1：云会议室 2：网络研讨会 typeId 否 String Query 资源类型Id，若想搜索5方VMR时，需携带5方vmrpkg对应的id。 orderId 否 String Query 订单Id。 status 否 Integer Query 订单状态。 0：正常 1：到期 2：停用

请求消息示例 GET /v1/usg/dcs/corp/resource-list?searchKey=&startExpireDate=&endExpireDate=&type=VMR&typeId=&orderId=&status=&vmrMode=2&offset=0&limit=10 Connection: keep-alive X-Access-Token: stbdOWTjFFPAoDfJaWFGWnOTtepUlEsfhQSC Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

请求消息示例 GET /v1/usg/acs/authorizeconfig Connection: keep-alive X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)