华为云用户手册

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 startDate 是 Long Query 查询的起始日期，Unix时间戳（单位毫秒）。 endDate 是 Long Query 查询的截止日期，Unix时间戳（单位毫秒）。 offset 否 Integer Query 查询偏移量。 取值：大于等于0，默认值为0 大于等于最大条目数量，则返回最后一页的数据 limit 否 Integer Query 查询的条目数量。 取值：1-500，默认值为20 searchKey 否 String Query 查询条件。会议主题、会议预约人和会议ID等可作为搜索内容。长度限制为1-512个字符。 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。

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

响应参数 表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 该时间点的阈值。

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

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 file 是 File FormData 上传的头像图片，图片文件不超过10MB，尺寸不超过4096*4096。 user_id 是 String Path 企业用户的UUID。

请求消息示例 POST /v1/usg/abs/profile-images/322275929 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) { "file":[binary] }

响应消息示例 HTTP/1.1 200 Date: Mon, 13 Jul 2020 02:20:32 GMT Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: 5032547386ab1e2e6a24842e9e1abea9 ETag: 1365f1205df0b5b4b991c94250a36af0

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/abs/profile-images/322275929

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/abs/profile-images

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 file 是 File FormData 上传的头像图片，图片文件不超过10MB，尺寸不超过4096*4096。

请求消息示例 POST /v1/usg/abs/profile-images 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) { "file":[binary] }

响应消息示例 HTTP/1.1 200 Date: Mon, 13 Jul 2020 02:20:32 GMT Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: 5032547386ab1e2e6a24842e9e1abea9 ETag: 1365f1205df0b5b4b991c94250a36af0

使用已购买的专用云会议室资源发起会议 1、使用企业管理员账号，调用企业管理员分页查询企业云会议室接口，可以查询到企业下云会议室资源的信息及分配情况 2、将购买的云会议室分配给指定的会议用户账号，详见分配云会议室 3、登录刚被分配会议室的会议用户账号，调用“创建会议”接口的时候，需要填写vmrFlag和vmrID两个参数，如图3。 ① vmrFlag按照提示填写1即可； ② vmrID为步骤1时查询到的“id”，如图。

请求消息示例 GET /v1/usg/dcs/sp/resource?queryGroup=true Connection: keep-alive X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

响应消息示例 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: 439e8b710378987ffc5eb844b5e5c297 { "confCallCount": { "expiredCount": 0, "expiringCount": 0, "sumCount": 20, "trialCount": 0, "usedCount": 6 }, "corpCount": { "expiredCount": 0, "expiringCount": 0, "sumCount": 1, "trialCount": 0, "usedCount": 0 }, "enablePstn": true, "enable SMS ": true, "hwVisionCount": { "expiredCount": 0, "expiringCount": 0, "sumCount": 2, "trialCount": 0, "usedCount": 0 }, "ideaHubCount": { "expiredCount": 0, "expiringCount": 0, "sumCount": 0, "trialCount": 0, "usedCount": 0 }, "liveCount": { "expiredCount": 0, "expiringCount": 0, "sumCount": 20, "trialCount": 0, "usedCount": 6 }, "recordCapability": { "expiredCount": 0, "expiringCount": 0, "sumCount": 20, "trialCount": 0, "usedCount": 5 }, "roomCount": { "expiredCount": 0, "expiringCount": 0, "sumCount": 20, "trialCount": 0, "usedCount": 4 }, "te1080pHardCount": { "expiredCount": 0, "expiringCount": 0, "sumCount": 20, "trialCount": 0, "usedCount": 1 }, "te720pHardCount": { "expiredCount": 0, "expiringCount": 0, "sumCount": 20, "trialCount": 0, "usedCount": 2 }, "teSoftCount": { "expiredCount": 0, "expiringCount": 0, "sumCount": 20, "trialCount": 0, "usedCount": 3 }, "thirdPartyHardCount": { "expiredCount": 0, "expiringCount": 0, "sumCount": 20, "trialCount": 0, "usedCount": 7 }, "groupList": [ { "groupId": "297e87ec7713734b01771458c2d80000", "groupName": "测试分组", "groupType": 3, "regionId": "393e8fec7413734b01s71458c2d80s01", "remarks": "测试", "status": 0 } ] }

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 queryGroup 否 Boolean Query 是否在查询资源信息时返回媒体接入分组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 响应参数 参数 类型 描述 confCallCount ResDetailDTO object 会议并发方数。 corpCount ResDetailDTO object 企业总数。 enablePstn Boolean 在创建企业的时候设置的pstn权限开关。 enableSMS Boolean 企业是否通过短信形式发送会议通知。 groupList Array of QueryCorpGroupDTO objects SP管理员绑定的分组列表。 hwVisionCount ResDetailDTO object 智慧屏TV接入数。 ideaHubCount ResDetailDTO object IdeaHub接入数。 liveCount ResDetailDTO object 推流并发方数。 recordCapability ResDetailDTO object 录播存储空间 （单位：G）。 roomCount ResDetailDTO object 电子白板（SmartRooms）接入数。 te1080pHardCount ResDetailDTO object 1080P硬终端接入数。 te720pHardCount ResDetailDTO object 720P硬终端接入数。 teSoftCount ResDetailDTO object 软终端账号数。 thirdPartyHardCount ResDetailDTO object 第三方硬终端接入数。 表5 QueryCorpGroupDTO 数据结构 参数 类型 描述 groupId String 媒体接入分组id。 groupName String 分组名称。 groupType Integer 分组类型。 regionId String 区域ID，仅服务列表类型场景必填。 remarks String 分组备注信息。 status Integer 分组状态。 0: 正常 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: 639e8b710378987ffc5eb844b5e5c291 { "count": 1, "data": [ { "activeCode": "324****97", "deptCode": "1", "deptName": "测试部门", "devName": "test_device", "devType": "idea-hub", "expireDate": 1611250137942, "id": "6d35397d67504dd1b7e1766a25f1be12" } ], "limit": 10, "offset": 0 }

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

响应参数 表4 响应参数 参数 类型 描述 count Integer 总数量。 limit Integer 每页显示的条目数量。 默认值：10。 offset Integer 页面起始页，从0开始。 data Array of QueryVisionActiveCodeResultDTO objects 激活码信息。 表5 QueryVisionActiveCodeResultDTO 数据结构 参数 类型 描述 activeCode String 激活码。 deptCode String 部门编码。 deptName String 部门名称。 devName String 终端名称。 devType String 终端类型。 expireDate Long 失效时间戳。 id String 激活码唯一标识。

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 offset 否 Integer Query 查询偏移量，若超过最大数量，则返回最后一页。 默认值：0 limit 否 Integer Query 查询数量。 默认值：10 searchKey 否 String Query 搜索条件，支持激活码、终端名称模糊搜索。 devType 否 String Query 终端类型。 idea-hub：智能协作大屏 huawei-vision：智慧屏TV welink-desktop(iwb)：SmartRooms会议版 smart-rooms：SmartRooms完整版 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/vision/activecode/test_account/reset Connection: keep-alive X-Access-Token: stbWbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOD content-type: application/json Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)) { "country": "chinaPR", "emailAddr": "******", "smsNumber": "+86173****9092" }

CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token: stbWbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOD' -d '{"country": "chinaPR","emailAddr": "******","smsNumber": "+86173****9092"}' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/vision/activecode/test_account/reset

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 account 是 String Path 华为云会议账号。 可通过“分页查询用户”接口查询获取，对应接口返回userAccount字段。 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。 country 否 String Body 手机号所属的国家。 默认值：chinaPR。 maxLength：255 minLength：0 emailAddr 否 String Body 邮箱地址。 maxLength:255 minLength:0 smsNumber 否 String Body 号码信息，如果为手机号，必须加上国家码。 例如中国大陆手机+86xxxxxxx，当填写手机号时 “country”参数必填，手机格式必须满足(^$|^[+]?[0-9]+$)。 maxLength:32 minLength:0

响应消息示例 HTTP/1.1 200 Date: Mon, 13 Jul 2020 02:20:32 GMT Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: 6032547386ab1e2e6a24842e9e1abea3 { "activeCode": "085****662" }

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

CURL命令示例 curl -k -i -H 'content-type: application/json' -X DELETE -H 'X-Access-Token: stbWbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOD' -d '["6d35397d67504dd1b7e1766a25f1be12"]' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/vision/activecode

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