华为云用户手册

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 160 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 { "id": "f521bebcbb27422cb3241c4cb19942c5", "userAccount": "3e48b79b660e403cb5e0208f7be83961", "name": "name", "englishName": "englishName", "phone": "+86173****9807", "country": "chinaPR", "email": "******", "sipNum": "+8657198480", "deptCode": "1", "deptName": "根部门", "deptNamePath": "根部门", "userType": 2, "adminType": 2, "signature": "signature-info", "title": "manager", "desc": "desc", "corp": null, "function": { "enableRoom": true }, "devType": { "model": null, "deviceSize": null, "purchaseChannel": null }, "status": 0, "sortLevel": 10000, "hidePhone": false, "visionAccount": null, "thirdAccount": "thirdAccount", "license": 0, "activeTime": 1601221696783, "vmrList": [ { "id": "2c908bc76f61a5f2016f61bbfdf5039b", "vmrId": "912992631", "vmrName": "name的云会议室", "vmrPkgId": null, "vmrPkgName": null, "vmrPkgParties": null, "vmrPkgLength": null, "status": "0" } ] }

响应参数 表5 响应参数 参数 类型 描述 activeTime Long 激活时间，utc时间戳。 adminType Integer 管理员类型。 0：默认（超级）管理员 1：普通管理员 2：非管理员（即为普通企业成员，UserType是2时有效） corp CorpBasicInfoDTO object 企业注册信息。仅用户查询自己的信息才返回该数据。 country String 联系电话所属的国家。 deptCode String 部门编码。 deptName String 部门名称。 deptNamePath String 部门完整名称。 desc String 备注。 devType QueryDeviceInfoResultDTO object 绑定设备类型信息。 email String 邮箱。 englishName String 英文名称。 function UserFunctionDTO object 用户功能位。 hidePhone Boolean 是否隐藏手机号码。 id String 用户UUID。 license Integer 许可证。 0：商用； 1：免费试用。 name String 名称。 phone String 联系电话。 signature String 签名。 sipNum String SIP号码。 sortLevel Integer 通讯录排序等级，序号越低优先级越高。 status Integer 用户状态。 0：正常； 1：停用。 thirdAccount String 第三方User ID。 title String 职位。 userAccount String 华为云会议账号。 userType Integer 用户类型。 2：普通用户 12：智慧屏用户 13：IdeaHub用户 14：SmartRooms用户 visionAccount String 智慧屏唯一账号 vmrList Array of UserVmrDTO objects 云会议室列表。 表6 QueryDeviceInfoResultDTO 数据结构 参数 类型 描述 deviceSize String 设备终端产品尺寸。 model String 终端型号。 purchaseChannel String 终端设备购买渠道。

请求参数 表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 响应参数 参数 类型 描述 confCallCount ResDetailDTO object 会议并发方数。 confLength Integer 会议时长。 enableAiMinutes Boolean 是否开启Ai会议纪要。 enableHybridCloud Boolean 企业是否开启混合云模式。 enablePstn Boolean 在创建企业的时候设置的pstn权限开关。 enableSMS Boolean 企业是否通过短信形式发送会议通知。 enableCloudDisk Boolean 是否开启云盘。 enableUc Boolean 是否开启UC功能。 hwVisionCount ResDetailDTO object 智慧屏终端接入账号数量。 ideaHubCount ResDetailDTO object IdeaHub终端接入账号数量。 liveCount ResDetailDTO object 直播端口数量。 recordCapability ResDetailDTO object 录播存储空间 （单位：G）。 roomCount ResDetailDTO object 电子白板（SmartRooms）接入账号数量。 singleConfCallCount Integer 单会议并发呼叫数。 te1080pHardCount ResDetailDTO object 1080P硬终端接入账号数量。 te720pHardCount ResDetailDTO object 720P硬终端接入账号数量。 teSoftCount ResDetailDTO object 软终端账户数量。 thirdPartyHardCount ResDetailDTO object 第三方硬终端接入账号数量。 vmr Array of QueryVmrPkgResResultDTO objects 查询云会议室套餐包分配数量结果。 表5 ResDetailDTO数据结构 参数 类型 描述 expiredCount Integer 到期数量。 expiringCount Integer 即将到期数量，到期时间在30天内。 sumCount Integer 总数。 trialCount Integer 赠送数量 usedCount Integer 已使用数（录播存储空间、会议并发、推流并发方数暂无法查询）。 表6 QueryVmrPkgResResultDTO 数据结构 参数 类型 描述 vmrName String 云会议室套餐包名称。 vmrPkgCount Integer 该云会议室套餐分配的总数。 vmrPkgId String 云会议室套餐包id。 vmrPkgParties Integer 云会议室套餐方数。 vmrPkgUsedCount Integer 该套餐对应的云会议室已分配数量。

响应消息示例 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 { "te1080pHardCount": { "expiredCount": 0, "expiringCount": 0, "trialCount": 0, "sumCount": 2, "usedCount": 1 }, "te720pHardCount": { "expiredCount": 0, "expiringCount": 0, "trialCount": 0, "sumCount": 5, "usedCount": 0 }, "teSoftCount": { "expiredCount": 0, "expiringCount": 0, "trialCount": 0, "sumCount": 30, "usedCount": 21 }, "roomCount": { "expiredCount": 0, "expiringCount": 0, "trialCount": 0, "sumCount": 0, "usedCount": 0 }, "recordCapability": { "expiredCount": 0, "expiringCount": 0, "trialCount": 0, "sumCount": 8, "usedCount": 0 }, "confCallCount": { "expiredCount": 0, "expiringCount": 0, "trialCount": 0, "sumCount": 6, "usedCount": 0 }, "liveCount": { "expiredCount": 0, "expiringCount": 0, "trialCount": 0, "sumCount": 1, "usedCount": 0 }, "thirdPartyHardCount": { "expiredCount": 0, "expiringCount": 0, "trialCount": 0, "sumCount": 0, "usedCount": 0 }, "vmr": [ { "vmrPkgId": "ff808081680d5b8601682b3436070030", "vmrName": "运营VMR专用_25", "vmrPkgParties": 25, "vmrPkgCount": 1, "vmrPkgUsedCount": 1 } ], "enablePstn": false, "enableSMS": true }

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

请求消息示例 POST /v1/usg/acs/auth/slideverifycode/send Connection: keep-alive Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "user": "+86136********", "checkType": 1, "clientType": 0 }

响应消息示例 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 http_proxy_id: c94f64967745b0670c299c0688479078 { "shadowImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAASwAAABuCAYAAACdmi6mAACAAElEQVR42py953cV19rtuUsi44QDNjY4YAMGSQQFJCFEkhBJoCwhlHMOKKGEUBZIIJFzxgQnjG3ACTDOPvY5571vuqNvjzu6e4zu/2P2nGvVljY+Pm/f0R/mWLWrdqhdUv32fJ71rLU8/kt3wbMwGc6iVHje/TOl/ZPHbBdnUDvhWcL3WJIFJ8CrbCrnH+TxVRD3BeY+uU8KzDKaeC8+NsoeP2aOB7qvX5oHz7J8eJZTwYXwhJTAE1YGz8pyeMKlCm6XwfE+jqyEZ1UVPKtr4FnTCM/aJkrtbjhrG9g22HYd921ogWc9t9fUUbXwRPM10WzX7KYabBvFx6uq4UTyPSP4WRFl5vPsZ1MrK+CEV5r2SVVa6VhENd+jnufUYM+JcqK5vYrvH1Fjnx9abr/bimJ+X37PoDzz/Z9QEK/H8gJehy0TMEVgHCddAWr5EpHBK5ygmqNC7TrXKHkGLTGFYp17lBu9IZqixRqQkpMMP/wwVsk0JrLoLMIhGFrEAy2KujtNTAIIQh31CHSWY9oJt7FgESPcCR7RgEpCwQ0FARDKrlXqCRgAqxw6oXJtJLbMBSYKRqx1Yzhn8d8qwQcs1S5p3IrjkAl5udvMirAS05KvyGZ5bgGtlPu6jkTmtpr1J4WvbTUzuy/fiZ5Ii8ymSyk8Z35sj/xv/L8sHCK6iGp3GAAAAAElFTkSuQmCC", "cutImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADEAAAAxCAYAAABznEEcAAAZA0lEQVR42s15Z1dU27ZtX6tyoIoqcgZFERBEFBUwISKZIuecQUBFMICCkjOYUEzbcE67Z+99zr3t3j9zf854fa5i7/3a/fBae+/T+9DbmGuu1PsYfcy1VhWyix8h9dZjnCBiCD9hL3oE7eYscH0W2g1CxWszQOE0tMIHwNVpjhnz70PPn4J+ZYLjSeAa50ufI6x6Gc7qFaBqGVrjJkzte/B2vkJmxz5SW7fhatuHxm197BO0yV+A4SNovW85dwC07kBr3uR5G0DDGrTaVSCwzGu9gFb6DNrtp0DxE8YngALHuFUyi5LSRyg9g1/hDbKY3mOphqezW+d/g7bg28wjR4Z4pUIrY0imjfgbFhFUv0yChpXcal2CYlVtNXu0yPML/xE//I/0Lj6OzuRtNED9L7RAz3HpNUf8S08pmUdWsOqAb1xzZjTmvicuHfvA4Zmf0ETRVTd+4hyklXkT5N4EkmeZZbPkmAmiaUTUayAl9GpHmIkbzWaNygChgBlozeGjYxIEYqcpv4wJKytW/BRiEfZR4lgP+i0k94RzK7GedW0Kuv6H5lXAts2ucRSSDPJN3G5baYg47xt/C/LhN3sJcF5bwAAAABJRU5ErkJggg==", "pointY": 55, "token": "x7QLcizPl2eAaNdKChs2XnbrbEMHuF1dy", "expire": 60 }

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 Content-Type 是 String Header Body的媒体格式 样例:application/json; charset=UTF-8 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN, 英文为en-US。 checkType 否 Integer Body 校验类型。默认值：0。 0：登录 1：忘记密码 clientType 是 Integer Body 登录的客户端类型。 0：Web客户端类型 5：PC客户端 6：移动客户端 user 是 String Body 用户身份信息（手机号码或邮箱账号或用户真实账号）。

响应消息示例 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 { "offset": 0, "limit": 10, "count": 1, "data": [ { "id": "1747cfe902c34631999975417bf6bc1a", "type": "VMR", "typeId": 2001000, "typeDesc": "网络研讨会_1000观众", "vmrMode": 2, "count": 10, "expireDate": 1640966400000, "orderId": "95152407f7f147149e7f3e8e5e4a84bc", "status": 0, "editable": true } ] }

CURL命令示例 curl -k -i -X GET -H 'X-Access-Token: stbdOWTjFFPAoDfJaWFGWnOTtepUlEsfhQSC' /v1/usg/dcs/corp/resource-list?searchKey=&startExpireDate=&endExpireDate=&type=VMR&typeId=&orderId=&status=&vmrMode=2&offset=0&limit=10

请求消息示例 GET /v1/usg/dcs/corp/resource-list?searchKey=&startExpireDate=&endExpireDate=&type=VMR&typeId=&orderId=&status=&vmrMode=2&offset=0&limit=10 Connection: keep-alive X-Access-Token: stbdOWTjFFPAoDfJaWFGWnOTtepUlEsfhQSC Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。 offset 否 Integer Query 查询偏移量，若超过最大数量，则返回最后一页。 默认值：0 limit 否 Integer Query 查询数量。 默认值：10 searchKey 否 String Query 搜索条件，支持resourceId模糊查询。 startExpireDate 否 Integer Query 查询过期时间在该时间戳之后的资源项。 endExpireDate 否 Integer Query 查询过期时间在该时间戳之前的资源项。 type 否 String Query 资源类型。 VMR：云会议室 CONF_CALL：会议并发数 HARD_1080P：1080P硬终端 HARD_720P：720P硬终端 SOFT：软终端用户数 ROOM：大屏软终端 LIVE：直播推流 RECORD：录播空间 HARD_THIRD_PARTY ：第三方硬终端账号 HUAWEI_VISION：智慧屏 说明： 查询网络研讨会资源时type字段为VMR。 vmrMode 否 Integer Query VMR模式，type为VMR时传递该参数。 0：个人会议ID 1：云会议室 2：网络研讨会 typeId 否 String Query 资源类型Id，若想搜索5方VMR时，需携带5方vmrpkg对应的id。 orderId 否 String Query 订单Id。 status 否 Integer Query 订单状态。 0：正常 1：到期 2：停用

请求消息示例 GET /v1/mmc/control/conferences/realTimeInfo?conferenceID=914083136 Connection: keep-alive X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_131)

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 521 Connection: keep-alive Server: api-gateway http_proxy_id: b32bf70a8ac93ea13691fc34730fd78c { "attendees": [ { "accountID": "user01", "name": "user01", "phone": "+99111****815" } ], "participants": [ { "pid": "a6b4e988216c11eabc516bc3a3d8d6c4", "name": "user01", "phone": "+99111****815", "state": 0, "video": 1, "mute": 1, "hand": 0 } ], "confInfo": {} }

CURL命令示例 curl -k -i -X GET -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/realTimeInfo?conferenceID=914083136

响应参数 表4 响应参数 参数 类型 描述 attendees Array of attendee objects 被邀请与会者信息，包括预约会议时邀请的与会者和会中主持人邀请的与会者，已经加入会议的和未加入会议的都返回。 participants Array of participant objects 在线与会者列表信息，包括已加入会议、被邀请正在呼叫中、正在加入会议的与会者列表等。 说明： 同一个账号用不同类型终端（手机端或者PC端等）加入会议时，是不同的在线与会者 未加入或者已离会与会者，不在在线与会者列表中 confInfo confInfo object 在线会议信息。 表5 attendee数据结构说明 参数 类型 描述 accountID String 与会者的华为云会议账号。 userUUID String 与会者的用户UUID。 name String 与会者名称。 phone String 与会者号码。 phoneLeft String 设备为三屏智真时的左屏号码。 说明： 该参数将废弃，请勿使用。 phoneRight String 设备为三屏智真时的右屏号码。 说明： 该参数将废弃，请勿使用。 表6 participant数据结构说明 参数 类型 描述 pid String 与会者标识。 name String 与会者名称。 phone String 与会者号码。 state Integer 用户状态。 0：会议中 1：正在呼叫 2：正在加入会议 说明： 若会场未入会或已离会，则不会显示于在线会场列表。 video Integer 音视频能力。 0：音频 1：视频 mute Integer 麦克风状态。 0：麦克风打开 1：麦克风关闭 hand Integer 与会者举手状态。 0：未举手 1：举手 表7 confInfo数据结构说明 参数 类型 描述 chairID String 主持人与会者标识。

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 683 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: 25b89efb63970d80e715503650157098 Server: api-gateway X-Request-Id: a9af536f02e45c516513a8248bfe04c3 { "offset": 0, "limit": 20, "count": 1, "data": [ { "confUUID": "51adf610220411eaaae03f22d33cc26b", "confID": "912049654", "url": [ "https://114.116.237.2/rse/rse/html/play/Mediaxplay.html?rseid=00030&recordId=000301fa-0512-412f-b363-cb9f76063628&token=24e4f6d9850a42365783c88ceb36701bb87f5393a595af82&confID=51adf610220411eaaae03f22d33cc26b&isSecure=true" ], "rcdTime": 71, "rcdSize": 0, "subject": "user8002的会议", "scheduserName": "user8002", "startTime": "2019-12-19 02:07", "isDecodeFinish": false, "decodeEndTime": 1576721412885, "available": true, "recordAuthType":2 } ] }

请求消息示例 GET /v1/mmc/management/record/files?startDate=1574092800000&endDate=1576771199999 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 响应参数 参数 类型 描述 offset Integer 查询偏移量。 limit Integer 每页的记录数。 count Integer 总记录数。 data Array of RecordFileInfo objects 录播文件列表。 表5 RecordFileInfo 数据结构 参数 类型 描述 confUUID String 会议UUID。 confID String 会议ID。 url String[] 录播观看地址。 rcdTime Integer 录制时长（单位秒）。 rcdSize Integer 录制文件大小（MB）。 subject String 会议主题。 scheduserName String 会议预订者名称。 startTime String 会议开始时间。 isDecodeFinish Boolean 录制文件是否转码完成。 decodeEndTime long 录制文件预计转码完成时间。 available Boolean 录播文件是否可观看。 recordAuthType Integer 录播观看鉴权方式，在录播类型为:录播、直播+录播时有效。 0：可通过链接观看/下载 1：企业用户可观看/下载 2：与会者可观看/下载

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 userUUID 否 String Query 用户的UUID。 说明： 仅管理员有权限查询本企业其他用户的会议录制；普通账号该字段无效，只能查询自己的。 offset 否 Integer Query 查询偏移量。默认为0。 limit 否 Integer Query 查询数量。默认是20，最大500条。 queryAll 否 Boolean Query 是否查询企业下所有用户的会议录制。 true：查询所有用户的会议录制 false：仅查询管理员自己的会议录制 说明： 仅对企业管理员生效。 searchKey 否 String Query 查询条件。会议主题、会议预约人和会议ID等可作为搜索内容。 startDate 是 long Query 查询的起始时间戳（单位毫秒）。 endDate 是 long Query 查询的截止时间戳（单位毫秒）。 sortType 否 String Query 查询结果排序类型。 ASC_StartTIME：按录制开始时间升序排序 DSC_StartTIME：按录制开始时间降序排序 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Authorization-Type 否 String Header 标识是否为第三方portal过来的请求。 说明： 该参数将废弃，请勿使用。 X-Site-Id 否 String Header 用于区分到哪个HCSO站点鉴权。 说明： 该参数将废弃，请勿使用。

请求消息示例 请求示例（普通会议） GET /v1/mmc/management/conferences/confDetail?conferenceID=914083136 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: 1811 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: acf5bd2cc7c7f90fe7ab6b95a8c753d5 Server: api-gateway X-Request-Id: e2bc0a1429cb2fd52db88ba6fa2c44a8 { "conferenceData": { "conferenceID": "914083136", "mediaTypes": "Voice,Data,Video", "subject": "user01的会议", "size": 1, "timeZoneID": "56", "startTime": "2019-12-18 07:28", "endTime": "2019-12-18 09:28", "conferenceState": "Created", "accessNumber": "+991117", "language": "zh-CN", "passwordEntry": [ { "conferenceRole": "chair", "password": "******" }, { "conferenceRole": "general", "password": "******" } ], "userUUID": "ff808081699b56cb0169be103500012b", "scheduserName": "user8002", "multiStreamFlag": 1, "conferenceType": 0, "confType": "IMMEDIATELY", "isAutoMute": 1, "isAutoRecord": 0, "chairJoinUri": "https://c.meeting.huaweicloud.com/#/j/914083136/6a30b8b5a325105da031442627828e496f91021ece36405f", "guestJoinUri": "https://c.meeting.huaweicloud.com/#/j/914083136/9505dc3349228b1ce0db8165590cc977bcff89785130fe0d", "recordType": 0, "recordAuxStream": 0, "confConfigInfo": { "isSendNotify": true, "isSendSms": true, "isAutoMute": true }, "vmrFlag": 0, "scheduleVmr": false, "isHasRecordFile": false, "partAttendeeInfo": [ { "phone": "+99111****815", "name": "user01", "type": "normal" } ], "terminlCount": 0, "normalCount": 1, "deptName": "wangyue", "confUUID": "050c7898216811eaa6958bf3bb9ac167" }, "data": { "offset": 0, "limit": 20, "count": 1, "data": [ { "participantID": "+991116003815", "name": "user01", "role": 0, "state": "MEETTING", "attendeeType": "normal", "accountId": "user01" } ] } }

请求参数 表1 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 说明： 创建会议时返回的conferenceID。不是vmrConferenceID。 offset 否 Integer Query 查询偏移量。默认为0。针对PageParticipant 中的与会者分页。 limit 否 Integer Query 查询数量。默认值20。 searchKey 否 String Query 查询条件。长度限制为1-128个字符。 userUUID 否 String Query 用户的UUID。 说明： 该参数将废弃，请勿使用。 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Type 否 Integer Header 默认值为0。 0：不区分终端和与会人 1：分页查询区分终端和与会人，结果合并返回 2：单独查询终端和与会人，结果单独返回 X-Query-Type 否 Integer Header 当“X-Type”“2”时，有效。默认为0。 0：查询与会人 1：查询终端 X-Authorization-Type 否 String Header 标识是否为第三方portal过来的请求。 说明： 该参数将废弃，请勿使用。 X-Site-Id 否 String Header 用于区分到哪个HCSO站点鉴权。 说明： 该参数将废弃，请勿使用。

响应参数 表3 响应参数 参数 类型 描述 conferenceData ConferenceInfo object 会议信息。 data PageParticipant object 与会者列表。 表4 PageParticipant 数据结构 参数 类型 描述 limit Integer 每页的记录数。 count Integer 总记录数。 offset Integer 查询偏移量。 data Array of ParticipantInfo objects 被邀请的与会者信息。包含预约会议时邀请的与会者和会中主持人邀请的与会者。 说明： 不返回会中主动加入的与会者信息。 表5 ParticipantInfo 数据结构 参数 类型 描述 participantID String 与会者的号码。 name String 与会者的名称。 subscriberID String 与会者的号码（预留字段）。 role Integer 与会者的角色。 1：会议主持人 0：普通与会者 state String 用户状态。目前固定返回MEETTING。 address String 终端所在会议室信息（预留字段）。 attendeeType String 与会者终端类型。 “normal”：软终端。 “terminal”：会议室或硬终端。 “outside”：外部与会人。 “mobile”：用户手机号码。 accountId String 与会者的账号。 如果是账号/密码鉴权场景，表示华为云会议账号 如果是APP ID鉴权场景，表示第三方的User ID phone2 String 预留字段。 phone3 String 预留字段。 email String 邮件地址。 sms String 短信通知的手机号码。 deptName String 部门名称。 userUUID String 预订者的用户UUID。 appId String App ID。参考“App ID的申请”。 isAutoInvite Integer 会议开始时是否自动邀请该与会者。默认值由企业级配置决定。 0： 不自动邀请 1： 自动邀请 说明： 仅对并发会议资源的随机会议ID的会议生效。 isNotOverlayPidName Boolean 是否不叠加会场名（VDC场景下适用）。 true：不叠加 false：叠加

请求消息示例 POST /v1/usg/acs/auth/account Connection: keep-alive Authorization: Basic dGVzdDp0ZXN0 Content-Type: application/json Content-Length: 94 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "account": "zhangsan@huawei.com", "clientType": 72, "createTokenType": 0 }

CURL命令 curl -k -i -H 'content-type: application/json' -X POST -H 'Authorization:Basic dGVzdDp0ZXN0' -d '{"account": "user01","clientType": 72,"createTokenType": 0}' 'https://api.meeting.huaweicloud.com/v1/usg/acs/auth/account'

响应消息示例 HTTP/1.1 200 OK Date: Tue, 17 Dec 2019 09:32:47 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 591 Connection: keep-alive X-Request-Id: f90fbd8714328398fcbedddde0f1303c { "accessToken": "cnr1810Ukd9iiytRVdcrK3LiSj0KrGHl6IbtGIgz", "clientType": 72, "createTime": 1663576164818, "daysPwdAvailable": -18172, "delayDelete": false, "expireTime": 1663657182, "firstLogin": true, "forceLoginInd": null, "proxyToken": null, "pwdExpired": false, "refreshCreateTime": 1663576164818, "refreshExpireTime": 1666168164, "refreshToken": "cnr1810GCy8II2HIuNitisGTsl7FELztZ3PvQf9D", "refreshValidPeriod": 2592000, "tokenIp": "10.8.0.90", "tokenType": 0, "user": { "adminType": 2, "alias1": null, "appId": null, "cloudUserId": null, "companyDomain": null, "companyId": "972897387", "corpType": 0, "freeUser": false, "grayUser": false, "headPictureUrl": null, "isBindPhone": null, "name": "xxxx_name", "nameEn": null, "numberHA1": "1ead5e5ce44849bc2718d5c....", "paidAccount": null, "paidPassword": null, "password": null, "realm": "huaweicloud.com", "serviceAccount": "sip:+99111217192335617@huaweicloud.com", "spId": "666bd8558e4646e1a7e1a0c99cf898e8", "status": 0, "thirdAccount": "zhangsan@huawei.com", "tr069Account": "", "ucloginAccount": "zhangsan@huawei.com", "userId": "d2bee87b30544ee68562912fb08b1074", "userType": 2, "visionAccount": null, "weLinkUser": false }, "validPeriod": 84616 }

响应参数 表4 响应参数 参数 类型 描述 accessToken String Access Token字符串。 clientType Integer 登录账号类型。 72：API调用类型 createTime Long Access Token的创建时间戳，单位：毫秒。 daysPwdAvailable Integer 密码有效天数。 expireTime Long Access Token的失效时间戳，单位：秒。 firstLogin Boolean 是否首次登录。 说明： 首次登录表示尚未修改过密码。首次登录时，系统会提醒用户需要修改密码。 默认值：false。 proxyToken ProxyTokenDTO object 代理鉴权信息。 pwdExpired Boolean 密码是否过期。 默认值：false。 refreshCreateTime Long Refresh Token的创建时间戳，单位：毫秒。 refreshExpireTime Long Refresh Token的失效时间戳，单位：秒。 refreshToken String Refresh Token字符串。 refreshValidPeriod Long Refresh Token有效时长，单位：秒。 tokenIp String 用户IP。 tokenType Integer Token类型。 0：用户Access Token 1：会控Token 2：一次性Token user UserInfo object 用户鉴权信息。 validPeriod Long Access Token的有效时长，单位：秒。 forceLoginInd Integer 抢占登录标识。 0: 非抢占 1: 抢占 delayDelete Boolean 是否延时删除状态。 表5 ProxyTokenDTO 数据结构 参数 类型 描述 accessToken String 代理鉴权服务器的短token字符串。 enableRerouting Boolean 是否开启二次路由。 longAccessToken String 代理鉴权服务器的长token字符串。 middleEndInnerUrl String 中台内网地址。 middleEndUrl String 中台地址。 validPeriod Long Token有效时长，单位：秒。 表6 UserInfo 数据结构 参数 类型 描述 adminType Integer 管理员类型。 0：默认管理员 1：普通管理员 2：非管理员，即普通企业成员，“userType”为“2”时有效 appId String 应用ID。 cloudUserId String 华为云账号ID。 companyDomain String 企业域名。 companyId String 用户归属的企业ID。 corpType Integer 企业套餐类型。 0：旗舰版 5：免费版 6：标准版 freeUser Boolean 标识是否是免费试用用户。 grayUser Boolean 标识是否是灰度用户。 headPictureUrl String 头像链接。 isBindPhone Boolean 标识是否绑定手机。 name String 用户名称。 nameEn String 用户英文名称。 numberHA1 String 号码对应的HA1。 alias1 String 用户别名。 paidAccount String 付费用户机机账号，用于智慧屏登录。 paidPassword String 付费用户机机密码，用于智慧屏登录。 password String 机机密码，用于智慧屏登录。 realm String 本地鉴权。 serviceAccount String 用户关联的SIP号码。 spId String 用户所在企业归属的SP ID。 status Integer 用户状态。 0：正常； 1：停用。 thirdAccount String 第三方的用户账号。 tr069Account String tr069账号。 ucloginAccount String 华为云会议账号。 userId String 用户UUID。 userType Integer 用户类型。 1：SP管理用户 2：企业用户 3：免费注册用户 10：企业设备用户 11：匿名用户 12：智慧屏用户 13：IdeaHub用户 14：电子白板（SmartRooms）用户 visionAccount String 智慧屏设备ID。 weLinkUser Boolean 标识是否是WeLink用户。

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 Authorization 是 String Header 鉴权信息，携带用户账号密码信息。使用时需要对账号密码进行Base64转码操作。 规则： Basic Base64(username:password) 样例： Basic eWMyOjE5OTUwwWWM= 说明： password最少8个字符，最多32个字符。 Content-Type 是 String Header Body的媒体格式。 样例：application/json;charset=UTF-8 X-Request-ID 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。 HA2 否 String Body 验证码信息，用于验证码场景携带服务端返回的验证码信息。 account 是 String Body 用户账号（华为云会议账号）。 样例：zhangsan@huawei 业务账号请提前申请，具体申请方法请参见开发流程。 说明： account最少1个字符，最多255个字符。 clientType 是 Integer Body 登录客户端类型。 72：API调用类型 createTokenType 否 Integer Body 是否生成Token，默认值为0。 0：生成token，用于登录鉴权 1：不生成token