华为云用户手册

响应参数 表4 响应参数 参数 类型 描述 user QosParticipantInfo object 与会者信息。 qos QosInfo object QoS数据。 表5 QoSInfo 数据结构 参数名称 参数类型 描述 type String QoS类型 audio：音频 video：视频 screen：屏幕共享 cpu：cpu send QosSendReceiveInfo object 会议与会者发送QoS数据。当qosType = audio/video/screen 时有效。 receive QosSendReceiveInfo object 会议与会者接收QoS数据。当qosType = audio/video/screen 时有效。 cpu QosCpuInfo object 会议与会者CPU QoS数据，当qosType = cpu 时有效。 表6 QosSendReceiveInfo 数据结构 参数名称 参数类型 描述 bitrate Array of QosDataNoThrElement objects 码率，单位kbps，不含阈值告警。当qosType = audio/video/screen 时有效。 latency Array of QosDataElement objects 时延，单位毫秒, 含阈值告警。当qosType = audio/video/screen 时有效。 jitter Array of QosDataElement objects 抖动，单位毫秒，含阈值告警。当qosType = audio/video/screen 时有效。 packet_loss_max Array of QosDataElement objects 最大丢包率，单位百分比 含阈值告警。当qosType = audio/video/screen 时有效。 resolution Array of QosDataNoThrElement objects 分辨率，不含阈值告警。当qosType = video/screen 时有效。 frame Array of QosDataNoThrElement objects 帧率，单位fps，不含阈值告警。当qosType = video/screen 时有效。 表7 QoSCpuInfo 数据结构 参数名称 参数类型 描述 client_cpu_max Array of QosDataElement objects App最大CPU使用率。 system_cpu_max Array of QosDataElement objects 系统最大CPU使用率。 表8 QosDataNoThrElement 数据结构 参数名称 参数类型 描述 time String QoS时间点，UTC时间，格式：yyyy-MM-ddTHH:mm:ss.SSSZ。 value String QoS值。 表9 QoSDataElement 数据结构 参数名称 参数类型 描述 time String QoS时间点，UTC时间，格式：yyyy-MM-ddTHH:mm:ss.SSSZ。 value Integer QoS值。 alarm Boolean 该时间点是否有阈值告警。 true：阈值告警 false：无阈值告警 threshold Integer 该时间点的阈值。

请求消息示例 GET /v1/metrics/conference/participant/qos?confUUID=a3d9a31c8af211eb8075a12479434adb&confType=history&participantID=kxxwoo5hmo9khlmggklawbwiwfl999bw&qosType=video 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 { "user": { "confUUID": "a3d9a31c8af211eb8075a12479434adb", "conferenceID": "98909587", "participantID": "kxxwoo5hmo9khlmggklawbwiwfl999bw", "userUUID": "ff80808167ef1edf0167f339533d05a6", "displayName": "深圳分部", "deptName": "XXXXX", "terminalType": "PC", "role": "host", "ipAddress": "***.***.**.**", "country": "中国", "province": "四川省", "city": "成都市", "appVersion": "60.15.5", "joinTime": 1618220940926, "leftTime": 1618221194202, "systemInfo": "android-11", "networkType": "wifi", "alarm": "YES", "audioAlarmSend": "YES", "videoAlarmSend": "NO", "screenAlarmSend": "NO", "audioAlarmRec": "YES", "videoAlarmRec": "YES", "screenAlarmRec": "NO", "cpuAlarm": "NO", "microphoneInfo": "Microphone Array (Realtek(R) Audio)", "speakerInfo": "Speakers/Headphones (Realtek(R) Audio)", "cameraInfo": "Lenovo EasyCamera", "dataCenter": "Region-China-2", "leftReason": 0 }, "qos": { "type": "video", "send": { "bitrate": [{ "time": "2021-04-16T01:18:23.404Z", "value": 1000 }], "latency": [{ "time": "2021-04-16T01:18:23.404Z", "value": 1000, "alarm": true, "threshold": 700 }], "jitter": [{ "time": "2021-04-16T01:18:23.404Z", "value": 1000, "alarm": true, "threshold": 700 }], "packet_loss_max": [{ "time": "2021-04-16T01:18:23.404Z", "value": 1000, "alarm": true, "threshold": 700 }], "resolution": [{ "time": "2021-04-16T01:18:23.404Z", "value": 1000 }], "frame": [{ "time": "2021-04-16T01:18:23.404Z", "value": 1000 }] }, "receive": { "bitrate": [{ "time": "2021-04-16T01:18:23.404Z", "value": 1000 }], "latency": [{ "time": "2021-04-16T01:18:23.404Z", "value": 1000, "alarm": true, "threshold": 700 }], "jitter": [{ "time": "2021-04-16T01:18:23.404Z", "value": 1000, "alarm": true, "threshold": 700 }], "packet_loss_max": [{ "time": "2021-04-16T01:18:23.404Z", "value": 1000, "alarm": true, "threshold": 700 }], "resolution": [{ "time": "2021-04-16T01:18:23.404Z", "value": 1000 }], "frame": [{ "time": "2021-04-16T01:18:23.404Z", "value": 1000 }] } } }

CURL命令示例 curl -k -i -X GET -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -d 'confUUID=a3d9a31c8af211eb8075a12479434adb&confType=history&participantId=kxxwoo5hmo9khlmggklawbwiwfl999bw&qosType=video' https://api.meeting.huaweicloud.com/v1/metrics/conference/participant/qos

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 confUUID 是 String Query 会议UUID。 confType 是 String Query 会议类别。 online：在线会议，在召开的会议 history：历史会议，已召开的会议 participantID 是 String Query 与会者标识。 qosType 是 String Query QoS类型 audio：音频 video：视频 screen：屏幕共享 cpu：cpu X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token:cnr1519y4i5r5ikKZYTGqR5b2ybEJORGdm3EcPzU' -d '{ "roomIntroduce": "网络研讨会", "coverPictureId": "D8879E453B8F4277B95864A147B2F3C5", "isRedoubleOpen": "N", "cropLogoId": "76D356E93FA849C7987983EEAB94F4BE" }' 'https://api.meeting.huaweicloud.com/v1/wss/webinar/open/room-setting/984555800'

响应消息示例 HTTP/1.1 200 OK Content-Length: 0 Cache-Control: no-cache Connection: keep-alive Content-Security-Policy: connect-src 'self' *.huaweicloud.com ;style-src 'self' 'unsafe-inline' 'unsafe-eval';object-src 'self'; font-src 'self' data:; Date: Mon, 17 May 2021 06:38:05 GMT Pragma: no-cache Server: api-gateway Strict-Transport-Security: max-age=16070400; includeSubDomains X-APIG-Latency: 66 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: 64 X-Content-Type-Options: nosniff X-Download-Options: noopen X-Envoy-Upstream-Service-Time: 32 X-Frame-Options: SAMEORIGIN X-Request-Id: a4f7d4029b69ae04bbe6041a075fef86 X-Xss-Protection: 1;mode=block

请求消息示例 POST /v1/wss/webinar/open/room-setting/984555800 HTTP/1.1 Host: 251ba26eef46472d97fa4462d514b044.APIG.cn-north-7.huaweicloudapis.com User-Agent: APIGatewayDebugClient/1.0 Content-Length: 268 Content-Type: application/json X-Access-Token: cnr1519y4i5r5ikKZYTGqR5b2ybEJORGdm3EcPzU X-APIG-Mode: debug { "roomIntroduce": "直播间简介", "cropLogoId": "76D356E93FA849C7987983EEAB94F4BE", "coverPictureId": "D8879E453B8F4277B95864A147B2F3C5", "showAudienceMode": "real_time", "isRedoubleOpen": "N", "baseAudienceCount": 12, "multiple": 1.5 }

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。 conference_id 是 String Path 网络研讨会ID。 roomIntroduce 否 String Body 网络研讨会介绍。长度限制为500个字符。 cropLogoId 否 String Body 企业logo的文件ID。上传文件后可获取，参考上传图片接口。 coverPictureId 否 String Body 欢迎界面的文件ID。上传文件后可获取，参考上传图片接口。 showAudienceMode 否 String Body 显示观众人数的模式。不填时，默认为real_time。 none：不显示 real_time：实时显示。 isRedoubleOpen 否 String Body 显示观众观看人数智能倍增开关。不填时，默认为Y。 Y：开启智能倍增 N：关闭智能倍增 baseAudienceCount 否 Integer Body 基础设置人数(直播间没人时显示的人数)。不填时，默认为0。 取值范围为[0, 10000]。 multiple 否 Double Body 设置倍数(基础人数+真实人数*倍数)。不填时，默认为1.0。 取值范围为[1.0, 10.0]，取1位小数。

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 1329 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: 24fa2ceds823efa03629afd189da7f0d { "creationTimestamp": 1592795500847, "fileCode": "31531e3de7904613a2364c9e1df1fe11", "fileId": "5", "fileName": "20200622_111136_meeting_record.White.cwb", "fileSize": 8044, "fileUrl": "https://usg-sss-meeting-file-078bb3cf07ac46bf8b30ae23a0efe047.obs.cn-north-4.myhuaweicloud.com:443/8454/80f44a5dbc744804a90e254031285b64/c1217acca9c2454ca87649995cfe875d.cwb?AccessKeyId=9K64BZ4AQDLZGBBFLMQS&Expires=1619076436&Signature=%2Fkr7XSEECAHQF6841KG%2FKLtqsSM%3D", "pdfFileId": "7", "pdfFileName": "20200622_111136_meeting_record.White.pdf", "pdfFileSize": 63787, "pdfUrl": "https://usg-sss-meeting-file-078bb3cf07ac46bf8b30ae23a0efe047.obs.cn-north-4.myhuaweicloud.com:443/8454/80f44a5dbc744804a90e254031285b64/c1217acca9c2454ca87649995cfe875d.pdf?AccessKeyId=9K64BZ4AQDLZGBBFLMQS&Expires=1619076436&Signature=mttC4C6Y4Xo0GyX%2FRus2cNlU6yA%3D", "thumbnailFileId": "6", "thumbnailFileName": "20200622_111136_meeting_record.White.jpg", "thumbnailFileSize": 62816, "thumbnailUrl": "https://usg-sss-meeting-file-078bb3cf07ac46bf8b30ae23a0efe047.obs.cn-north-4.myhuaweicloud.com:443/8454/80f44a5dbc744804a90e254031285b64/c1217acca9c2454ca87649995cfe875d.jpg?AccessKeyId=9K64BZ4AQDLZGBBFLMQS&Expires=1619076436&Signature=NFjr33JV6jEEi31Gkk47IGNjigw%3D", "topic": "20200622_111136_meeting_record.White" }

请求消息示例 GET /v1/usg/sss/meeting-files/31531e3de7904613a2364c9e1df1fe11 Connection: keep-alive X-Access-Token: cnrCAod6XrUexF5jUWmyxlyEcRStV8AsLwVI Content-Type: application/json Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 file_code 是 String Path 会议纪要文件码。 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。

响应参数 表4 响应参数 参数 类型 描述 fileCode String 会议纪要文件码。 fileId String 文件Id。 fileName String 文件名。 fileSize Long 文件大小，单位字节。 pdfFileId String pdf文件Id。 pdfFileName String pdf文件名。 pdfFileSize Long pdf文件大小，单位字节。 thumbnailFileId String 缩略图文件Id。 thumbnailFileName String 缩略图文件名。 thumbnailFileSize Long 缩略图文件大小，单位字节。 topic String 文件主题。 creationTimestamp Long 文件创建时间戳。 fileUrl String 文件url。 pdfUrl String pdf文件url。 thumbnailUrl String 缩略图文件url。

请求消息示例 POST /v1/metrics/conference/threshold?thresholdType=AUDIO 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) { "latency": { "receiving": 500, "sending": 500 }, "jitter": { "receiving": 500, "sending": 500 }, "packetLoss": { "receiving": 20, "sending": 20 } }

CURL命令示例 curl -k -i -X POST -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -d 'thresholdType=AUDIO' https://api.meeting.huaweicloud.com/v1/metrics/conference/threshold -d'{"latency":{"receiving":500,"sending":500},"jitter":{"receiving":500,"sending":500},"packetLoss":{"receiving":20,"sending":20}}'

响应消息示例 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 { "code": "0", "message": "OK" }

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 thresholdType 是 String Query 阈值类型。 AUDIO：音频相关阈值 VIDEO：视频相关阈值 SCREEN：屏幕共享相关阈值 CPU：CPU相关阈值 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 latency 否 SetThresholdData object Body 延迟阈值设置值，单位为毫秒(ms) thresholdType = AUDIO/VIDEO/SCREEN时必填 thresholdType = CPU时无效 jitter 否 SetThresholdData object Body 抖动阈值设置值，单位为毫秒(ms) thresholdType = AUDIO/VIDEO/SCREEN时必填 thresholdType = CPU时无效 packetLoss 否 SetPacketThresholdData object Body 丢包率阈值设置值，单位为百分比(%) thresholdType = AUDIO/VIDEO/SCREEN时必填 thresholdType = CPU时无效 clientCpuMax 否 SetCPUThresholdData object Body 会议最大CPU阈值设置值，单位为百分比(%) thresholdType = AUDIO/VIDEO/SCREEN时无效 thresholdType = CPU时必填 systemCpuMax 否 SetCPUThresholdData object Body 系统最大CPU阈值设置值，单位为百分比(%) thresholdType = AUDIO/VIDEO/SCREEN时无效 thresholdType = CPU时必填 表3 SetThresholdData 数据结构 参数名称 参数类型 描述 receiving Integer 接收方向阈值设定值，单位为毫秒(ms)。 取值范围：0 - 10000。 sending Integer 发送方向阈值设定值，单位为毫秒(ms)。 取值范围：0 - 10000。 表4 SetPacketThresholdData 数据结构 参数名称 参数类型 描述 receiving Integer 接收方向阈值设定值，单位为百分比(%)。 取值范围：0 - 100。 sending Integer 发送方向阈值设定值，单位为百分比(%)。 取值范围：0 - 100。 表5 SetCPUThresholdData 数据结构 参数名称 参数类型 描述 cpu Integer CPU阈值设定值，单位为百分比(%)。 取值范围：0 - 100。

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header Access Token。 X-Request-ID 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。

CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token: cnrfzn5OLRjwoaOf2F7PfMwVjJ6zScFogbDE' -d '{"deptList": ["TJJmDQT28y"],"deviceList": ["4LtvhUfmv9"],"endTime": 86400000,"programList": ["bf4df44cb4b44c2980890d391d9be2fa"],"publishName": "VyOWbleXuu","startTime": 1000}' https://api.meeting.huaweicloud.com/v1/usg/sss/publications/ad0425d1f8c848eab352869b3f2552b8

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

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

请求消息示例 PUT /v1/usg/sss/publications/ad0425d1f8c848eab352869b3f2552b8 Connection: keep-alive X-Access-Token: cnrfzn5OLRjwoaOf2F7PfMwVjJ6zScFogbDE Content-Type: application/json Content-Length: 253 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "deptList": [ "TJJmDQT28y" ], "deviceList": [ "4LtvhUfmv9" ], "endTime": 86400000, "programList": [ "bf4df44cb4b44c2980890d391d9be2fa" ], "publishName": "VyOWbleXuu", "startTime": 1000 }

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 confUUID 是 String Query 会议UUID。 offset 否 Integer Query 查询偏移量。默认为0。 limit 否 Integer Query 查询数量。默认值20，最大500条。 searchKey 否 String Query 查询条件 。 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站点鉴权。 说明： 该参数将废弃，请勿使用。 Accept-Language 否 String Header 语言 。默认简体中文。 zh-CN：简体中文。 en-US：美国英文。

CURL命令示例 curl -k -i -X GET -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' 'https://api.meeting.huaweicloud.com/v1/mmc/management/conferences/history/confAttendeeRecord?confUUID=9a0fa6d10a5b11eaae5e191763c22c0e'

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 337 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: 2f3aa1fe64f6784b1eb6f75a67ef2b9d Server: api-gateway X-Request-Id: ba03d2ae3b805d8c545c83494c862b48 { "data": [ { "displayName": "user8002", "callNumber": "+991116004380", "deviceType": "软终端", "joinTime": 1574119917872, "leftTime": 1574119956881, "mediaType": "视频", "deptName": "wangyue" }, { "displayName": "+991116005905", "callNumber": "+991116005905", "deviceType": "软终端", "joinTime": 1574119935467, "leftTime": 1574119947620, "mediaType": "视频", "deptName": "wangyue" } ], "offset": 0, "limit": 20, "count": 2 }

请求消息示例 GET /v1/mmc/management/conferences/history/confAttendeeRecord?confUUID=9a0fa6d10a5b11eaae5e191763c22c0e 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)

响应参数 表4 响应参数 参数 类型 描述 offset Integer 查询偏移量。 limit Integer 每页的记录数。 count Integer 总记录数。 data Array of data objects 与会者列表。 表5 data数据结构说明 参数 类型 描述 displayName String 与会者名称。 callNumber String 号码。 deviceType String 设备类型。 joinTime long 入会时间（UTC时间，单位毫秒）。 leftTime long 离会时间（UTC时间，单位毫秒）。 mediaType String 媒体类型。 deptName String 部门名称。

请求消息示例 PUT /v1/mmc/control/conferences/duration?conferenceID=914083136 Connection: keep-alive X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb 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) { "auto": 0, "duration": 40 }

CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' -d '{"auto": 0,"duration": 40}' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/duration?conferenceID=914083136

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 X-Conference-Authorization 是 String Header 会控Token，通过获取会控token接口获得。 auto 是 Integer Body 0：手动延长 1：自动延长（未携带延长时间时，默认每次延长15分钟） duration 否 Integer Body 延长时间，单位为分钟。 默认值：15