华为云用户手册

CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token: stbWWx06NMlL9EtMVHJHXLgXSesds7YX9zFM' -d '{"account":"user02","oldPwd":"*********","newPwd":"********"}' 'https://api.meeting.huaweicloud.com/v1/usg/acs/password'

响应消息示例 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 http_proxy_id: c94f64967745b0670c299c0688479078 Server: api-gateway X-Request-Id: bce6a227f986f25d3dfaf147ba75af8f

请求消息示例 PUT /v1/usg/acs/password Connection: keep-alive X-Access-Token: stbWWx06NMlL9EtMVHJHXLgXSesds7YX9zFM Content-Type: application/json Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "oldPwd": "*********", "newPwd": "*********", "account": "user002" }

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 1153 Connection: keep-alive http_proxy_id: 79ea4d8bdb461a4b811a117f9cf3dbde Server: api-gateway X-Request-Id: 1ccc1d7937dd0f66067aeecb9f1df241 [ { "conferenceID": "986256843", "mediaTypes": "HDVideo,Data,Voice", "subject": "例行周期会议", "size": 0, "timeZoneID": "56", "startTime": "2021-09-01 08:39", "endTime": "2021-09-01 09:09", "conferenceState": "Schedule", "accessNumber": "+86571150", "language": "zh-CN", "passwordEntry": [ { "conferenceRole": "chair", "password": "******" }, { "conferenceRole": "general", "password": "******" } ], "userUUID": "fe235be7aa6045b98a33f27b365cbca9", "scheduserName": "苏州分部", "multiStreamFlag": 1, "conferenceType": 2, "confType": "CYCLE", "cycleParams": { "startDate": "2021-09-01", "cycle": "Day", "endDate": "2021-09-02", "cycleCount": 0, "interval": 1, "preRemindDays": 1 }, "isAutoMute": 0, "isHardTerminalAutoMute": 0, "isSoftTerminalAutoMute": 0, "isAutoRecord": 0, "chairJoinUri": "https://100.95.188.184:443/#/j/986256843/fa4def332cb83f5b1ec74c64d0658a8570f45ad3e8d0df8c", "guestJoinUri": "https://100.95.188.184:443/#/j/986256843/53f55ec44263d666e8ed70594624aa10497c631a91d3b8c1", "recordType": 0, "recordAuxStream": 0, "recordAuthType": 2, "confConfigInfo": { "inviteMode": "AUTO_INVITE", "prolongLength": 15, "isGuestFreePwd": false, "isSendNotify": true, "isSendSms": true, "isSendCalendar": true, "isAutoMute": false, "isHardTerminalAutoMute": false, "callInRestriction": 0, "audienceCallInRestriction": 0, "allowGuestStartConf": true, "enableWaitingRoom": false }, "vmrFlag": 0, "scheduleVmr": false, "isHasRecordFile": false, "terminlCount": 0, "normalCount": 0, "deptName": "corpzxytest111", "confMode": "RTC", "webinar": false, "concurrentParticipants": 0, "subConfs": [ { "cycleSubConfID": "fe24d1350a3611ecbe71a328ac3ca004", "conferenceID": "986256843", "startTime": "2021-09-01 08:39", "endTime": "2021-09-01 09:09", "mediaType": "HDVideo,Data,Voice", "isAutoRecord": 0, "recordAuthType": 2, "confConfigInfo": { "callInRestriction": 0, "audienceCallInRestriction": 0, "allowGuestStartConf": true, "enableWaitingRoom": false } }, { "cycleSubConfID": "fe24d1360a3611ecbe71fdd2c36bc8c2", "conferenceID": "986256843", "startTime": "2021-09-02 08:39", "endTime": "2021-09-02 09:09", "mediaType": "HDVideo,Data,Voice", "isAutoRecord": 0, "recordAuthType": 2, "confConfigInfo": { "callInRestriction": 0, "audienceCallInRestriction": 0, "allowGuestStartConf": true, "enableWaitingRoom": false } } ] } ]

响应参数 表4 响应参数 参数 类型 描述 [数组元素] Array of ConferenceInfo 会议信息列表。 表5 Subconfs 数据结构 名称 类型 描述 cycleSubConfID string 子会议UUID。 conferenceID string 会议ID。 mediaType string 会议的媒体类型。 Voice：语音 Video：标清视频 HDVideo：高清视频 Data：数据 startTime string 会议起始时间(格式:YYYY-MM-DD HH:MM)。 endTime string 会议结束时间(格式:YYYY-MM-DD HH:MM)。 isAutoRecord Integer 是否自动开启云录制。 0: 不自动启动 1: 自动启动 confConfigInfo Confconfinginfo object 周期子会议其他配置信息。 recordAuthType Integer 观看/下载录播的鉴权方式。 0: 可通过链接观看/下载 1: 企业用户可观看/下载 2: 与会者可观看/下载 description string 会议描述。长度限制为200个字符。 表6 Confconfiginfo 数据结构 名称 类型 描述 callInRestriction Integer 允许加入会议的范围。 0: 所有用户 2: 企业内用户 3: 被邀请用户 audienceCallInRestriction Integer 允许加入网络研讨会的观众范围。 0：所有用户 2：企业内用户和被邀请用户 allowGuestStartConf Boolean 是否允许来宾启动会议。 true: 允许来宾启动会议 false: 禁止来宾启动会议 说明： 仅随机会议ID有效。 enableWaitingRoom Boolean 是否启用等候室。 showAudienceCountInfo ShowAudienceCountInfo object 网络研讨会观众数显示策略。 表7 ShowAudienceCountInfo 数据结构 名称 类型 描述 showAudienceMode Integer 观众显示策略:服务端用来计算观众人数下发给客户端控制观众显示。 0: 不显示 1: 倍增显示与会人数。基于实时与会人数或累计与会人次（假设为N），可以再进行倍增设置。支持设置倍增倍数X和基础人数Y，设置后，显示的人数为：N*X+Y baseAudienceCount Integer 基础人数。范围是0~10000。 multiple Double 倍增倍数。范围是1~10, 支持设置到小数点后1位。

请求消息示例 POST /v1/mmc/management/cycleconferences Connection: keep-alive X-Access-Token: cnr1510zTBhrfUsymQ0srhW2RYS99r9G5SQoTLWN Content-Type: application/json user-agent: WeLink -desktop Content-Length: 548 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "subject": "例行周期会议", "mediaTypes": "Data,Voice,HDVideo", "startTime": "", "length": 120, "timeZoneID": "56", "vmrFlag": 1, "vmrID": "ff80808167ef1edf0167f339533f05a8", "cycleParams": { "startDate": "2021-08-31", "endDate": "2021-09-02", "cycle": "Day", "interval": 1, "preRemindDays": 1 }, "attendees": [ { "userUUID": "ff80808167ef1edf0167f339533d05a6", "name": "苏州分部", "email": "******", "sms": "+991116006724", "deptName": "企业协同云服务项目群", "role": 0, "phone": "+99119*****724", "type": "normal" } ], "confConfigInfo": { "isSendNotify": "false", "isSendSms": "false", "isSendCalendar": "false" }, "recordType": 0 }

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token:cnr1510zTBhrfUsymQ0srhW2RYS99r9G5SQoTLWN' -d '{"conferenceType": "2","subject": "user01 conference","mediaTypes": "HDVideo","attendees": [{"name": "user01","role": 1,"phone": "+8657*******"}], "cycleParams": {"startDate": "2021-08-31","endDate": "2021-09-02","cycle": "Day","interval": 1,"preRemindDays": 1}}' 'https://api.meeting.huaweicloud.com/v1/mmc/management/cycleconferences'

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 userUUID 否 String Query 用户的UUID。 说明： 该参数将废弃，请勿使用。 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Authorization-Type 否 String Header 标识是否为第三方portal过来的请求。 说明： 该参数将废弃，请勿使用。 X-Site-Id 否 String Header 用于区分到哪个H CS O站点鉴权。 说明： 该参数将废弃，请勿使用。 startTime 否 String Body 会议开始时间（UTC时间）。格式：yyyy-MM-dd HH:mm。 说明： 创建预约会议时，如果没有指定开始时间或填空串，则表示会议马上开始 时间是UTC时间，即0时区的时间 length 否 Integer Body 会议持续时长，单位分钟。默认30分钟。 最大1440分钟（24小时），最小15分钟。 subject 否 String Body 会议主题。长度限制为128个字符。 mediaTypes 是 String Body 会议的媒体类型。 Voice：语音会议 HDVideo：视频会议 groupuri 否 String Body 软终端创建即时会议时在当前字段带临时群组ID，由服务器在邀请其他与会者时在或者conference-info头域中携带。 长度限制为31个字符。 attendees 否 Array of Attendee objects Body 与会者列表。 cycleParams 否 CycleParams object Body 周期会议的参数，当会议是周期会议的时候该参数必须填写。 isAutoRecord 否 Integer Body 会议是否自动启动录制，在录播类型为：录播、录播+直播时才生效。默认为不自动启动。 1：自动启动录制 0：不自动启动录制 encryptMode 否 Integer Body 会议媒体加密模式。默认值由企业级的配置填充。 0：自适应加密 1 : 强制加密 2 : 不加密 language 否 String Body 会议通知短信或邮件的语言。默认中文。 zh-CN：中文 en-US：英文 timeZoneID 否 String Body 会议通知中会议时间的时区信息。时区信息，参考时区映射关系。 说明： 举例：“timeZoneID”:"26"，则通过华为云会议发送的会议通知中的时间将会标记为如“2021/11/11 星期四 00:00 - 02:00 (GMT) 格林威治标准时间:都柏林, 爱丁堡, 里斯本, 伦敦”。 startDate和endDate中的日期是timeZoneID指定时区的日期。 recordType 否 Integer Body 录播类型。默认为禁用。 0: 禁用 1: 直播 2: 录播 3: 直播+录播 liveAddress 否 String Body 主流直播推流地址，在录播类型为 :直播、直播+录播时有效。最大不超过255个字符。 auxAddress 否 String Body 辅流直播推流地址，在录播类型为 :直播、直播+录播时有效。最大不超过255个字符。 recordAuxStream 否 Integer Body 是否录制辅流，在录播类型为：录播、录播+直播时有效。默认只录制视频主流，不录制辅流。 0：不录制 1：录制 confConfigInfo 否 ConfConfigInfo object Body 会议其他配置信息。 recordAuthType 否 Integer Body 录播观看鉴权方式，在录播类型为:录播、直播+录播时有效。 0：可通过链接观看/下载 1：企业用户可观看/下载 2：与会者可观看/下载 vmrFlag 否 Integer Body 是否使用云会议室或者个人会议ID召开预约会议。默认0。 0：不使用云会议室或者个人会议ID 1：使用云会议室或者个人会议ID vmrID 否 String Body 绑定给当前创会账号的VMR ID。通过查询云会议室及个人会议ID接口获取。 说明： vmrID取上述查询接口中返回的id，不是vmrId 创建个人会议ID的会议时，使用vmrMode=0的VMR；创建云会议室的会议时，使用vmrMode=1的VMR vmrID使用个人会议ID占用并发资源，使用云会议室ID占用云会议室资源；vmrID既不使用个人会议ID也不使用云会议室ID（vmrflag=0，vmrID=null）占用并发资源 concurrentParticipants 否 Integer Body 会议方数，会议最大与会人数限制。 0：无限制 大于0：会议最大与会人数 supportSimultaneousInterpretation 否 Boolean Body 会议是否支持同声传译 true：支持 false：不支持

CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9' -d '{"country": "chinaPR","deptCode": "1","desc": "modDesc","email": "******","englishName": "modEnglishName","hidePhone": true,"name": "modName","phone": "+86173****9807","signature": "modSignature","sortLevel": 1,"status": 1,"title": "modTitle","vmrId": ""}' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/member/3e48b79b660e403cb5e0208f7be83961?accountType=0

请求消息示例 PUT /v1/usg/dcs/corp/member/3e48b79b660e403cb5e0208f7be83961?accountType=0 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) { "country": "chinaPR", "deptCode": "1", "desc": "modDesc", "email": "******", "englishName": "modEnglishName", "hidePhone": true, "name": "modName", "phone": "+86173****9807", "signature": "modSignature", "sortLevel": 1, "status": 1, "title": "modTitle", "vmrId": "" }

响应消息示例 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: 26701eb8f982b175b70776316d46e33e { "activeTime": 1601221696783, "adminType": 2, "corp": null, "country": "chinaPR", "deptCode": "1", "deptName": "根部门", "deptNamePath": "根部门", "desc": "modDesc", "devType": { "deviceSize": null, "model": null, "purchaseChannel": null }, "email": "******", "englishName": "modEnglishName", "function": { "enableRoom": true }, "hidePhone": true, "id": "f521bebcbb27422cb3241c4cb19942c5", "license": 0, "name": "modName", "phone": "+86173****9807", "signature": "modSignature", "sipNum": "+8657198480", "sortLevel": 1, "status": 1, "thirdAccount": "thirdAccount", "title": "modTitle", "userAccount": "3e48b79b660e403cb5e0208f7be83961", "userType": 2, "visionAccount": null, "vmrList": [ { "id": "2c908bc76f61a5f2016f61bbfdf5039b", "status": "0", "vmrId": "912992631", "vmrName": "name的云会议室", "vmrPkgId": null, "vmrPkgLength": null, "vmrPkgName": null, "vmrPkgParties": null } ] }

响应参数 表4 响应参数 参数 类型 描述 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 用户id。 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：企业成员账户 visionAccount String 智慧屏唯一账号 vmrList Array of UserVmrDTO objects 云会议室列表。

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 account 是 String Path 账号。 如果是账号/密码鉴权方式，是指华为云会议账号 如果是App ID鉴权方式，是指第三方User ID accountType 否 Integer Query 账号类型。默认0。 0：华为云会议账号。用于账号/密码鉴权方式 1：第三方User ID，用于App ID鉴权方式 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。 country 否 String Body 手机号所属的国家。 默认值：chinaPR。 maxLength：255 minLength：0 deptCode 否 String Body 部门编码，若不携带则默认根部门。 默认值：1 desc 否 String Body 备注。 maxLength：128 minLength：0 email 否 String Body 邮箱。 englishName 否 String Body 企业用户的英文名称。 maxLength：64 minLength：0 hidePhone 否 Boolean Body 是否隐藏手机号码。 默认值：false name 否 String Body 企业用户名称。 maxLength：64 minLength：1 phone 否 String Body 手机号，必须加上国家码。 例如中国大陆手机为“+86xxxxxxxxxxx”。当填写手机号时 “country”参数必填。 手机号只允许输入纯数字。 说明：手机号或者邮箱至少填写一个。 signature 否 String Body 签名。 maxLength：512 minLength：0 sortLevel 否 Integer Body 通讯录排序等级，序号越低优先级越高。 默认值：10000 maximum：10000 minimum：1 status 否 Integer Body 用户状态。 0：正常 1：停用 默认值：0 title 否 String Body 职位。 maxLength：32 minLength：0 vmrId 否 String Body 个人会议ID，若不携带则后台默认生成。

请求消息示例 PUT /v1/usg/dcs/sp/corp/818803911/resource Connection: keep-alive X-Access-Token: stbvmKo5lr6vT7QIzKHg4iqicUBcYMb3qlki Content-Type: application/json Content-Length: 53 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) [ { "expireDate": 2549030400000, "id": "733ff391f2a14360af3b93bd1325f9f9", "isDisabled": false, "type": "VMR" } ]

CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token: stbvmKo5lr6vT7QIzKHg4iqicUBcYMb3qlki' -d '[{"expireDate": 2549030400000,"id": "733ff391f2a14360af3b93bd1325f9f9","isDisabled": false,"type": "VMR"}]' 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 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: 539e8b710378987ffc5eb844b5e5c290

请求参数 表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 ModResourceDTO objects Body 待修改的资源列表，最多支持批量处理100个。 表3 ModResourceDTO 数据结构 参数 是否必须 类型 位置 描述 expireDate 否 Long Body 到期时间。 id 是 String Body 资源标识。 isDisabled 否 Boolean Body 资源是否被停用。 type 否 String Body 资源类型，企业内ID和TYPE唯一标识一个资源项，若只传资源ID可能会修改多个资源的信息。 VMR：云会议室 CONF_CALL：会议并发数 HARD_1080P：1080P硬终端 HARD_720P：720P硬终端 SOFT：软终端用户数 ROOM：大屏软终端 LIVE：直播推流 RECORD：录播空间 HARD_THIRD_PARTY：第三方硬终端账号 HUAWEI_VISION：智慧屏

在线与会者推送示例 { "data": [{ "pid": "uzr571a9brwu11cvcibvru5a7r7rryiy", "mode": 0, "pinfoMap": { "CAMERASTATE": "1", "ORG_ID": "44252", "LOCKED_VIEW": "0", "MUTE": "1", "ACCOUNT_ID": "271682cfdbe14fa9ae3a8b25f7502627", "LOCALREC": "0", "TEL": "+86571299676493248", "ALLOW_CLIENT_REC": "0", "STATE": "0", "SHARE": "0", "ANONYMOUS": "0", "ADDTIME": "1611988486336", "NAME": "张三", "CLIENT_REC_STATE": "0", "CLIENT_CAPABILITIES": "1,3", "ROLE_SWITCH_OVER": "0", "RTC_USER_ID": "uzr571a9brwu11cvcibvru5a7r7rryiy", "CLIENT_ LOG IN_TYPE": "Desktop", "T": "1", "ACCOUNT": "zhangsan", "BROADCAST": "0", "IS_COHOST": "0", "HAND": "0", "IS_SVC": "1", "ROLLCALL": "0", "M": "1", "VIDEO": "1", "ROLE": "1", "THIRDACCOUNT": "zhangsan", "INVITE_SHARE_STATE": "0" } }], "confID": "900487914", "msgID": "23a429e862d111eb980a11b5be5aab3c", "msgMode": 0, "version": 1611993595058, "createTime": 1611993595058, "action": "ParticipantsNotify" }

请求消息示例 PUT /v1/usg/acs/password/reset Connection: keep-alive X-Access-Token: hYRlErvNnuqEuseSo0PoDBLMvol71wJm7 Content-Type: application/json Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "user": "+86136****9209", "newPwd": "*********" }

响应消息示例 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

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取校验验证码返回的token。 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。 newPwd 是 String Body 用户新的登录密码。 密码要求： 长度范围要求8~32 至少包含大小写字母、数字、特殊字符中的两个 不能包含3个以上重复字符 密码不能包含与其对应的用户名（不区分大小写）以及逆序的用户名（不区分大小写） passWordType 否 Integer Body 1：临时密码，重置完密码后登录Web Portal根据配置可能需要强制修改密码 非1：正式密码，重置完密码后登录Web Portal不需要强制修改密码。 user 是 String Body 用户身份信息（手机号码或邮箱账号或用户真实账号）。

业务流程 图1 WeLink 代理鉴权登录流程图 前期准备：获取到WeLink的账号密码。 有两种途径：1，免费注册获取试用账号；2，直接购买服务后通过企业管理员创建账号。 1.初始化参数，填入账号、密码等请求参数。 2.第三方向网关APIG发送鉴权请求，携带初始化参数。 3.网关APIG接收请求后，向Cloud USG发起鉴权请求。 4.Cloud USG接受请求后，向WeLink SSO发送代理鉴权请求。 5.WeLink SSO返回鉴权通过的信息。 6.鉴权通过后，Cloud USG将生成自身的Token并返回给网关APIG。 7.网关APIG将收到的Token信息返回给第三方。

响应参数 表4 响应参数 参数 类型 描述 count Integer 总数量。 limit Integer 每页显示的条目数量。 默认值：10。 offset Integer 页面起始页，从0开始 data Array of UserDTO objects 分页查询企业用户信息。 表5 UserDTO 数据结构 参数 类型 描述 account String 用户账号。 deptName String 用户部门。 description String 描述信息。 email String 邮箱。 englishName String 英文名。 hidePhone Boolean 是否隐藏手机号（如果为true，其他人查询该用户时，不会返回该用户的手机号。自己查自己是可见的） id String 用户ID。 isHardTerminal Boolean 是否为硬终端。 说明： 该参数将废弃，请勿使用。 name String 用户名。 number String 用户SIP号码。 phone String 用户手机。 signature String 用户签名。 statusCode Integer 查询用户详情时, 根据不同情况，响应不同。 0： 查询成功且用户信息有变化， 响应会把新的信息都返回回去 1 ：查询成功且用户信息没有变化，响应只会返回用户ID 2 ：用户不存在 3 ：无权限查询这个用户 title String 职位。 type String 类型： NORMAL_USER：普通用户 HARD_TERMINAL：硬终端用户 WHITE_BOARD：第三方白板 HW_VISION_MEMBER：智慧屏 IDEA_HUB_MEMBER：ideahub用户 updateTime Long 用户信息最后更新时间，更新时间按照时间戳格式返回。 vmrId String 用户个人会议ID。 deptCodes Array of strings 部门编码列表。

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 offset 否 Integer Query 查询偏移量，若超过最大数量，则返回最后一页的数据。 默认值：0 limit 否 Integer Query 查询数量。 默认值：100 searchKey 否 String Query 搜索条件。支持账号、SIP号码、名称、手机、邮箱模糊搜索 deptCode 否 String Query 部门编码。 maxLength：32 minLength：0 querySubDept 否 Boolean Query 是否查询子部门下的用户。 默认值：true searchScope 否 String Query 搜索范围。 NORMAL_USER表示查询普通用户。返回普通用户（响应中isHardTerminal=false，type=NORMAL_USER） HARD_TERMINAL表示查询硬终端用户。返回 大屏用户（响应中isHardTerminal=false，type=WHITE_BOARD）； 硬终端用户（响应中isHardTerminal=true，type=HARD_TERMINAL）； ideahub用户（响应中isHardTerminal=false，type=IDEA_HUB_MEMBER） ALL表示查询所有用户。 默认值为ALL。 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/usg/abs/users Connection: keep-alive X-Access-Token: stbiQWNk96PwWeKsA32h81u9YSiK3xZhpNEU Content-Type: application/json Content-Length: 102 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 http_proxy_id: 1fd3a76bc862c7bc7f7c9b09bea87647 Server: api-gateway X-Request-Id: 7f3dc39fd1af5f1f274641d46ed720ba { "offset": 0, "limit": 100, "count": 1, "data": [ { "id": "067f692ed2ce492182a44579f6bc82aa", "statusCode": 0, "account": "067f692ed2ce492182a44579f6bc82aa", "name": "TE30", "englishName": null, "email": null, "phone": null, "deptName": "wangyue", "number": "+99111283523475338", "signature": null, "title": null, "description": null, "vmrId": null, "updateTime": 1567405876353, "isHardTerminal": true, "hidePhone": false, "type": "HARD_TERMINAL", "deptCodes": [ "1" ] } ] }

请求消息示例 POST /v1/wss/webinar/open/conferences HTTP/1.1 Host: 251ba26eef46472d97fa4462d514b044.APIG.cn-north-7.huaweicloudapis.com User-Agent: APIGatewayDebugClient/1.0 Content-Length: 627 Content-Type: application/json;charset=UTF-8 X-Access-Token: cnr1519GbhwxP6eXPT70gHBabwCoAnFHezYAln4F X-APIG-Mode: debug { "subject": "网络研讨会", "startTime": "2021-04-29 11:00", "duration": 120, "timeZoneId": "56", "vmrID": "2c908f997544c76501754927728b0167", "attendees": [{ "appId": "appid", "userName": "user", "sms": "+8613111111111", "deptName": "dept", "phone": "+86131****1111", "userAccount": "userAccount", "email": "user@xxx.com" }], "notifySetting": { "enableEmail": "N", "enableSms": "N", "enableCalendar": "N" }, "callRestriction": false, "guestPasswd": null, "audiencePasswd": null, "audienceScope": 0, "scope": 0, "enableRecording": "Y", "liveAddress": "rtmp://pushs.skylin.tv/live/lxep4ed5?auth_info=20121116-784d9d656ayongc0e208a6a126ca78cc1", "auxAddress": "rtmp://pushs.skylin.tv/live/lxep4ed5?auth_info=20121116-784d9d656abec8c0yonga6a126ca78cc", "liveUrl": "http://e516b694a7974cd5bceab78ee05b8f43.skylin.tv/watch/ldx4o" }

响应消息示例 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:30:56 GMT Pragma: no-cache Server: api-gateway Strict-Transport-Security: max-age=16070400; includeSubDomains X-APIG-Latency: 426 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: 425 X-Content-Type-Options: nosniff X-Download-Options: noopen X-Envoy-Upstream-Service-Time: 321 X-Frame-Options: SAMEORIGIN X-Request-Id: 93c193ab24312a9abe45638a3381a26b X-Xss-Protection: 1;mode=block { "conferenceId": "982311022", "corpId": "314765464", "subject": "网络研讨会", "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/f78c393***********************************c43c3d", "chairPasswd": "******", "guestJoinUri": "https://meeting.huaweicloud.com/#/j/982311022/8e057f9************************************0014d", "guestPasswd": "******", "audienceJoinUri": "https://meeting.huaweicloud.com/#/j/982311022/aab78*********************************aac4d7e5", "audiencePasswd": "******", "enableRecording": "Y", "liveUrl": "http://e516b694a7974cd5bceab78ee05b8f43.skylin.tv/watch/ldx4o", "attendees": ["user"] }

响应参数 表6 响应参数 参数 类型 描述 conferenceId String 网络研讨会ID。 corpId String 企业ID。 subject String 网络研讨会主题。 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 观众入会密码。 enableRecording String 录制是否开启。 Y: 开启 N: 不开启 liveAddress string 主流直播推流地址。 auxAddress string 辅流直播推流地址。 liveUrl string 直播房间地址。 attendees Array of String objects 与会嘉宾名称列表。

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token:cnr1519GbhwxP6eXPT70gHBabwCoAnFHezYAln4F' -d '{ "subject": "网络研讨会", "startTime": "2021-04-29 11:00", "duration": 120, "timeZoneId": "56", "vmrID": "2c908f997544c76501754927728b0167", "attendees": [{ "userId": "bb05917f7363407ea6b1df019fdf257a", "userName": "user", "sms": "+86131****1111", "deptName": "dept", "phone": "+86131****1111", "userAccount": "userAccount", "email": "user@xxx.com" }], "notifySetting": { "enableEmail": "N", "enableSms": "N", "enableCalendar": "N" }, "callRestriction": false, "guestPasswd": null, "audiencePasswd": null, "audienceScope": 0, "scope": 0 }' 'https://api.meeting.huaweicloud.com/v1/wss/webinar/open/conferences'