华为云用户手册

请求消息示例 POST /v2/usg/acs/corp/app Connection: keep-alive Content-Type: application/json X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "app_name": "企业应用添加测试", "description": "企业应用添加测试" }

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header Access Token。通过执行App ID鉴权接口返回的accessToken。 X-Request-Id 否 String Header 请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 app_name 是 String Body 企业应用名称 description 否 String Body 企业应用描述

响应消息示例 HTTP/1.1 200 OK X-Request-Id: 01ab6499-db00-4029-9600-82046297767c Pragma: no-cache Cache-Control: no-cache Expires: Thu, 01 Jan 1970 00:00:00 GMT X-Xss-Protection: 1; mode=block X-Download-Options: noopen X-Content-Type-Options: nosniff Strict-Transport-Security: max-age=31536000; includeSubDomains X-Frame-Options: SAMEORIGIN Content-Security-Policy: connect-src 'self' *.huaweicloud.com ;style-src 'self' 'unsafe-inline' 'unsafe-eval';object-src 'self'; font-src 'self' data:; Vary: Origin,Access-Control-Request-Method,Access-Control-Request-Headers Etag: "03eb377e7dedca62136c5db551858b5f6" Content-Type: application/json;charset=UTF-8 Content-Length: 134 Date: Thu, 29 Aug 2024 09:24:48 GMT X-Envoy-Upstream-Service-Time: 34 Server: istio-envoy Requestid: 01ab6499-db00-4029-9600-82046297767c { "random": "397381479198454", "subject": "zhang的会议", "conf_mode": "RTC", "webinar": false, "need_password": false, "support_applets": true }

请求消息示例 GET /v2/mms/ncms/conferences/auth/random?conf_id=914047175 Connection: keep-alive X-Access-Token: ******* X-Password: ******* user-agent: WeLink -desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

请求示例 POST https://{endpoint}/v1/mmc/cqs/media/qos?conferenceid=969271421&appid=605876aefa163e971ba21f8a40097b51&confuuid=cabcf4ec031749f594cdfc26bf0dba9e { "users": [ { "pid": "913e3ce2345e11ef8dec5f2fea0eff1a", "accessMediaType": "MGR" } ] }

响应示例 状态码： 200 { "returnCode": 0, "returnDesc": "Success", "qosList": [ { "participantID": "913e3ce2345e11ef8dec5f2fea0eff1a", "netRate": "5", "bandWidthUp": 98, "bandWidthDown": 0, "lostPacketRateUp": 0, "lostPacketRateDown": 0, "delay": 77, "videoQos": { "upList": [], "downList": [] }, "audioQos": { "upList": [ { "codecType": "OPUS", "bandWidth": 81, "lostPacketRate": 0, "delay": 77, "jitter": 10, "resolutionHeight": 0, "resolutionWidth": 0, "frameRate": 0 } ], "downList": [] }, "auxQos": { "upList": [ { "codecType": "H.265", "bandWidth": 17, "lostPacketRate": 0, "delay": 121, "jitter": 11, "resolutionHeight": 0, "resolutionWidth": 0, "frameRate": 2, "codecUserId": "913e3ce2345e11ef8dec5f2fea0eff1a" } ], "downList": [] } } ] }

推送用户离会事件示例 请求消息： POST /openapi/meetingevent Date: Tue, 17 Dec 2022 16:06:36 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": 1671523596351, "nonce": "60426560", "signature": "e3945cab9c583f394ae5e4957b83905e779cacaa2377d9542e19e011cc60a139", "eventInfo": { "event": "meeting.left", "timestamp": 1671523596351, "payload": { "meetingInfo": { "meetingID": "987446316", "meetingUUID": "0307e0400f0a11eca58a9fcb8e69dde8" }, "attendeeInfo":{ "userUUID":"f39228ec18ed4ff88afa754a69832952", "userAgent":"WeLink-desktop", "account":"yangtest01", "participantID":"ebbe4e6cdc6111ee960a91a270e1373e", "displayName":"yangtest01", "joinTime":1709802363369, "leftTime":1709802399449, "role":"CHAIR", "callNumber":"+86571264265330456" } } } } 响应消息： 响应： HTTP/1.1 200 Date: Tue, 17 Dec 2022 16:06:36 GMT Content-Type: application/json;charset=UTF-8 Connection: keep-alive X-Request-ID: 539e8b710378987ffc5eb844b5e5c290

推送编辑会议事件示例 请求消息： POST /openapi/meetingevent Date: Tue, 17 Dec 2022 16:06:36 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": 1671523596351, "nonce": "60426560", "signature": "e3945cab9c583f394ae5e4957b83905e779cacaa2377d9542e19e011cc60a139", "eventInfo": { "event": "meeting.modify", "timestamp": 1671523596351, "payload": { "meetingInfo": { "meetingID": "987446316", "meetingUUID": "0307e0400f0a11eca58a9fcb8e69dde8" } } } } 响应消息： 响应： HTTP/1.1 200 Date: Tue, 17 Dec 2022 16:06:36 GMT Content-Type: application/json;charset=UTF-8 Connection: keep-alive X-Request-ID: 539e8b710378987ffc5eb844b5e5c290

推送取消会议事件示例 请求消息： POST /openapi/meetingevent Date: Tue, 17 Dec 2022 16:06:36 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": 1671523596351, "nonce": "60426560", "signature": "e3945cab9c583f394ae5e4957b83905e779cacaa2377d9542e19e011cc60a139", "eventInfo": { "event": "meeting.cancel", "timestamp": 1671523596351, "payload": { "meetingInfo": { "meetingID": "987446316", "meetingUUID": "0307e0400f0a11eca58a9fcb8e69dde8" } } } } 响应消息： 响应： HTTP/1.1 200 Date: Tue, 17 Dec 2022 16:06:36 GMT Content-Type: application/json;charset=UTF-8 Connection: keep-alive X-Request-ID: 539e8b710378987ffc5eb844b5e5c290

推送用户入会事件示例 请求消息： POST /openapi/meetingevent Date: Tue, 17 Dec 2022 16:06:36 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": 1671523596351, "nonce": "60426560", "signature": "e3945cab9c583f394ae5e4957b83905e779cacaa2377d9542e19e011cc60a139", "eventInfo": { "event": "meeting.join", "timestamp": 1671523596351, "payload": { "meetingInfo": { "meetingID": "987446316", "meetingUUID": "0307e0400f0a11eca58a9fcb8e69dde8" }, "attendeeInfo":{ "userUUID":"f39228ec18ed4ff88afa754a69832952", "userAgent":"WeLink-desktop", "account":"yangtest01", "participantID":"ebbe4e6cdc6111ee960a91a270e1373e", "displayName":"yangtest01", "joinTime":1709802363369, "leftTime":0, "role":"CHAIR", "callNumber":"+86571264265330456" } } } } 响应消息： 响应： HTTP/1.1 200 Date: Tue, 17 Dec 2022 16:06:36 GMT Content-Type: application/json;charset=UTF-8 Connection: keep-alive X-Request-ID: 539e8b710378987ffc5eb844b5e5c290

推送预约会议事件示例 请求消息： POST /openapi/meetingevent Date: Tue, 17 Dec 2022 16:06:36 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": 1671523596351, "nonce": "60426560", "signature": "e3945cab9c583f394ae5e4957b83905e779cacaa2377d9542e19e011cc60a139", "eventInfo": { "event": "meeting.create", "timestamp": 1671523596351, "payload": { "meetingInfo": { "meetingID": "987446316", "meetingUUID": "0307e0400f0a11eca58a9fcb8e69dde8" } } } } 响应消息： 响应： HTTP/1.1 200 Date: Tue, 17 Dec 2022 16:06:36 GMT Content-Type: application/json;charset=UTF-8 Connection: keep-alive X-Request-ID: 539e8b710378987ffc5eb844b5e5c290

传译组信息推送示例 { "interpreterGroups": [{ "groupID": "f798ed8d5e45cb342baa6be0dc8b2068", "firstLanguage": "en", "secondLanguage": "zh", "interpreters": [{ "userID": "abe9848d09d640a99aa3c80087a722f0", "callNumber": "+99111229866410894", "name": "mmrcorp28" }] }], "confID": "969997441", "msgID": "2264c8e2996911ee9f7edbddf94c4172", "msgMode": 0, "version": 1702438732271, "createTime": 1702438732271, "action": "InterpreterGroupNotify" }

CURL命令示例 curl -k -i -X GET -H 'X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9' -d '[{"id": "ff8080816993bac00169bdf14e0800ad"},{"id": "718b8be14f09432caf66f3076505207b"}]' https://api.meeting.huaweicloud.com/v1/usg/abs/users/list?idType=USER_ID

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 646 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: 551aeb8cafbbaa7bbbdc7b1c76bba8ac [ { "account": "Zhangsan@example.com", "name": "张三", "englishName": "Zhangsan", "email": "******", "phone": "177****0476", "deptName": "cloudcore", "number": "+99111283523475338", "updateTime": 1554268817303, "isHardTerminal": false, "vmrId": "912992631", "signature": "张三的签名信息", "title": "Project Manager", "description": "张三的备注信息", "type": "NORMAL_USER", "deptCodes": [ "1" ] } ]

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 idType 是 String Query 查询类型。默认是USER_ID。 USER_ID：表示根据华为云会议用户ID查询用户详情 THIRD_ACCOUNT：表示根据第三方账号查询用户详情 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 ShowUserRequestDTO objects Body 用户ID或第三方账号信息列表。 minLength: 1 maxLength: 200 表3 ShowUserRequestDTO 数据结构 参数 是否必须 类型 位置 描述 id 否 String Body 用户ID或者第三方账号

响应参数 表5 响应参数 参数 类型 描述 [数组元素] Array of UserDTO objects 用户信息列表。 表6 UserDTO 数据结构 参数 类型 描述 id String 用户ID。 statusCode Integer 查询用户详情时, 根据不同情况，响应不同。 0： 查询成功且用户信息有变化， 响应会把新的信息都返回回去 1 ：查询成功且用户信息没有变化，响应只会返回用户ID 2 ：用户不存在 3 ：无权限查询这个用户 account String 用户账号。 name String 用户名。 englishName String 英文名。 email String 邮箱。 phone String 用户手机。 deptName String 用户部门。 number String 用户SIP号码。 updateTime Long 用户信息最后更新时间。 isHardTerminal Boolean 是否为硬终端。 说明： 该参数将废弃，请勿使用。 vmrId String 用户个人会议ID。 signature String 用户签名。 title String 职位。 description String 描述信息。 hidePhone Boolean 是否隐藏手机号（如果为true，其他人查询该用户时，不会返回该用户的手机号。自己查自己是可见的） type String 类型： NORMAL_USER=普通用户 HARD_TERMINAL=硬终端用户 WHITE_BOARD=第三方白板 HW_VISION_MEMBER=智慧屏 IDEA_HUB_MEMBER=ideahub用户 deptCodes Array of strings 部门编码列表。

请求消息示例 POST https://{endpoint}/v1/usg/abs/users/list?idType=USER_ID Connection: keep-alive X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) [ { "id": "ff8080816993bac00169bdf14e0800ad" }, { "id": "718b8be14f09432caf66f3076505207b" } ]

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Conference-Authorization 是 String 会控Token，通过获取会控token接口获得。 表3 请求Body参数 参数 是否必选 参数类型 描述 participantID 否 String 等候室成员标志。通过监听会议级事件推送中的“等候室成员列表信息”事件获得。 allowAll 否 Boolean 允许所有等候者入会。 false：指定等候者 true：所有等候者入会

响应示例 状态码： 200 响应成功 { "offset" : 0, "limit" : 5, "count" : 1, "data" : [ { "otherNumber" : "", "otherNumberCountry" : "", "country" : "chinaPR", "phone" : "+86135xxxx0611", "email" : "******", "corpName" : null, "deptName" : null, "position" : null, "address" : null, "remarks" : null, "id" : "af4aaae4b29d45649e3c61f48ee2f64b", "name" : "李四", "customNumber" : null, "type" : "CORP", "updateTime" : 1665994358499 } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 offset Integer 页面起始页，从0开始。 limit Integer 每页显示的条目数量。 默认值：10。 count Integer 总数量。 data Array of ExternalContactDTO objects 分页查询外部联系人信息。 表4 ExternalContactDTO 参数 参数类型 描述 otherNumber String 其他号码。 说明： 其他号码必须以国家码作为前缀 otherNumber填写时，otherNumberCountry也必须填写 如果要清空手机号配置，则otherNumberCountry和otherNumber都要置为"" 最小长度：0 最大长度：32 otherNumberCountry String 手机号所属的国家 。 最小长度：0 最大长度：32 country String 手机号所属的国家。 缺省值：chinaPR 最大长度：255 phone String 手机号。 说明： 手机号必须以国家码作为前缀 phone填写时，country也必须填写 如果要清空手机号配置，则country和phone都要置为"" 最小长度：0 最大长度：32 email String 邮箱。 最小长度：0 最大长度：255 corpName String 公司名称。 最小长度：0 最大长度：64 deptName String 部门。 最小长度：0 最大长度：64 position String 职务。 最小长度：0 最大长度：64 address String 个人地址。 最小长度：0 最大长度：1024 remarks String 备注。 最小长度：0 最大长度：1024 id String 外部联系人UUID。 name String 姓名。 customNumber String 外部联系人自定义号码。 说明： 仅VDC场景下使用。 updateTime Number 用户信息最后更新时间戳。 type String 外部联系人类型。 PERSONAL：个人外部联系人 CORP：企业外部联系人

请求参数 表1 Query参数 参数 是否必选 参数类型 位置 描述 offset 否 Integer Query 查询偏移量,若超过最大数量，则返回最后一页的数据。 默认值：0。 最小值：0 缺省值：0 limit 否 Integer Query 查询数量。 默认值：10。 最小值：1 最大值：500 缺省值：10 searchKey 否 String Query 搜索条件。支持名称、手机、邮箱模糊搜索。 最小长度：0 最大长度：1024 searchScope 否 String Query 搜索范围。默认值为ALL。 PERSONAL - 查询个人外部联系人 CORP - 查询企业外部联系人 ALL - 查询所有外部联系人 缺省值：ALL

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

推送录制结束事件示例 请求消息： POST /openapi/meetingevent Date: Tue, 17 Dec 2022 16:06:36 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": 1671523596351, "nonce": "60426560", "signature": "e3945cab9c583f394ae5e4957b83905e779cacaa2377d9542e19e011cc60a139", "eventInfo": { "event": "record.finish", "timestamp": 1671523596351, "payload": { "meetingInfo": { "meetingID": "987446316", "meetingUUID": "0307e0400f0a11eca58a9fcb8e69dde8", "meetingCycleSubID": "6038a614321511ecaf39ffbe33ed54dc" } } } } 响应消息： 响应： HTTP/1.1 200 Date: Tue, 17 Dec 2022 16:06:36 GMT Content-Type: application/json;charset=UTF-8 Connection: keep-alive X-Request-ID: 539e8b710378987ffc5eb844b5e5c290

等候室成员列表推送示例 { "data": [{ "pid": "eaaa0ff4670e11ed904fc9138207434e", "mode": 0, "delType": 0, "pinfoMap": { "NAME": "yangtest05", "ORG_ID": "44252", "ACCOUNT_ID": "35a2093d2d53430e87c41e2839bdd338", "ANONYMOUS": "0", "ACCOUNT": "yangtest05", "CLIENT_ LOG IN_TYPE": "Desktop", "TEL": "+86571234209651824", "THIRDACCOUNT": "yangtest05", "ADDTIME": "1668754928397" } }], "confID": "995261590", "msgID": "eac140a2670e11ed904fe9a6b133c0bf", "msgMode": 1, "version": 1, "createTime": 1668754928409, "action": "WaitingListNotify" }

响应参数 状态码： 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 错误码描述。

响应示例 状态码： 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" }

请求示例 PUT https://{endpoint}/v1/mmc/control/conferences/layOut?conferenceID=914370850 { "restPicLayout" : { "imageType" : "Two", "switchTime" : 10, "layOutName" : "my_saved_layout", "subscriberInPics" : [ { "index" : 1, "id" : [ "+99111221231895886" ], "share" : 0 }, { "index" : 2, "id" : [ "+99111221231894887" ], "share" : 0 } ] } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Conference-Authorization 是 String 会控Token，通过获取会控token接口获得。 表3 请求Body参数 参数 是否必选 参数类型 描述 restPicLayout 否 RestPicLayout object 会议多画面布局信息。 表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： 是辅流

响应参数 表4 QueryDeptResultDTO数据结构 参数 类型 描述 deptCode String 部门编码。 deptName String 部门名称。 isLeafNodes Boolean 是否为叶子节点(没有子部门的称为叶子节点)。 childDepts Array of ChildDeptDTO objects 子部门详情。 表5 ChildDeptDTO数据结构 参数 类型 描述 deptCode String 部门编码。 deptName String 部门名称。 isLeafNodes Boolean 是否为叶子节点(没有子部门的称为叶子节点)。

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