华为云用户手册

  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 X-Conference-Authorization 是 String Header 会控Token,通过获取会控token接口获得。 switchMode 是 String Body 会议显示策略。 Fixed: 固定广播与会者 VAS:声控切换 imageType 是 Integer Body 画面类型。单画面设置只针对声控模式。 0:单画面 1:多画面
  • 请求消息示例 PUT /v1/mmc/control/conferences/display/mode?conferenceID=914083136 Connection: keep-alive X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb Content-Type: application/json Content-Length: 52 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "switchMode":"Fixed", "imageType":1 }
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' -d '{"switchMode":"Fixed","imageType":"1"}' 'https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/display/mode?conferenceID=914083136'
  • 请求消息示例 PUT /v1/usg/dcs/sp/corp/818803911 Connection: keep-alive Content-Type: application/json X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Content-Length: 173 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "adminInfo": { "country": "chinaPR", "email": "******", "name": "zhangsan@corp", "phone": "+86191****9092" }, "basicInfo": { "country": "chinaPR", "description": "description", "email": "******", "fax": "+123456789", "name": "华为技术有限公司", "phone": "+86191****9092" }, "groupId": "297e87ec7713734b01771458c2d80000", }
  • 响应消息示例 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: 26701eb8f982b175b70776316d46e345
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' -d '{"adminInfo": {"country": "chinaPR","email": "******","name": "zhangsan@corp","phone": "+86191****9092"},"basicInfo": {"country": "chinaPR","description": "description","email": "******","fax": "+123456789","name": "华为技术有限公司","phone": "+86191****9092"}"groupId": "297e87ec7713734b01771458c2d80000"}' https://api.meeting.huaweicloud.com/v1/usg/dcs/sp/corp/818803911
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 offset 否 Integer Query 查询偏移量,若超过最大数量,则返回最后一页。 默认值:0 limit 否 Integer Query 查询数量。 默认值:10 searchKey 否 String Query 搜索条件,支持激活码、终端名称模糊搜索。 devType 否 String Query 终端类型。 idea-hub:智能协作大屏 huawei-vision:智慧屏TV welink-desktop(iwb):SmartRooms会议版 smart-rooms:SmartRooms完整版 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: 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: 639e8b710378987ffc5eb844b5e5c291 { "count": 1, "data": [ { "activeCode": "324****97", "deptCode": "1", "deptName": "测试部门", "devName": "test_device", "devType": "idea-hub", "expireDate": 1611250137942, "id": "6d35397d67504dd1b7e1766a25f1be12" } ], "limit": 10, "offset": 0 }
  • 请求消息示例 GET /v1/usg/dcs/corp/vision/activecode Connection: keep-alive X-Access-Token: stbWbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOD 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 QueryVisionActiveCodeResultDTO objects 激活码信息。 表5 QueryVisionActiveCodeResultDTO 数据结构 参数 类型 描述 activeCode String 激活码。 deptCode String 部门编码。 deptName String 部门名称。 devName String 终端名称。 devType String 终端类型。 expireDate Long 失效时间戳。 id String 激活码唯一标识。
  • 请求消息示例 GET /v1/usg/dcs/sp/corp?offset=0&limit=5&searchKey=818803911 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: 1329 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: 63facce44898efa03629afd189da7f0f { "count": 1, "data": { "adminInfo": { "account": "zhangsan@corp", "adminType": 0, "country": "chinaPR", "email": "******", "id": "58eed901985149899b966242e0a7d644", "name": "zhangsan", "phone": "+86191****9092" }, "basicInfo": { "address": "浙江杭州", "country": "chinaPR", "description": "description", "email": "******", "fax": "+123456789", "name": "华为技术有限公司", "phone": "+86191****9092", "spId": "8a8d1384700be6870170117caca923af" }, "id": 818803911, "resInfo": { "corpVcRes": { "confCallCount": 100, "hwVisionCount": 0, "ideaHubCount": 0, "liveCount": 0, "recordCapability": 0, "roomCount": 0, "te1080pHardCount": 100, "te720pHardCount": 100, "teSoftCount": 100, "thirdPartyHardCount": 100, "vmrPkgList": [ { "vmrName": "大型云会议室-50方", "vmrPkgCount": 10, "vmrPkgId": "ff808081699b56cb0169c411a0980152", "vmrPkgParties": 50, "vmrPkgUsedCount": 0 } ] } } }, "limit": 5, "offset": 0 }
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 offset 否 Integer Query 查询偏移量,若超过最大数量,则返回最后一页。 默认值:0 limit 否 Integer Query 查询数量。 默认值:10 searchKey 否 Integer Query 搜索条件,支持名称、手机、邮箱、帐号模糊搜索。 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 Accept-Language 否 String Header 语言参数,默认为中文zh-CN,英文为en-US。
  • 请求消息示例 POST /v1/usg/sss/materials/batch-delete Connection: keep-alive X-Access-Token: cnrfzn5OLRjwoaOf2F7PfMwVjJ6zScFogbDE Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) [ "aa325ddb930f4fbe91c3d5a2e345bbb4", "b232a0ffa40443a1a8ff15808ab69bas" ]
  • CURL命令示例 curl -k -i -X POST -H 'X-Access-Token: cnrfzn5OLRjwoaOf2F7PfMwVjJ6zScFogbDE' -d '0["aa325ddb930f4fbe91c3d5a2e345bbb4","b232a0ffa40443a1a8ff15808ab69bas"]' https://api.meeting.huaweicloud.com/v1/usg/sss/materials/batch-delete
  • 请求参数 表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 素材ID列表。
  • 请求消息示例 GET /v1/metrics/conference/threshold?thresholdType=AUDIO 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)
  • 响应参数 表4 响应参数 参数 类型 描述 latency ThresholdData object 延迟阈值信息,单位为毫秒(ms) thresholdType = CPU时无效 jitter ThresholdData object 抖动阈值信息,单位为毫秒(ms) thresholdType = CPU时无效 packetLoss PacketThresholdData object 丢包率阈值信息,单位为百分比(%) thresholdType = CPU时无效 clientCpuMax CPUThresholdData object 会议最大CPU阈值信息,单位为百分比(%) 仅当thresholdType = CPU时有效 systemCpuMax CPUThresholdData object 系统最大CPU阈值信息,单位为百分比(%) 仅当thresholdType = CPU时有效 表5 ThresholdData 数据结构 参数名称 参数类型 描述 receiving Integer 自定义接收方向阈值,单位为毫秒(ms)。 receivingDefault Integer 默认接收方向阈值,单位为毫秒(ms)。 sending Integer 自定义发送方向阈值,单位为毫秒(ms)。 sendingDefault Integer 默认发送方向阈值,单位为毫秒(ms)。 表6 PacketThresholdData 数据结构 参数名称 参数类型 描述 receiving Integer 自定义接收方向阈值,单位为百分比(%)。 receivingDefault Integer 默认接收方向阈值,单位为百分比(%)。 sending Integer 自定义发送方向阈值,单位为百分比(%)。 sendingDefault Integer 默认发送方向阈值,单位为百分比(%)。 表7 CPUThresholdData 数据结构 参数名称 参数类型 描述 cpu Integer 自定义CPU阈值,单位为百分比(%)。 cpuDefault Integer 默认CPU阈值,单位为百分比(%)。
  • 响应消息示例 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 { "latency": { "receiving": 500, "receivingDefault": 800, "sending": 500, "sendingDefault": 800 }, "jitter": { "receiving": 500, "receivingDefault": 800, "sending": 500, "sendingDefault": 800 }, "packetLoss": { "receiving": 20, "receivingDefault": 50, "sending": 20, "sendingDefault": 50 } }
  • 响应参数 表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" } ]
  • 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或者第三方账号
  • 请求消息示例 DELETE /v1/usg/dcs/corp/dept/s4f Connection: keep-alive X-Access-Token: stbvmKo5lr6vT7QIzKHg4iqicUBcYMb3qlki Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 deptCode 是 String Path 部门编码。 说明: 部门编码为1的根部门不能删除。 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 Accept-Language 否 String Header 语言参数,默认为中文zh-CN,英文为en-US。
  • 请求消息示例 DELETE https://{endpoint}/v1/usg/dcs/sp/corp/818803911 Connection: keep-alive X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
  • 请求参数 表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 -X GET -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' https://api.meeting.huaweicloud.com/v1/usg/dcs/sp/corp/746781680/resource-record?searchKey=&startExpireDate=1573488000000&endExpireDate=1620835199999&startOperateDate=1573488000000&endOperateDate=1589299199999&type=&typeId=&orderId=&operateType=&offset=0&limit=10
  • 请求消息示例 GET /v1/usg/dcs/sp/corp/746781680/resource-record?searchKey=&startExpireDate=1573488000000&endExpireDate=1620835199999&startOperateDate=1573488000000&endOperateDate=1589299199999&type=&typeId=&orderId=&operateType=&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)
共100000条