华为云用户手册

  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header token鉴权。 X-Request-ID 否 String Header 请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 Accept-Language 否 String Header 语言参数,默认为中文zh-CN,英文为en-US。
  • 请求消息示例 POST /v1/usg/acs/auth/portal-ref-nonce Connection: keep-alive X-Access-Token: cnrJmYwhPxsnNLky5APQm1hqWfXCDUN3d1lH Content-Type: application/json 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: f48fd467413ebe6032fa102ba53fcafe Server: api-gateway X-Request-Id: f6cab3797cb5b310d498c0e97db0f927
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' -d '{"isMute":1}' 'https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/mute?conferenceID=914083136'
  • 请求消息示例 PUT /v1/mmc/control/conferences/mute?conferenceID=914083136 Connection: keep-alive Content-Type: application/json X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb Content-Length: 20 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "allowUnmuteByOneself":1, "isMute":1 }
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 X-Conference-Authorization 是 String Header 会控Token,通过获取会控token接口获得。 isMute 是 Integer Body 0:取消静音 1:静音 allowUnmuteByOneself 否 Integer Body 是否允许自己解除静音(仅静音时有效),默认为允许。 0: 不允许 1: 允许
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' -d '{"manualSet": 0}' 'https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/display/customMultiPicture?conferenceID=900967789'
  • 请求消息示例 PUT /v1/mmc/control/conferences/display/customMultiPicture?conferenceID=900967789 Connection: keep-alive X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb Content-Type: application/json Content-Length: 27 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "manualSet": 1, "subscriberInPics":[{ "index": 2, "subscriber": ["+99111252010982686"] }], "imageType":"Six", "multiPicSaveOnly": false }
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 X-Conference-Authorization 是 String Header 会控Token,通过获取会控token接口获得。 manualSet 是 Integer Body 是否为手工设置多画面。 0: 系统自动多画面 1: 手工设置多画面 picLayoutInfo 否 PicLayoutInfo object Body 会议自定义多画面布局信息。 说明: 预留参数,当前版本不可用。 imageType 否 String Body 画面类型。手工设置多画面时有效。imageType取值和画面布局的对应关系详见图1。 subscriberInPics 否 Array of SubscriberInPic objects Body 子画面列表(手工设置多画面时必填)。 switchTime 否 Integer Body 表示轮询间隔,取值范围:10-120,默认10。单位:秒。 当同一个子画面中包含有多个与会者时,此参数有效。 说明: 仅针对专业会议终端生效,对软终端不生效。 multiPicSaveOnly 否 Boolean Body 多画面是否仅保存。 true: 仅保存 false: 保存并应用 说明: ”仅保存“效果:仅保存当前画面布局,不进行广播等操作。 ”保存并应用“效果: 1、当会议状态为广播多画面、声控单画面、声控多画面、主持人观看多画面时,保存并应用后,改变画面布局,不改变状态。 2、当会议状态为非广播多画面、声控单画面、声控多画面、主持人观看多画面时,如自动多画面、广播与会者、点名与会者时,保存并应用后,变为广播多画面。 当处于广播多画面、声控多画面、声控单画面状态下,无法设置主持人观看多画面。 图1 imageType(画面类型)参考 imageType取布局图下方的字符串。举例说明:如果需要设置多画面样式为均分四画面,则imageType设置为“Four”。 表3 PicLayoutInfo数据结构 参数 是否必须 类型 描述 x 否 Integer 多画面布局的宽度。 y 否 Integer 多画面布局的高度。 subPicLayoutInfoList 否 Array of SubPicLayoutInfo objects 子画面布局具体列表。 表4 SubPicLayoutInfo数据结构 参数 是否必须 类型 描述 id 否 Integer 画面索引号。 left 否 Integer 画面从左到右的坐标点。 top 否 Integer 画面从上到下的坐标点。 xSize 否 Integer 小画面的宽度。 ySize 否 Integer 小画面的高度。 表5 SubscriberInPic 数据结构 参数 是否必须 类型 描述 index 否 Integer 多画面中每个画面的编号。编号从1开始。 默认值为“1”。 subscriber 否 Array of strings 每个画面中与会者号码,从查询会议实时信息接口返回participants中的phone中获取。 isAssistStream 否 Integer 是否为辅流。默认值为0。 0: 不是辅流 1: 是辅流
  • 响应消息示例 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: 6346df97898dcd1e9cb205b75f24fe65 Server: api-gateway X-Request-Id: 0294dd7aedd58db92a23de453cbcde0e
  • 响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 1164 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: 8f0e783fe77359870eaccf323db080b5 [ { "type": "TE", "model": "TE10", "enableActiveCode": true, "resolution": "720P", "supportProjectionCode": false, "supportSVC": null }, { "type": "TE", "model": "TE20", "enableActiveCode": true, "resolution": "1080P", "supportProjectionCode": false, "supportSVC": null } ]
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 Accept-Language 否 String Header 语言参数,默认为中文zh-CN,英文为en-US。
  • 响应参数 表4 响应参数 参数 类型 描述 [数组元素] Array of QueryDeviceTypeResultDTO 查询到的终端类型列表 表5 QueryDeviceTypeResultDTO数据结构 参数 类型 描述 enableActiveCode Boolean 是否支持激活码。 model String 终端型号,枚举类型。 TE10 TE20 TE30 TE40 TE50 TE60 HUAWEI Box 300 HUAWEI Box 500 HUAWEI Box 600 HUAWEI Box 700 HUAWEI Box 900 DP300 HUAWEI Box 200 HUAWEI Box 300 HUAWEI Box 500 HUAWEI Board polycom cisco resolution String 屏幕分辨率。1080P、720P等。 supportProjectionCode Boolean 是否支持投影码。 supportSVC Boolean 是否支持SVC。 type String 终端类型,区分自研和第三方终端。 TE:华为自研硬终端 3rd:第三方硬终端
  • 请求消息示例 POST /v1/usg/dcs/sp/corp/818803911/resource/delete Connection: keep-alive X-Access-Token: stbvmKo5lr6vT7QIzKHg4iqicUBcYMb3qlki Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) [ "5d35397d67504dd1b7e1766a25f1be11", "45b18534f2cd4c96b97b6bf0ce298146" ]
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 corp_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。 [数组元素] 是 Array of strings Body 待删除的资源Id列表,最多支持批量处理100个。
  • 请求消息示例 POST /v1/mmc/management/conferences/start 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) { "conferenceID": "986030665", "password": "******" }
  • 响应消息示例 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 { "uuid": "stb7fe307f8971e44acc5cf8be2112575ff8387ff6ddea68a5e", "regionIP": "100.94.23.40" }
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -d '{"conferenceID": "986030665","password": "******"}' 'https://api.meeting.huaweicloud.com/v1/mmc/management/conferences/start'
  • 响应消息示例 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
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -d '{"callNum":"+8688665599", "orgID":"115489", "pwd":"******", "numBelongsType":0, "isNotOverlayPidName":false}' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/ inviteWithPwd?conferenceID=914083136
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 callNum 是 String Body 被邀请者的SIP号码。 orgID 否 String Body 被邀请者所属企业ID。 confID 是 String Body 当前会议ID。 pwd 是 string body 会议的密码(主持人或者来宾)。 numBelongsType 否 Integer Body SIP号码类型。默认是0。 0:华为云会议的号码 1:VC会议的号码 isNotOverlayPidName 否 Boolean Body 是否不叠加会场名(VDC场景下适用)。
  • 请求消息示例 PUT /v1/mmc/control/conferences/inviteWithPwd?conferenceID=914083136 Connection: keep-alive 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) { "callNum":"+99111253020382685", "orgID":"115489", "pwd":"******", "numBelongsType":0, "isNotOverlayPidName":false, "confID":"914083136" }
  • 响应参数 表4 响应参数 参数 类型 描述 id String 节目ID。 lastUpdatedBy String 更新者。 materialSizeStr String 节目的总素材大小(含单位)。 playTime Integer 节目的总播放时长,单位秒。 programName String 节目名称。 updateTime Long 更新时间。 programItemList Array of ProgramItemResponseBase objects 节目素材列表。 表5 ProgramItemResponseBase 数据结构 参数 类型 描述 filePath String 素材云盘文件下载路径。 materialId String 素材ID。 materialName String 素材名称。 playTime Integer 播放时长。
  • 请求消息示例 GET /v1/usg/sss/programs/6cffb6ffbb6049d1b21c1c4e39fcb2e0 Connection: keep-alive X-Access-Token: cnrfzn5OLRjwoaOf2F7PfMwVjJ6zScFogbDE 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: a69e8b71ds78987ffc5eb844bsd5ca97 { "id": "0b95f012274443a1bb0a223c131284a6", "lastUpdatedBy": "", "updateTime": 1593538299852, "programName": "LhL85eKrB9", "materialSizeStr": "462.71KB", "playTime": 10, "programItemList": [ { "materialId": "c704066824c74dd79afc2e66f433b186", "materialName": "20200616165610218test_upload_material", "filePath": "https://mock/download-file", "playTime": 10 } ] }
  • 请求参数 表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。
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/live?conferenceID=914044873
  • 响应消息示例 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: 2d4c23187071a0491e07d795b0167d15 Server: api-gateway X-Request-Id: f78b007ec2dabf1498620131c7bc19e0
  • 请求消息示例 PUT /v1/mmc/control/conferences/live?conferenceID=914044873 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) { "isLive": 1 }
  • 响应消息示例 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 { "activeCode": "085***642" }
共100000条