华为云用户手册

  • 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/participants/hands?conferenceID=914083136&participantID=d2c3ae64216e11eabc510dc9b62e3a80
  • 响应消息示例 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: efa7d0090ee1d5dbcb54aa9f3cfafa96 Server: api-gateway X-Request-Id: f78b007ec2dabf1498620131c7bc19e0
  • 请求消息示例 PUT /v1/mmc/control/conferences/participants/hands?conferenceID=914083136&participantID=d2c3ae64216e11eabc510dc9b62e3a80 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) { "handsState":1 }
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 participantID 是 String Query 与会者标识。 X-Conference-Authorization 是 String Header 会控Token,通过获取会控token接口获得。 handsState 是 Integer Body 0:放下手 1:举手
  • 请求消息示例 PUT /v1/mmc/control/conferences/stop?conferenceID=914044873 Connection: keep-alive X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb Content-Type: application/json Content-Length: 24 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: 46df973984b4ce317502460cd4860600 Server: api-gateway X-Request-Id: 0c4d9e9ce2dc2dca8cac816cad7c42d6
  • 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/stop?conferenceID=914044873'
  • 响应消息示例 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
  • 请求参数 表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 激活码的唯一标识列表。
  • 请求消息示例 DELETE /v1/usg/dcs/corp/vision/activecode 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) ["6d35397d67504dd1b7e1766a25f1be12"]
  • 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
  • 请求消息示例 GET​ /v1/metrics/conferences/online?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", "subject": "研发晨会", "scheduserName": "深圳分部秘书", "deptName": "XXXXX", "alarm": "YES", "audioAlarm": "NO", "videoAlarm": "YES", "screenAlarm": "NO", "cpuAlarm": "NO", "timeZoneID": "56", "startTime": 1618220740926, "endTime": 1618222194202, "duration": 32, "participants": 52, "webinar": false }] }
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 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。
  • 请求示例 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: 是辅流
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 Accept-Language 否 String Header 语言参数,默认为中文zh-CN,英文为en-US。 contact 是 String Body 后台自动识别是手机还是邮箱,若为手机号,则要求和国家码匹配。 说明: 当前中国站点企业支持使用邮箱或手机号进行邀请,手机仅支持+86开头的手机号。 当前国际站点企业仅支持使用邮箱进行邀请。 country 否 String Body 手机号所属的国家。 默认值:chinaPR。 maxLength:255 minLength:0 deptCode 否 String Body 部门编码,若不携带则默认根部门。 desc 否 String Body 备注。 maxLength:128 minLength:0 name 是 String Body 企业用户名称。 sortLevel 否 Integer Body 通讯录排序等级,序号越低优先级越高。 title 否 String Body 职位。
  • 响应消息示例 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 Expires: Thu, 01 Jan 1970 00:00:00 GMT Server: api-gateway X-Request-Id: ebbb9b1e50d1ec63b78d8484d170173f { "userExist": false }
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9' -d '{"contact": "+8617379679094","country": "chinaPR","name": "张三"}' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/member
  • 请求消息示例 POST /v1/usg/dcs/corp/member/add Connection: keep-alive Content-Type: application/json X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9 Content-Length: 173 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "contact": "+8617379679094", "country": "chinaPR", "name": "张三" }
  • 描述 通过手机号码或者邮箱地址邀请用户加入企业。 若被邀请用户在华为云会议系统中不存在,则: 华为云会议免费版和华为云会议标准版发送短信/邮件邀请用户完成注册后加入企业。用户注册成功后,加入该企业。 华为云会议旗舰版在企业内直接添加该用户。用户会收到华为云会议的初始密码,用户第一次以手机号或者邮箱登录时,需要修改密码。 若被邀请用户在华为云会议系统中存在,则该用户会收到短信或者邮件确认。确认完成后改用户加入企业内。该用户的密码保持原来的密码不变。
  • 请求消息示例 PUT /v1/usg/dcs/member Connection: keep-alive X-Access-Token: stbLRonxHFt7jfbMHSY2UufNZewbPwb8TP8y Content-Type: application/json Content-Length: 25 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "name": "user8001" }
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 Accept-Language 否 String Header 语言参数,默认为中文zh-CN,英文为en-US。 desc 否 String Body 备注。 maxLength:128 minLength:0 englishName 否 String Body 英文名称。 maxLength:64 minLength:0 name 是 String Body 名称。 maxLength:64 minLength:1 signature 否 String Body 签名。 maxLength:512 minLength:0 title 否 String Body 职位。 maxLength:32 minLength:0
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token: stbLRonxHFt7jfbMHSY2UufNZewbPwb8TP8y' -d '{"name": "user8001"}' https://api.meeting.huaweicloud.com/v1/usg/dcs/member
  • 响应消息示例 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: f2a77ad15ad968bd72bdcd00fa1acef3
  • 请求消息示例 GET /v1/wss/webinar/open/room-setting/984555800 HTTP/1.1 Host: 251ba26eef46472d97fa4462d514b044.APIG.cn-north-7.huaweicloudapis.com User-Agent: APIGatewayDebugClient/1.0 X-Access-Token: cnr1519y4i5r5ikKZYTGqR5b2ybEJORGdm3EcPzU X-APIG-Mode: debug
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 Accept-Language 否 String Header 语言参数,默认为中文zh-CN,英文为en-US。 conference_id 是 String Path 网络研讨会ID。
  • 响应消息示例 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: Mon, 17 May 2021 08:43:11 GMT Pragma: no-cache Server: api-gateway Strict-Transport-Security: max-age=16070400; includeSubDomains X-APIG-Latency: 85 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: 84 X-Content-Type-Options: nosniff X-Download-Options: noopen X-Envoy-Upstream-Service-Time: 59 X-Frame-Options: SAMEORIGIN X-Request-Id: 48e47dc2e65e3bf85e00a60e2cba5ce7 X-Xss-Protection: 1;mode=block {"roomIntroduce":"直播间简介","cropLogoId":"76D356E93FA849C7987983EEAB94F4BE","coverPictureId":"D8879E453B8F4277B95864A147B2F3C5","showAudienceMode":"real_time","isRedoubleOpen":"N","baseAudienceCount":0,"multiple":1.0}
  • 响应参数 表4 响应参数 参数 类型 描述 roomIntroduce String 网络研讨会介绍。 cropLogoId String 企业Logo的文件id。 coverPictureId String 欢迎界面的文件id。 showAudienceMode String 显示观众人数的模式。默认为real_time。 none: 不显示 real_time: 实时显示 isRedoubleOpen String 智能倍增开关。默认值为Y。 Y:开启智能倍增 N:关闭智能倍增 baseAudienceCount Integer 基础设置人数(网络研讨会没人时显示的人数)。默认值为0。 取值范围为[0, 10000]。 multiple Double 设置倍数(基础人数+真实人数*倍数)。默认值为1.0。 取值范围为[0, 10],取1位小数。
  • 响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 481 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: 3df9b4a1b0f8e77050d27a858add946c { "offset": 0, "limit": 10, "count": 1, "data": [ { "name": "test", "type": "TE", "model": "TE20", "sn": "asdasfscasd", "account": "df8bce2178294683bb83a4985fef7165", "number": "+991118029589", "prjCodeMode": 0, "deptCode": "1", "deptName": "wangyue", "deptNamePath": "wangyue", "phone": "+86***********", "country": "chinaPR", "email": "******", "description": "test", "status": 0 } ] }
共100000条