华为云用户手册

响应消息示例 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

请求消息示例 POST /v1/usg/sss/materials Connection: keep-alive X-Access-Token: cnrfzn5OLRjwoaOf2F7PfMwVjJ6zScFogbDE content-type: multipart/form-data; Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191))

CURL命令示例 curl -k -i -H 'content-type: multipart/form-data' -X POST -H 'X-Access-Token: cnrfzn5OLRjwoaOf2F7PfMwVjJ6zScFogbDE' -F 'file=@c:/Users/Administrator/Desktop/test.png' https://api.meeting.huaweicloud.com/v1/usg/sss/materials

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。 file 是 file FormData 素材文件。 只能上传jpg/jpeg/png格式文件，分辨率比率16:9，最大分辨率为3840*2160（推荐） 请先命名完图片名称再上传

请求消息示例 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位。

响应示例 状态码： 200 操作成功。 { "returnCode" : 0, "returnDesc" : "Success", "picLayouts" : [ { "uuid" : "aa3aaaf349f511edbea72fd2b9a0ad61", "imageType" : "Two", "switchTime" : 10, "layOutName" : "my_saved_layout", "subscriberInPics" : [ { "index" : 1, "id" : [ "+99111221231895886#Desktop" ], "share" : 0 }, { "index" : 2, "id" : [ "+99111221231894887#Desktop" ], "share" : 0 } ] } ] } 状态码： 400 参数异常。 { "error_code" : "MMC.111072065", "error_msg" : "CONF_NOT_FOUND_OR_AUTH_FAILED" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 returnCode Integer 结果码。 0：成功 非0：失败 最小值：0 最大值：2147483647 returnDesc String 结果描述。 Success：成功 其他：失败原因 picLayouts Array of RestPicLayout objects 多画面布局。 表4 RestPicLayout 参数 参数类型 描述 switchTime Integer 多画面轮询时间，单位秒。 最小值：10 picNum Integer 多画面画面数量。 最小值：1 layOutName String 多画面布局名称。 imageType String 画面类型。 uuid String 布局UUID。 subscriberInPics Array of PicInfoNotify objects 子画面列表。 表5 PicInfoNotify 参数 参数类型 描述 index Integer 多画面中每个画面的编号，编号从1开始。 id Array of strings 每个画面中的与会者SIP号码。SIP号码可以通过查询企业通讯获取。 share Integer 是否为辅流。 0： 不是辅流 1： 是辅流 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误码描述。

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。 deptList 是 Array of strings Body 发布到部门编码列表。 deviceList 是 Array of strings Body 发布到设备用户ID列表。 endTime 是 Long Body 结束时间。 publishName 是 String Body 发布名称。 startTime 是 Long Body 开始时间。 programList 是 Array of strings Body 发布节目ID列表。

请求消息示例 POST /v1/usg/sss/publications Connection: keep-alive X-Access-Token: cnrfzn5OLRjwoaOf2F7PfMwVjJ6zScFogbDE content-type: application/json Content-Length: 328 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)) { "deptList": [ "WCRjbR0Sou" ], "deviceList": [ "zZ1vtXD2LS" ], "endTime": 253402271999000, "programList": [ "7e0fd568a8354b459784ba825ccd5b8c" ], "publishName": "u0XXszQ9MV", "startTime": 0 }

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

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: cnrfzn5OLRjwoaOf2F7PfMwVjJ6zScFogbDE' -d '{"deptList":["WCRjbR0Sou"],"deviceList":["zZ1vtXD2LS"],"endTime":253402271999000,"programList":{7e0fd568a8354b459784ba825ccd5b8c"],"publishName":"u0XXszQ9MV","startTime":0}' https://api.meeting.huaweicloud.com/v1/usg/sss/publications

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Conference-Authorization 是 String 会控Token，通过获取会控token接口获得。 表3 请求Body参数 参数 是否必选 参数类型 描述 simultaneousInterpretation 是 Integer 启动或停止同声传译功能。 0：停止同声传译 1：启动同声传译 表4 状态码说明 HTTP状态码 描述 200 操作成功。 400 参数异常。 401 未鉴权或鉴权失败。 403 权限受限。 500 服务端异常。

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时有效。

请求参数 表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。

响应消息示例 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" } ] }

请求消息示例 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)

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: 149e8b71037898deffc5e2a44b5e5c230 { "id": "bfccb099e6e34dca95f72c1404c68cd9", "lastUpdatedBy": "", "createTime": 1593538210692, "updateTime": 1593538210692, "publishName": "NZmsGuY4J6", "publishScope": "", "startTime": 0, "endTime": 253402271999000, "publishStatus": "PUBLISHING", "programList": [ { "id": "f7350ac9a4aa41beac142dd588f39fbe", "lastUpdatedBy": "", "updateTime": 1593538210605, "programName": "c5bc3AwzNr", "materialSizeStr": "462.71KB", "playTime": 10 } ], "deptList": [ { "deptCode": "SZ1mBIAdBP", "deptName": null } ], "deviceList": [ { "deviceUserId": "B6l75EEqjh", "deviceName": null } ] }

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

响应参数 表4 响应参数 参数 类型 描述 createTime Long 创建时间。 endTime Long 结束时间。 id String 发布ID。 lastUpdatedBy String 更新者。 publishName String 发布名称。 publishScope String 发布范围。 publishStatus String 根据当前时间确定发布状态。 NOT_ONLINE - 未上线 PUBLISHING - 发布中 ALREADY_OFFLINE - 已下线 startTime Long 开始时间。 updateTime Long 更新时间。 deptList Array of PublishDeptResponseDTO objects 发布部门列表。 deviceList Array of PublishDeviceResponseDTO objects 发布设备列表。 programList Array of ProgramResponseBase objects 发布节目ID列表。 表5 PublishDeptResponseDTO 数据结构 参数 类型 描述 deptCode String 部门编码。 deptName String 部门名称。 表6 PublishDeviceResponseDTO 数据结构 参数 类型 描述 deviceName String 设备名称。 deviceUserId String 设备用户ID。 表7 ProgramResponseBase 数据结构 参数 类型 描述 id String 节目ID。 lastUpdatedBy String 更新者。 materialSizeStr String 节目的总素材大小(含单位)。 playTime Integer 节目的总播放时长，单位秒。 programName String 节目名称。 updateTime Long 更新时间。

请求参数 表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。

响应参数 表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)

响应消息示例 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 }

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 126 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: 2d5d7b5342900131401c88617b8d4c45 Server: api-gateway X-Request-Id: f37bf796d6203d994d3cfb2b4d318ac4 { "siteUrl": "https://117.78.2.254:443/conferences", "random": "108860505401300" }

请求消息示例 GET /v1/mmc/management/conferences/anonymous/auth?conferenceID=914047175 Connection: keep-alive X-Password: ******* 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: 6b7ed88a1b11fe1b4fbb5f05aaff37c4 Server: api-gateway X-Request-Id: 85ac4acb4942810fd3ce179134cbd4e2