华为云用户手册

  • 响应消息示例 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: 539e8b710378987ffc5eb844b5e5c290 { "value": "s4f" }
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stbvmKo5lr6vT7QIzKHg4iqicUBcYMb3qlki' -d '{"deptName": "test999"}' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/dept
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conference_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。
  • 请求消息示例 GET /v1/wss/webinar/open/conferences/982311022 HTTP/1.1 Host: 251ba26eef46472d97fa4462d514b044.APIG.cn-north-7.huaweicloudapis.com User-Agent: APIGatewayDebugClient/1.0 X-Access-Token: cnr1519GbhwxP6eXPT70gHBabwCoAnFHezYAln4F X-APIG-Mode: debug
  • 响应参数 表4 响应参数 参数 类型 描述 conferenceId String 网络研讨会ID。 corpId String 企业ID。 subject String 会议主题。长度限制为128个字符。 description String 网络研讨会主题。 startTime String 网络研讨会开始时间(UTC时间),格式“yyyy-MM-dd HH:mm”。 duration Integer 网络研讨会持续时长,单位分钟,取值范围[15,1440]。 timeZoneId Integer 会议通知中会议时间的时区信息。时区信息,参考时区映射关系。 说明: 举例:“timeZoneID”:"26",则通过华为云会议发送的会议通知中的时间将会标记为如“2021/11/11 星期四 00:00 - 02:00 (GMT) 格林威治标准时间:都柏林, 爱丁堡, 里斯本, 伦敦”。 state String 会议状态。 schedule:预定状态 created:会议已经被创建并正在召开 destroyed:会议已经关闭 scheduserId String 网络研讨会预订者的用户UUID。 deptName String 预订者部门命名。 scheduserName String 预订者名称。 vmrPkgName String 网络研讨会VMR名称。 callRestriction Boolean 入会范围开关。 scope Integer 主持人、嘉宾入会范围。 0: 所有用户 2: 企业内用户 3: 被邀请用户 audienceScope Integer 观众入会范围。 0: 所有用户 2: 企业内用户和被邀请用户 chairJoinUri String 主持人入会地址。 chairPasswd String 主持人入会密码。 guestJoinUri String 嘉宾入会地址。 guestPasswd String 嘉宾入会密码。 audienceJoinUri String 观众入会地址。 audiencePasswd String 观众入会密码。 attendees Array of strings 与会嘉宾名称列表。 notifySetting NotifySetting object 网络研讨会通知配置。 enableRecording String 录制是否开启。 Y: 开启 N: 不开启 liveAddress String 主流直播推流地址。仅设置liveAddress,未设置auxAddress,无人共享时直播画面显示演讲者视图,有人共享时直播画面显示共享屏幕视图。若同时设置了liveAddress和auxAddress,liveAddress对应直播画面显示演讲者视图,auxAddress对应直播画面显示共享屏幕视图。 auxAddress String auxAddress对应辅流直播推流地址,在设置liveAddress后如果设置了auxAddress,liveAddress对应直播画面显示演讲者视图,auxAddress对应直播画面显示共享屏幕视图。 liveUrl String 直播观看地址。
  • 响应消息示例 HTTP/1.1 200 OK Transfer-Encoding: chunked 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:; Content-Type: application/json; charset=UTF-8 Date: Fri, 23 Apr 2021 07:44:58 GMT Pragma: no-cache Server: api-gateway Strict-Transport-Security: max-age=16070400; includeSubDomains X-APIG-Latency: 87 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: 86 X-Content-Type-Options: nosniff X-Download-Options: noopen X-Envoy-Upstream-Service-Time: 32 X-Frame-Options: SAMEORIGIN X-Request-Id: 11379ed26a172206cf67e6288b0d73db X-Xss-Protection: 1;mode=block { "conferenceId": "982311022", "corpId": "314765464", "subject": "网络研讨会", "description": "", "startTime": "2021-04-29 11:00", "duration": 120, "timeZoneId": 56, "state": "schedule", "scheduserId": "bb05917f7363407ea6b1df019fdf257a", "scheduserName": "user", "vmrPkgName": "网络研讨会_1000方观众", "callRestriction": false, "scope": 0, "audienceScope": 0, "chairJoinUri": "https://meeting.huaweicloud.com/#/j/982311022/f78c393cad974a812828342da591f11cab00da91a2c43c3d", "chairPasswd": "116817", "guestJoinUri": "https://meeting.huaweicloud.com/#/j/982311022/8e057f959576587f9778a65a16a28a89be7a50793d10014d", "guestPasswd": "352218", "audienceJoinUri": "https://meeting.huaweicloud.com/#/j/982311022/aab78ec3fffcf54313802455d58449efa9617824aac4d7e5", "audiencePasswd": "441168", "notifySetting": { "enableCalendar": "N", "enableSms": "N", "enableEmail": "N" }, "attendees": ["user"], "enableRecording": "Y" }
  • 请求消息示例 POST /v1/usg/sss/meeting-files/save-to-personal-space 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": "42b8e80be5044513ae20edd4ad705272" }
  • 响应消息示例 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: 270221481fc694f03628e85edf24a0b7
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: cnrCAod6XrUexF5jUWmyxlyEcRStV8AsLwVI' -d '{"uuid": "42b8e80be5044513ae20edd4ad705272"}' https://api.meeting.huaweicloud.com/v1/usg/sss/meeting-files/save-to-personal-space
  • 响应消息示例 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: 539e8b710378987ffc5eb844b5e5c290
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 Accept-Language 否 String Header 语言参数,默认为中文zh-CN,英文为en-US。 address 否 String Body 企业所在地,最大长度为255个字符。 autoUserCreate 否 Boolean Body 企业自动开户开关。
  • 请求消息示例 PUT /v1/usg/dcs/corp Connection: keep-alive X-Access-Token: stbdOWTjFFPAoDfJaWFGWnOTtepUlEsfhQSC Content-Type: application/json Content-Length: 27 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "address": "string" }
  • 请求参数 表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 ResourceDTO objects Body 待添加的资源列表,最多支持批量处理100个。
  • 请求消息示例 POST /v1/usg/dcs/sp/corp/818803911/resource Connection: keep-alive X-Access-Token: stbvmKo5lr6vT7QIzKHg4iqicUBcYMb3qlki Content-Type: application/json Content-Length: 31 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) [ { "count": 10, "expireDate": 2549030400000, "type": "VMR", "typeId": "ff808081699b56cb0169c411a0980152" } ]
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stbvmKo5lr6vT7QIzKHg4iqicUBcYMb3qlki' -d '[{"count": 10,"expireDate": 2549030400000,"id": "733ff391f2a14360af3b93bd1325f9f9","type": "VMR","typeId": "ff808081699b56cb0169c411a0980152"}]' https://api.meeting.huaweicloud.com/v1/usg/dcs/sp/corp/818803911/resource
  • 响应消息示例 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: 702639ba08cda213b2699300e7f166e8
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' -d '["asdasfscasd"]' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/device/status/0
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 value 是 Integer Path 状态。 0:启用 1:停用 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 终端序列号列表,当SN对应的终端状态一致的,则忽略该记录。 maxLength:100 minLength:1
  • 请求消息示例 PUT /v1/usg/dcs/corp/device/status/0 Connection: keep-alive X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Content-Type: application/json Content-Length: 47 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) ["asdasfscasd"]
  • 请求消息示例 GET /v1/usg/dcs/corp/vmr?searchKey=6767&offset=0&limit=10 Connection: keep-alive X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF 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: 308 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: fbbc91569f0efed914e0427fc2a9c4ac { "count" : 1, "data" : [ { "device" : { "id" : "22c1804004374b558084c50e44e77085", "mark" : "13456789" }, "id" : "ff8080816c52e2a6016c53878f030030", "member" : { "id" : "nhl", "mark" : "nhl(nhl)" }, "status" : 0, "vmrId" : "9*******7", "vmrName" : "云会议室", "vmrPkgName" : "小型云会议室-10方", "vmrPkgParties" : 10, "maxAudienceParties": 1000, "commercialMaxAudienceParties": 1000, "expireDate": 1666195200000 } ], "limit" : 10, "offset" : 0 }
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 offset 否 Integer Query 查询偏移量,若超过最大数量,则返回最后一页的数据。 默认值:0 limit 否 Integer Query 查询数量。 默认值:10 searchKey 否 String Query 搜索条件。支持云会议室名称、ID及分配的用户、硬终端名称模糊搜索。 status 否 Integer Query 云会议室状态。不填则查询所有。 0:正常 1:停用 2:未分配 vmrMode 否 Integer Query VMR模式。不填则默认为云会议室。 1:云会议室 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 响应参数 参数 类型 描述 count Integer 总数量。 limit Integer 每页显示的条目数量。 默认值:10 offset Integer 页面起始页,从0开始。 data Array of QueryOrgVmrResultDTO objects 查询到的云会议室列表。 表5 QueryOrgVmrResultDTO数据结构 参数 类型 描述 device IdMarkDTO object 云会议室绑定硬终端的华为云会议账号。 id String 云会议室的ID。 说明: 对应创建会议接口中的vmrID。 member IdMarkDTO object 云会议室绑定用户的华为云会议账号。 status Integer 云会议室状态。 0:正常 1:停用 2:未分配 vmrId String 云会议室的固定会议ID。 说明: 对应创建会议接口返回数据的vmrConferenceID。 vmrName String 云会议室名称。 vmrPkgName String 云会议室套餐名称。 vmrPkgParties Integer 云会议室套餐会议并发方数。 maxAudienceParties Integer 最大观众与会方数(仅网络研讨会有效)。 expireDate Long 到期时间的时间戳,单位毫秒。 commercialMaxAudienceParties Integer 按次资源转商后,商用规格最大观众与会方数(仅网络研讨会有效)。 表6 IdMarkDTO数据结构 参数 类型 描述 id String 唯一标识。 mark String 用于返回id对应的回显描述,一般为名称等。
  • 请求消息示例 GET /v1/usg/sss/publications?offset=0&limit=10&searchKey= Connection: keep-alive X-Access-Token: cnrfzn5OLRjwoaOf2F7PfMwVjJ6zScFogbDE Content-Type: application/json 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 PublicationResponseBase objects 发布响应信息。 表5 PublicationResponseBase 数据结构 参数 类型 描述 createTime Long 创建时间。 endTime Long 结束时间。 id String 发布ID。 lastUpdatedBy String 更新者。 publishName String 发布名称。 publishScope String 发布范围。 publishStatus String 根据当前时间确定发布状态。 NOT_ONLINE - 未上线 PUBLISHING - 发布中 ALREADY_OFFLINE - 已下线 startTime Long 开始时间。 updateTime Long 更新时间
  • 响应消息示例 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: 21facce44sd8efa02329afd189da7f3d { "count": 1, "data": [ { "createTime": 1593538236711, "endTime": 253402271999000, "id": "2baafa7ffef04c62a3c3f79f9f8a1a3a", "lastUpdatedBy": "", "publishName": "cCu78RV8Ai", "publishScope": "", "publishStatus": "PUBLISHING", "startTime": 0, "updateTime": 1593538236711 } ], "limit": 10, "offset": 0 }
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 offset 否 Integer Query 查询偏移量,若超过最大数量,则返回最后一页。 默认值:0 limit 否 Integer Query 查询数量。 默认值:10 searchKey 否 String Query 搜索条件,支持名称模糊搜索。 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 Accept-Language 否 String Header 语言参数,默认为中文zh-CN,英文为en-US。
  • 请求示例 PUT https://{endpoint}/v1/mmc/control/conferences/interpreterGroup?conferenceID=984178192 { "interpreterGroups": [{ "groupID": "f89d1070afdc41ff1c6496e3f58ccee0", "firstLanguage": "zh", "secondLanguage": "en", "interpreters": [{ "loginAccount": "p-80852a66fca94c69aa3d344ec9452171" }] }] }
  • 响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 472 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: 2f3aa1fe64f6784b1eb6f75a67ef2b9d Server: api-gateway X-Request-Id: ba03d2ae3b805d8c545c83494c862b48 { "data": [ { "operateTime": 1574119913464, "operateSource": "MCU", "operator": "MCU", "operateCode": "启动声控", "operateResult": "成功" }, { "operateTime": 1574119917864, "operateSource": "Conference System", "operator": "Conference System", "operateCode": "呼叫与会方", "operationObject": "9bd1c8b20a5b11eab31381603f51d3ae", "operateResult": "成功" }, { "operateTime": 1574119917870, "operateSource": "MCU", "operator": "MCU", "operateCode": "关闭与会方麦克风", "operationObject": "9bd1c8b20a5b11eab31381603f51d3ae", "operateResult": "成功" }, { "operateTime": 1574119918064, "operateSource": "MCU", "operator": "MCU", "operateCode": "打开与会方麦克风", "operationObject": "9bd1c8b20a5b11eab31381603f51d3ae", "operateResult": "成功" }, { "operateTime": 1574119917889, "operateSource": "Conference System", "operator": "Conference System", "operateCode": "设置主持人", "operationObject": "9bd1c8b20a5b11eab31381603f51d3ae", "operateResult": "成功" }, { "operateTime": 1574119932913, "operateSource": "Portal", "operator": "Conference Operator", "operateCode": "添加与会方", "operationObject": "**********905", "operateResult": "成功" }, { "operateTime": 1574119935460, "operateSource": "Conference System", "operator": "Conference System", "operateCode": "呼叫与会方", "operationObject": "a5db36ce0a5b11eab313a52e57f34bda", "operateResult": "成功" }, { "operateTime": 1574119935465, "operateSource": "MCU", "operator": "MCU", "operateCode": "关闭与会方麦克风", "operationObject": "a5db36ce0a5b11eab313a52e57f34bda", "operateResult": "成功" }, { "operateTime": 1574119944636, "operateSource": "Portal", "operator": "Conference Operator", "operateCode": "点名与会方", "operationObject": "a5db36ce0a5b11eab313a52e57f34bda", "operateResult": "成功" }, { "operateTime": 1574119944857, "operateSource": "MCU", "operator": "MCU", "operateCode": "停止声控", "operateResult": "成功" }, { "operateTime": 1574119945099, "operateSource": "MCU", "operator": "MCU", "operateCode": "打开与会方麦克风", "operationObject": "a5db36ce0a5b11eab313a52e57f34bda", "operateResult": "成功" }, { "operateTime": 1574119945861, "operateSource": "Portal", "operator": "Conference Operator", "operateCode": "广播与会方", "operationObject": "a5db36ce0a5b11eab313a52e57f34bda", "operateResult": "成功" }, { "operateTime": 1574119947619, "operateSource": "Portal", "operator": "Conference Operator", "operateCode": "挂断与会方", "operationObject": "a5db36ce0a5b11eab313a52e57f34bda", "operateResult": "成功" }, { "operateTime": 1574119947859, "operateSource": "MCU", "operator": "MCU", "operateCode": "取消广播与会方", "operateResult": "成功" }, { "operateTime": 1574119948460, "operateSource": "Portal", "operator": "Conference Operator", "operateCode": "删除与会方", "operationObject": "**********905", "operateResult": "成功" }, { "operateTime": 1574119949328, "operateSource": "Portal", "operator": "Conference Operator", "operateCode": "释放主持人", "operationObject": "9bd1c8b20a5b11eab31381603f51d3ae", "operateResult": "成功" }, { "operateTime": 1574119950672, "operateSource": "Portal", "operator": "Conference Operator", "operateCode": "关闭与会方麦克风", "operationObject": "9bd1c8b20a5b11eab31381603f51d3ae", "operateResult": "成功" }, { "operateTime": 1574119951805, "operateSource": "Portal", "operator": "Conference Operator", "operateCode": "取消全场静音", "operateResult": "成功" }, { "operateTime": 1574119952067, "operateSource": "MCU", "operator": "MCU", "operateCode": "打开与会方麦克风", "operationObject": "9bd1c8b20a5b11eab31381603f51d3ae", "operateResult": "成功" }, { "operateTime": 1574119952954, "operateSource": "Portal", "operator": "Conference Operator", "operateCode": "申请发言", "operationObject": "9bd1c8b20a5b11eab31381603f51d3ae", "operateResult": "成功" } ], "offset": 0, "limit": 20, "count": 23 }
  • 响应参数 表4 响应参数 参数 类型 描述 offset Integer 查询偏移量。 limit Integer 每页的记录数。 count Integer 总记录数。 data Array of data objects 会控操作列表。 表5 data数据结构说明 参数 类型 描述 operateTime long 操作时间(UTC时间,单位毫秒)。 operateSource String 操作来源。 operator String 操作者。 operateCode String 操作描述。 operationObject String 被操作对象。 operateResult String 操作结果。 detail String 详情。
共100000条