华为云用户手册

请求消息示例 GET /v1/usg/dcs/corp/device Connection: keep-alive X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Content-Type: application/json Content-Length: 119 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 offset 否 Integer Query 查询偏移量，若超过最大数量，则返回最后一页。 limit 否 Integer Query 查询数量。 默认值：10 searchKey 否 String Query 搜索条件。支持名称、SN模糊查询。 model 否 String Query 终端型号，枚举类型。当前支持TE系列硬件终端，具体的终端类型可以通过获取所有终端类型接口查询。 maxLength：128 minLength：0 deptCode 否 String Query 部门编码，默认为根部门。 默认值：1 maxLength：32 minLength：0 enableSubDept 否 Boolean Query 是否查询子部门。 默认值：true X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 sn 是 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。 country 否 String Body 手机号所属的国家。 默认值：chinaPR。 emailAddr 否 String Body 邮件地址。 说明： 号码和邮箱必须填一个，若企业未开启短信功能，则邮箱必填。 smsNumber 否 String Body 手机号。例如中国大陆手机+86xxxxxxxxxxx。当填写手机号时 “country”参数必填。 说明： 号码和邮箱必须填一个，若企业未开启短信功能，则邮箱必填。

请求消息示例 POST /v1/usg/dcs/corp/device/asdasfscasd/activecode 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) { "smsNumber": "+86***********", "country": "chinaPR", "emailAddr": "******" }

响应消息示例 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 -H 'content-type: application/json' -X POST -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' -d '{"smsNumber": "+86***********","country": "chinaPR","emailAddr": "******"}' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/device/asdasfscasd/activecode

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 sn 是 String Path 终端SN号，仅可包含数字、字母和下划线。 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。 deptCode 否 String Body 部门编码，默认为根部门。 默认值：1 description 否 String Body 终端描述。 maxLength：128 minLength：0 email 否 String Body 统一邮箱格式。 name 否 String Body 终端名称，建议为具体位置。 maxLength：64 minLength：0 phone 否 String Body 手机号，必须加上国家码。 例如中国大陆手机为“+86xxxxxxxxxxx”，当填写手机号时 “country”参数必填。 手机号只允许输入纯数字。 说明： 手机号或者邮箱至少填写一个。 prjCodeMode 否 Integer Body 投影码生成模式。 0：自动 该模式下根据消息上报的IP地址内部控制复杂度。私网地址配置成简单模式，公网地址配置成复杂模式。 1：简单 2：复杂 status 否 Integer Body 终端状态。 0：正常 1：冻结

请求消息示例 PUT /v1/usg/dcs/corp/device/asdasfscasd Connection: keep-alive X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Content-Type: application/json Content-Length: 198 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "name": "test", "deptCode": "1", "email": "******", "country": "chinaPR", "description": "test", "status": 0 }

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

CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' -d '{"model": "TE20","name": "test","deptCode": "1","email": "******","country": "chinaPR","description": "test","status": 0}' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/device/asdasfscasd

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

响应参数 表4 响应参数 参数 类型 描述 count Integer 总记录数。 limit Integer 查询条目数量。 offset Integer 查询偏移量。 data Array of QosParticipantInfo objects QoS会议与会者列表。最多返回500条记录。 表5 QosParticipantInfo数据结构 参数名称 参数类型 描述 confUUID String 会议UUID。 conferenceID String 会议ID。 participantID String 与会者标识。 userUUID String 用户UUID。 displayName String 与会者的名称。 deptName String 部门名称。 terminalType String 入会终端类型。 PC: PC MOBILE: 手机 PAD：PAD设备 MAC：MAC设备 WEB：WEB方式入会，如通过WebRTC入会 ROOM：会议室 硬件终端：显示具体的硬件设备类型，如TE50, HUAWEI IDEAHUB, CISCO等 OTHER: 其他设备 role String 与会者角色。 host：主持人 guest：来宾 audience：观众 ipAddress String 与会者的IP地址。 country String 国家。 province String 省市（仅限中国）。 city String 城市（仅限中国）。 appVersion String 华为云会议APP版本。 joinTime Long 入会时间（UTC时间），Unix时间戳（单位毫秒）。 leftTime Long 离会时间（UTC时间），Unix时间戳（单位毫秒）。 说明： 与会者未离会：leftTime = 0 与会者已离会：leftTime = 实际离会时间 systemInfo String 终端操作系统信息。 networkType String 网络类型。 alarm String 总体告警 。 YES：音频（发送/接收），视频（发送/接收），屏幕共享（发送/接收），CPU任一项产生告警，总体告警状态即为 YES NO：无告警 audioAlarmSend String 音频发送告警 。 YES ：发送音频的抖动，时延，丢包率任一项产生阈值告警，则音频发送告警状态为YES NO：发送音频无告警 videoAlarmSend String 视频发送告警 。 YES ：发送视频的抖动，时延，丢包率任一项产生阈值告警，则视频发送告警状态为YES NO：发送视频无告警 screenAlarmSend String 屏幕共享发送告警 。 YES：发送屏幕共享的抖动，时延，丢包率任一项产生阈值告警，则屏幕共享发送告警状态为YES NO：发送屏幕共享无告警 audioAlarmRec String 音频接收告警。 YES：接收音频的抖动，时延，丢包率任一项产生阈值告警，则音频接收告警状态为YES NO：接收音频无告警 videoAlarmRec String 视频接收告警。 YES：接收视频的抖动，时延，丢包率任一项产生阈值告警，则视频接收告警状态为YES NO：接收视频无告警 screenAlarmRec String 屏幕共享接收告警。 YES：接收屏幕共享的抖动，时延，丢包率任一项产生阈值告警，则屏幕共享接收告警状态为YES NO：接收屏幕共享无告警 cpuAlarm String CPU告警。 YES：端侧的APP最大CPU使用率或系统最大CPU使用率任一项产生阈值告警，则CPU告警状态为YES NO：CPU无告警 microphoneInfo String 麦克风。 speakerInfo String 扬声器。 cameraInfo String 摄像头。 dataCenter String 数据中心。 leftReason Integer 离会原因。此字段仅标识离会原因，不做为是否已离会的判断依据。正在与会人员的离会原因初始值 = 0。 0：正常离会 1：网络异常离会 existQos Boolean 与会者是否存在QoS数据。 true：存在QoS数据 false：不存在QoS数据

请求消息示例 GET /v1/metrics/conference/participants?confUUID=a3d9a31c8af211eb8075a12479434adb&confType=history&offset=0&limit=20&searchKey=深圳分部 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": 1, "limit": 10, "offset": 0, "data": [{ "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, "existQos": true }] }

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 confUUID 是 String Query 会议UUID。 confType 是 String Query 会议类别。 online：在线会议，正在召开的会议 history：历史会议，已结束的会议 offset 否 Integer Query 查询偏移量。 取值：大于等于0，默认值为0。 大于等于最大条目数量，则返回最后一页的数据。 limit 否 Integer Query 查询的条目数量。 取值：1-500，默认值为20。 searchKey 否 String Query 查询条件。与会者名称可作为搜索内容。长度限制为1-512个字符。 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。

响应参数 表4 响应参数 参数 类型 描述 confUUID String 会议UUID。 confID String 会议ID。 url String[] 录播观看地址。 rcdTime Integer 录制时长（单位秒）。 rcdSize Integer 录制文件大小（MB）。 subject String 会议主题。 scheduserName String 会议预订者名称。 startTime String 会议开始时间。 isDecodeFinish Boolean 录制文件是否转码完成。 decodeEndTime long 录制文件预计转码完成时间。 available Boolean 录播文件是否可观看。 recordAuthType Integer 观看/下载录播的鉴权方式。 0: 可通过链接观看/下载 1: 企业用户可观看/下载 2: 与会者可观看/下载

CURL命令示例 curl -k -i -X GET -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' 'https://api.meeting.huaweicloud.com/v1/mmc/management/conferences/record/files?confUUID=51adf610220411eaaae03f22d33cc26b'

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 confUUID 是 String Query 会议UUID(通过查询录制列表获取)。 userUUID 否 String Query 用户的UUID。 说明： 该参数将废弃，请勿使用。 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Authorization-Type 否 String Header 标识是否为第三方portal过来的请求。 说明： 该参数将废弃，请勿使用。 X-Site-Id 否 String Header 用于区分到哪个HCSO站点鉴权。 说明： 该参数将废弃，请勿使用。

请求消息示例 GET /v1/mmc/management/conferences/record/files?confUUID=51adf610220411eaaae03f22d33cc26b 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: 505 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: 4556e88832e5990723d1712395f5bee8 Server: api-gateway X-Request-Id: 629891c82bb852d8796e2f6acc74721e { "confUUID": "51adf610220411eaaae03f22d33cc26b", "confID": "912049654", "url": [ "https://114.116.237.2/rse/rse/html/play/Mediaxplay.html?rseid=00030&recordId=000301fa-0512-412f-b363-cb9f76063628&token=24e4f6d9850a42365783c88ceb36701bb87f5393a595af82&confID=51adf610220411eaaae03f22d33cc26b&isSecure=true" ], "rcdTime": 71, "rcdSize": 0, "subject": "user8002的会议", "scheduserName": "user8002", "startTime": "2019-12-19 02:07", "isDecodeFinish": true, "decodeEndTime": 1576721412885, "available": true, "recordAuthType":2 }

响应参数 表4 响应参数 参数 类型 描述 [数组元素] Array of QueryDeptResultDTO 部门列表 表5 QueryDeptResultDTO数据结构 参数 类型 描述 corpId String 企业ID。 deptCode String 部门编码，企业内唯一。 deptCodePath String 部门编码路径。 deptLevel Integer 部门层级。 deptName String 部门名称。 deptNamePath String 部门名路径。 designatedOutDeptCodes Array of IdMarkDTO objects 允许访问的部门列表。 inPermission String 其他用户对该部门下用户的访问权限。 isLeafNode Boolean 是否叶子节点。 note String 备注。 outPermission String 该部门下用户访问权限控制。 parentDeptCode String 父部门编码。 sortLevel Integer 部门排序号。

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

响应消息示例 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: 539e8b710378987ffc5eb844b5e5c290 [ { "deptCode": "1", "deptLevel": 1, "deptName": "wangyue", "deptNamePath": "wangyue", "isLeafNode": false, "parentDeptCode": null, "deptCodePath": "1", "note": null, "corpId": "15659", "inPermission": "UNLIMITED", "outPermission": "UNLIMITED", "sortLevel": 10000, "designatedOutDeptCodes": [] } ]

请求消息示例 GET /v1/usg/dcs/member/dept?deptName=wangyue Connection: keep-alive X-Access-Token: stbvmKo5lr6vT7QIzKHg4iqicUBcYMb3qlki Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

CURL命令示例 curl -k -i -X PUT -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' 'https://api.meeting.huaweicloud.com/v1/mmc/management/webhook/change-status?id=b21e0291639911ecb31073dbfc5b38fa&status=1'

请求消息示例 PUT /v1/mmc/management/webhook/change-status?id=b21e0291639911ecb31073dbfc5b38fa&status=1 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: 39 Connection: keep-alive http_proxy_id: 40c9d32a92b43f85e5cd12617b49535b Server: api-gateway X-Request-Id: a02164ff20cbc841c6c0e9ab38a07e5b

请求示例 PUT https://{endpoint}/v1/mmc/control/conferences/participants/batch/hands?conferenceID=914376690 { "handsState" : 1, "pids" : [ "af50e9e63b4111ea9668df997d1c89da", "cf50e9e63b41e63b49697d197d11ea9d" ] }

描述 用户使用手机扫码后，手机端请求服务端，让服务端通知指定IdeaHub打开指定用户的会议纪要文件列表。二维码内容 ：cloudlink://cloudlink.huawei.com/h5page?action=OPEN_MEETING_FILE_LIST&key1=value1&key2=value2 。key/value的个数可能变化，终端解析后，在发起后续请求时，将所有key/value存为map，作为入参即可。

请求消息示例 POST /v1/usg/sss/meeting-files/open-meeting-file-list 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) { "uuid": "00842ae2249c4e508df7240cce5c7f5b" }