华为云用户手册

请求消息示例 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。

业务流程 图1 个人信息管理流程图 第三方通过企业用户账号、密码登录，获取Token。 第三方向网关APIG发送账号鉴权请求。 网关接收请求后，向CloudPortal发送账号鉴权请求。 CloudPortal鉴权通过后返回Token。 网关APIG将Token信息返回给第三方。 第三方向网关APIG发送查询个人信息请求。 网关接收请求后，向CloudPortal发送查询个人信息请求。 CloudPortal返回用户个人信息给网关APIG。 网关APIG将用户个人信息返回给第三方。 为了修改个人信息，填入新的用户名、英文名等参数，第三方携带这些参数向网关APIG发送修改个人信息请求。 网关接收请求后，向CloudPortal发送修改个人信息请求。 CloudPortal收到请求后，修改用户个人信息。 为了修改手机号或邮箱，首先填入原手机或邮箱等参数，第三方携参数向网关APIG发送获取验证码请求。 网关APIG接收请求后，向CloudPortal发送获取验证码请求。 CloudPortal收到请求后，发送验证码到原手机或邮箱。 第三方通过原手机或邮箱获得验证码后，填入原手机或邮箱、验证码等参数，第三方携带这些参数向网关APIG发送校验验证码请求。 网关APIG收到请求后，向CloudPortal发送校验验证码请求。 CloudPortal接收请求后，校验手机和邮箱对应的验证码。 校验成功后，填入新手机或邮箱等参数，第三方携带这些参数向网关APIG发送获取验证码请求。 网关APIG接收请求后，向CloudPortal发送获取验证码请求。 CloudPortal收到请求后，发送验证码到新手机或邮箱。 第三方通过新手机或邮箱获得验证码后，填入新手机或邮箱、验证码等参数，第三方携带这些参数向网关APIG发送修改手机或邮箱请求。 网关APIG收到请求后，向CloudPortal发送修改手机或邮箱请求。 CloudPortal接收请求后，修改用户的手机或邮箱。

请求参数 表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或者第三方账号

响应参数 表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" ] } ]

请求消息示例 POST /v1/mmc/management/conferences Connection: keep-alive X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC 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": "HDVideo", "startTime": "2022-08-30 12:00", "length": 60, "attendees": [ { "accountId": "zhangshan@huawei.com", "appId": "caaab5a3e584497990f6a9b582a0ae42" } ], "confConfigInfo": { "isSendNotify": false, "isSendSms": false, "isSendCalendar": false } }

响应消息示例 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": "914673889", "mediaTypes": "Data,Voice,HDVideo", "subject": "例行会议", "size": 1, "timeZoneID": "56", "startTime": "2022-08-30 12:00", "endTime": "2022-08-30 13:00", "conferenceState": "Schedule", "accessNumber": "+991117", "language": "zh-CN", "passwordEntry": [ { "conferenceRole": "chair", "password": "******" }, { "conferenceRole": "general", "password": "******" } ], "userUUID": "ff80808167ef1edf0167f339533d05a6", "scheduserName": "金秘书", "conferenceType": 0, "confType": "FUTURE", "isAutoMute": 1, "isAutoRecord": 0, "chairJoinUri": "https://c.meeting.huaweicloud.com/#/j/914673889/6a30b8b5a325105da031442627828e496f91021ece36405f", "guestJoinUri": "https://c.meeting.huaweicloud.com/#/j/914673889/9505dc3349228b1ce0db8165590cc977bcff89785130fe0d", "recordType": 2, "confConfigInfo": { "isSendNotify": false, "isSendSms": false, "isAutoMute": true }, "vmrFlag": 0, "partAttendeeInfo": [ { "phone": "+99111********4158", "name": "张三", "type": "normal" } ], "terminlCount": 0, "normalCount": 1, "deptName": "企业协同云服务项目群" } ]

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -d '{"conferenceType": "0","subject": "user01 conference","mediaTypes": "HDVideo","attendees": [{"name": "user01","role": 1,"phone": "+8657*******"}]}' 'https://api.meeting.huaweicloud.com/v1/mmc/management/conferences'

响应参数 表7 响应参数 参数 类型 描述 [数组元素] Array of ConferenceInfo 会议信息列表。 表8 ConferenceInfo 数据结构 参数名称 参数类型 描述 conferenceID String 会议ID。 subject String 会议主题。 size Integer 会议预约时添加的会议者数量。 timeZoneID String 会议通知中会议时间的时区信息。时区信息，参考时区映射关系。 说明： 举例：“timeZoneID”:"26"，则通过华为云会议发送的会议通知中的时间将会标记为如“2021/11/11 星期四 00:00 - 02:00 (GMT) 格林威治标准时间:都柏林, 爱丁堡, 里斯本, 伦敦”。 startTime String 会议起始时间 (YYYY-MM-DD HH:MM )。 endTime String 会议结束时间 (YYYY-MM-DD HH:MM )。 mediaTypes String 会议的媒体类型。 由1个或多个枚举String组成，多个枚举时，每个枚举值之间通过”,”逗号分隔。如：mediaTypes：“Voice,Data,HDVideo” “Voice”：语音 “Video”：标清视频 “HDVideo”：高清视频 “Data”：数据 conferenceState String 会议状态。 “Schedule”：预定状态 “Creating”：正在创建状态 “Created”：会议已经被创建，并正在召开 “Destroyed”：会议已经关闭 language String 会议通知短信或邮件的语言。默认中文。 zh-CN：中文 en-US：英文 accessNumber String 会议接入的SIP号码。 passwordEntry Array of PasswordEntry objects 会议密码。 说明： 创建会议时，返回主持人密码和来宾密码 主持人查询会议时，返回主持人密码和来宾密码 来宾查询会议时，返回来宾密码 userUUID String 会议预订者的用户UUID。 scheduserName String 会议预订者名称。 conferenceType Integer 会议类型。 0 : 普通会议。 2 : 周期性会议。 confType String 会议类型。 FUTURE：将来开始的会议（创建时） IMMEDIATELY：立即开始的会议（创建时） CYCLE：周期会议 cycleParams CycleParams object 周期会议参数。当会议是周期会议的时候携带该参数。 isAutoMute Integer 是否入会自动静音。 0 : 不自动静音 1 : 自动静音 isAutoRecord Integer 是否自动开启云录制。 0 : 不自动启动 1 : 自动启动 chairJoinUri String 主持人会议链接地址。 guestJoinUri String 普通与会者会议链接地址。 audienceJoinUri String 网络研讨会观众会议链接地址。 recordType Integer 录播类型。 0: 禁用 1: 直播 2: 录播 3: 直播+录播 auxAddress String 辅流直播推流地址。 liveAddress String 主流直推流播地址。 recordAuxStream Integer 是否录制辅流。 0：否 1：是 recordAuthType Integer 录播观看鉴权方式。 0：可通过链接观看/下载 1：企业用户可观看/下载 2：与会者可观看/下载 liveUrl String 直播观看地址。 confConfigInfo ConfConfigInfo object 会议其他配置信息。 vmrFlag Integer 是否使用云会议室或个人会议ID召开预约会议。 0：不使用云会议室或个人会议ID 1：使用云会议室或个人会议ID isHasRecordFile Boolean 是否有会议录制文件。仅历史会议查询时返回。 true：有录制文件。 false：没有录制文件。 vmrConferenceID String 云会议室会议ID或个人会议ID。如果“vmrFlag”为“1”，则该字段不为空。 confUUID String 会议的UUID。 说明： 只有创建立即开始的会议才返回UUID，如果是预约未来的会议，不会返回UUID 可以通过查询历史会议列表获取历史会议的UUID partAttendeeInfo Array of PartAttendee objects 被邀请的部分与会者信息。 说明： 只返回被邀请的前20条软终端与会者信息和前20条硬终端与会者信息 不返回会中主动加入的与会者信息 “查询会议列表”和“查询会议详情”接口，返回预约会议时邀请的与会者和会中主持人邀请的与会者 “查询在线会议列表”、“查询在线会议详情”、“查询历史会议列表”和“查询历史会议详情”接口返回预约会议时邀请的与会者。不返回会中主持人邀请的与会者 terminlCount Integer 硬终端个数，如IdeaHub，TE30等。 normalCount Integer 软终端个数，如PC端、手机端App等。 deptName String 会议预定者的企业名称。 role String 与会者角色。 chair ：主持人 general ：来宾 audience ： 观众 说明： 仅在查询会议详情时返回 返回查询者本身的角色 multiStreamFlag Integer 标识是否为多流视频会议。 1 ：多流会议 webinar Boolean 是否是网络研讨会。 onlineAttendeeAmount Integer 当前在线与会人数。包含被邀入会和主动入会的与会者。 说明： 仅在“查询在线会议列表”接口中返回。 confMode String 会议模型。 COMMON ：MCU会议 RTC ：MMR会议 scheduleVmr Boolean VMR预约记录。 true ：VMR会议 false ：普通会议 说明： 该参数将废弃，请勿使用。 vmrID String 云会议室ID。 concurrentParticipants Integer 会议最大与会人数。默认值0。 0：无限制 大于0：会议最大与会人数 supportSimultaneousInterpretation Boolean 会议是否支持同声传译 true ：支持 false ：不支持 picDisplay MultiPicDisplayDO object 多画面信息。 subConfs Array of Subconfs objects 周期子会议列表。 cycleSubConfID String 第一个周期子会议的UUID。 表9 PasswordEntry 数据结构 参数 参数类型 描述 conferenceRole String 会议角色。 chair：会议主持人 general：普通与会者 password String 会议中角色的密码（明文）。 表10 PartAttendee 数据结构 参数 参数类型 描述 name String 与会者名称。 phone String 号码。SIP号码或者手机号码。 phone2 String 预留字段，取值类型同参数“phone”。 phone3 String 预留字段，取值类型同参数“phone”。 type String 终端类型，类型枚举如下： normal：软终端 terminal：硬终端 outside：外部与会人 mobile：用户手机号码 ideahub：ideahub board: 电子白板（SmartRooms）。含Maxhub、海信大屏、IdeaHub B2 hwvision：华为智慧屏TV role Integer 会议中的角色。默认为普通与会者。 0：普通与会者 1：会议主持人 isMute Integer 用户入会时是否需要自动静音 。默认不静音。 0： 不需要静音 1： 需要静音 说明： 仅会中邀请与会者时才生效。 表11 MultiPicDisplayDO 数据结构 参数 类型 描述 manualSet Integer 是否为手工设置多画面。 0 ：系统自动多画面 1 ：手工设置多画面 imageType String 画面类型。取值范围: Single: 单画面 Two: 二画面 Three: 三画面， Three-2: 三画面-2， Three-3: 三画面-3， Three-4: 三画面-4 Four: 四画面， Four-2: 四画面-2， Four-3: 四画面-3 Five: 五画面， Five-2: 五画面-2 Six: 六画面， Six-2: 六画面-2， Six-3: 六画面-3， Six-4: 六画面-4， Six-5: 六画面-5 Seven: 七画面， Seven-2: 七画面-2， Seven-3: 七画面-3， Seven-4: 七画面-4 Eight: 八画面， Eight-2: 八画面-2， Eight-3: 八画面-3， Eight-4: 八画面-4 Nine: 九画面 Ten: 十画面， Ten-2: 十画面-2， Ten-3: 十画面-3， Ten-4: 十画面-4， Ten-5: 十画面-5， Ten-6: 十画面-6 Thirteen: 十三画面， Thirteen-2: 十三画面-2， Thirteen-3: 十三画面-3，Thirteen-4: 十三画面-4， Thirteen-5: 十三画面-5， ThirteenR: 十三画面R， ThirteenM: 十三画面M Sixteen: 十六画面 Seventeen: 十七画面 Twenty-Five: 二十五画面 Custom: 自定义多画面（当前不支持） subscriberInPics Array of PicInfoNotify objects 子画面列表。 switchTime Integer 表示轮询间隔，单位：秒。当同一个子画面中包含有多个视频源时，此参数有效。 picLayoutInfo PicLayoutInfo object 自定义多画面布局信息。预留字段，当前不支持。 表12 PicInfoNotify 数据结构 参数 类型 描述 index Integer 多画面中每个画面的编号，编号从1开始。 id Array of strings 每个画面中的与会者SIP号码。SIP号码可以通过查询企业通讯接口录获取。 share Integer 是否为辅流 0： 不是辅流 1： 是辅流 表13 PicLayoutInfo 数据结构 参数 类型 描述 x Integer 横向小格子数。 y Integer 纵向小格子数。 subPicLayoutInfoList Array of SubPicLayoutInfo objects 多画面信息。 表14 SubPicLayoutInfo 数据结构 参数 类型 描述 id Integer 子画面索引。 left Integer 子画面从左到右的索引。 top Integer 子画面从上到下的索引。 xSize Integer 子画面横向尺寸。 ySize Integer 子画面纵向尺寸。 表15 CycleParams 数据结构 参数 类型 描述 startDate String 周期会议的开始日期，格式：YYYY-MM-DD。 开始日期不能早于当前日期。 说明： 日期是timeZoneID指定的时区的日期，非UTC时间的日期。 endDate String 周期会议的结束日期，格式：YYYY-MM-DD。 开始日期和结束日期间的时间间隔最长不能超过1年。开始日期和结束日期之间最多允许50个子会议，若超过50个子会议，会自动调整结束日期。 说明： 日期是timeZoneID指定的时区的日期，非UTC时间的日期。 cycle String 周期类型。 Day：天 Week：星期 Month：月 interval Integer 子会议间隔。 “cycle”选择了“Day”，表示每几天召开一次，取值范围[1,15] “cycle”选择了“Week”，表示每几周召开一次，取值范围[1,5] “cycle”选择了“Month”，Interval表示隔几月，取值范围[1,3] point Array of integers 周期内的会议召开点。仅当按周和月时有效。 “cycle”选择了“Week”，point中填入了两个元素1和3，则表示每个周一和周三召开会议，0表示周日 “cycle”选择了“Month”，point中填入了12和20则表示每个月的12号和20号召开会议，取值范围为[1,31]，若当月没有该值，则为月末 preRemindDays Integer 提前通知天数。所有与会者在每个子会议开始前N天收到会议通知。取值范围[0,30]。 默认值是1。 表16 ConfConfigInfo 数据结构 参数 类型 描述 isSendNotify Boolean 是否需要发送会议邮件通知。默认值由企业级配置决定。 true：需要 false：不需要 isSendSms Boolean 是否需要发送会议短信通知。默认值由企业级配置决定。 true：需要 false：不需要 isSendCalendar Boolean 是否需要发送会议日历通知。默认值由企业级配置决定。 true：需要 false：不需要 isAutoMute Boolean 来宾入会，软终端是否自动静音。默认值由企业级配置决定。 true：自动静音 false：不自动静音 isHardTerminalAutoMute Boolean 来宾入会，硬终端是否自动静音。默认值由企业级配置决定。 true：自动静音 false：不自动静音 isGuestFreePwd Boolean 是否来宾免密（仅随机会议有效）。 true：免密 false：需要密码 说明： 仅随机会议ID的会议生效。 callInRestriction Integer 允许加入会议的范围。 0：所有用户 2：企业内用户 3：被邀请用户 allowGuestStartConf Boolean 是否允许来宾启动会议。 true：允许来宾启动会议。 false：禁止来宾启动会议。 说明： 仅随机会议ID的会议生效。 guestPwd String 来宾密码（4-16位长度的纯数字）。 vmrIDType Integer 云会议室的会议ID模式。 0：固定会议ID 1：随机会议ID prolongLength Integer 自动延长会议时长（取值范围0-60）。 0：表示会议到点自动结束，不延长会议 其他：表示自动延长的时长 说明： 自动结束会议是按照会议时长计算。比如预定的会议是9:00开始11:00结束，会议时长2个小时，如果与会者8:00就加入会议了，那会议在10:00就会自动结束 设置成其他值时，只要会中还有与会者，会议可以多次延迟 enableWaitingRoom Boolean 开启或者关闭等候室。 true：开启 false：不开启 isHostCameraOn Boolean 主持人入会是否开启摄像头。 true：开启 false：不开启 isGuestCameraOn Boolean 来宾入会是否开启摄像头。 true：开启 false：不开启

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 userUUID 否 String Query 用户的UUID。 说明： 该参数将废弃，请勿使用。 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Authorization-Type 否 String Header 标识是否为第三方portal过来的请求。 说明： 该参数将废弃，请勿使用。 X-Site-Id 否 String Header 用于区分到哪个HCSO站点鉴权。 说明： 该参数将废弃，请勿使用。 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) 格林威治标准时间:都柏林, 爱丁堡, 里斯本, 伦敦”。 非周期会议，如果会议通知是通过第三方系统发送，则这个字段不用填写。 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：不支持 表3 Attendee 数据结构 参数 是否必须 类型 描述 userUUID 否 String 与会者的用户UUID。 accountId 否 String 与会者的账号。 如果是账号/密码鉴权场景: 选填，表示华为云会议账号ID 如果是APP ID鉴权场景：必填，表示第三方的User ID，同时需要携带参数appId appId 否 String App ID。如果是APP ID鉴权场景，此项必填。参考“App ID的申请”。 name 否 String 与会者名称。长度限制为96个字符。 role 否 Integer 会议中的角色。默认为普通与会者。 0：普通与会者 1：会议主持人 phone 否 String 号码。支持SIP号码或者手机号码。 如果是账号/密码鉴权场景：必填 如果是APP ID鉴权场景：选填 说明： 号码可以通过查询企业通讯接口录获取。返回的number是SIP号码，phone是手机号码 填SIP号码系统会呼叫对应的软终端或者硬终端；填手机号码系统会呼叫手机 呼叫手机需要开通PSTN权限，否则无法呼叫 phone2 否 String 预留字段，取值类型同参数“phone”。 phone3 否 String 预留字段，取值类型同参数“phone”。 email 否 String 邮件地址。需要发邮件通知时填写。 sms 否 String 短信通知的手机号码。需要发短信通知时填写。 isMute 否 Integer 用户入会时是否需要自动静音 。默认不静音。 0： 不需要静音 1： 需要静音 说明： 仅会中邀请与会者时才生效。 isAutoInvite 否 Integer 会议开始时是否自动邀请该与会者。默认值由企业级配置决定。 0：不自动邀请。 1：自动邀请。 说明： 仅并发会议资源的随机会议ID会议才生效。 type 否 String 终端类型，类型枚举如下： normal：软终端 terminal：硬终端 outside：外部与会人 mobile：用户手机号码 ideahub：ideahub board: 电子白板（SmartRooms），含Maxhub、海信大屏、IdeaHub B2 hwvision：华为智慧屏TV address 否 String 预留字段，终端所在会议室信息。 deptUUID 否 String 部门ID。 deptName 否 String 部门名称。最大不超过128个字符。 表4 CycleParams 数据结构 参数 是否必须 类型 描述 startDate 是 String 周期会议的开始日期，格式：YYYY-MM-DD。 开始日期不能早于当前日期。 说明： 日期是timeZoneID指定的时区的日期，非UTC时间的日期。 endDate 是 String 周期会议的结束日期，格式：YYYY-MM-DD。 开始日期和结束日期间的时间间隔最长不能超过1年。开始日期和结束日期之间最多允许50个子会议，若超过50个子会议，会自动调整结束日期。 说明： 日期是timeZoneID指定的时区的日期，非UTC时间的日期。 cycle 是 String 周期类型。 Day：天 Week：星期 Month：月 interval 否 Integer 子会议间隔。 “cycle”选择了“Day”，表示每几天召开一次，取值范围[1,15] “cycle”选择了“Week”，表示每几周召开一次，取值范围[1,5] “cycle”选择了“Month”，Interval表示隔几月，取值范围[1,3] point 否 Array of integers 周期内的会议召开点。仅当按周和月时有效。 “cycle”选择了“Week”，point中填入了两个元素1和3，则表示每个周一和周三召开会议，0表示周日 “cycle”选择了“Month”，point中填入了12和20则表示每个月的12号和20号召开会议，取值范围为[1,31]，若当月没有该值，则为月末 preRemindDays 是 Integer 提前通知天数。所有与会者在每个子会议开始前N天收到会议通知。取值范围[0,30]。 默认值是1。 表5 ConfConfigInfo 数据结构 参数 是否必须 类型 描述 isSendNotify 否 Boolean 是否需要发送会议邮件通知。默认值由企业级配置决定。 true：需要 false：不需要 isSendSms 否 Boolean 是否需要发送会议短信通知。默认值由企业级配置决定。 true：需要 false：不需要 说明： 只有正式商用企业才有发送会议短信通知的权限，免费企业即使isSendSms设置成true也不会发送会议短信通知。 isSendCalendar 否 Boolean 是否需要发送会议邮件日历通知。默认值由企业级配置决定。 true：需要 false：不需要 isAutoMute 否 Boolean 来宾入会，软终端是否自动静音。默认值由企业级配置决定。 true：自动静音 false：不自动静音 isHardTerminalAutoMute 否 Boolean 来宾入会，硬终端是否自动静音。默认值由企业级配置决定。 true：自动静音 false：不自动静音 isGuestFreePwd 否 Boolean 是否来宾免密。 true：免密 false：需要密码 说明： 仅随机会议ID的会议生效。 callInRestriction 否 Integer 允许加入会议的范围。 0：所有用户 2：企业内用户 3：被邀请用户 allowGuestStartConf 否 Boolean 是否允许来宾启动会议。 true：允许来宾启动会议 false：禁止来宾启动会议 说明： 仅随机会议ID的会议生效。 guestPwd 否 String 来宾密码（4-16位长度的纯数字）。 vmrIDType 否 Integer 云会议室的会议ID模式。 0：固定会议ID 1：随机会议ID prolongLength 否 Integer 自动延长会议时长（取值范围0-60）。 0：表示会议到点自动结束，不延长会议。 其他：表示自动延长的时长。 说明： 自动结束会议是按照会议时长计算。比如预定的会议是9:00开始11:00结束，会议时长2个小时，如果与会者8:00就加入会议了，那会议在10:00就会自动结束 设置成其他值时，只要会中还有与会者，会议自动多次延长 enableWaitingRoom 否 Boolean 是否开启等候室(只对MMR企业生效)。 true：开启 false：不开启 isHostCameraOn 否 Boolean 主持人入会是否开启摄像头。 true：开启 false：不开启 isGuestCameraOn 否 Boolean 来宾入会是否开启摄像头。 true：开启 false：不开启

业务流程 图1 部门管理流程图 第三方通过企业管理员账号、密码登录，获取Token。 第三方向网关APIG发送账号鉴权请求。 网关接收请求后，向CloudPortal发送账号鉴权请求。 CloudPortal鉴权通过后返回Token。 网关APIG将Token信息返回给第三方。 为了按名称查询企业部门，填入部门名称参数，第三方携带部门名称参数向网关APIG发送查询企业所有部门请求。 网关接收请求后，向CloudPortal发送按名称获取企业所有部门请求。 CloudPortal返回匹配的部门列表信息给网关APIG。 网关APIG将匹配的部门列表信息返回给第三方。 为了查询部门及其一级子部门列表，填入部门编码参数，第三方携带部门编码参数向网关APIG发送查询部门及其一级子部门列表请求。 网关接收请求后，向CloudPortal发送查询部门及其一级子部门列表请求。 CloudPortal返回部门信息给网关APIG。 网关APIG将部门信息返回给第三方。 为了添加部门，填入部门名称等参数，第三方携带这些参数向网关APIG发送添加部门请求。 网关接收请求后，向CloudPortal发送添加部门请求。 CloudPortal添加新部门后，返回新部门编码给网关APIG。 网关APIG返回新部门编码给第三方。 为了修改部门，填入部门编码、部门修改信息等请求参数，第三方携带这些参数向网关APIG发送修改部门请求。 网关接收请求后，向CloudPortal发送修改部门请求。 CloudPortal收到请求后，修改部门信息。 为了删除部门，填入部门编码参数，第三方携带部门编码参数向网关APIG发送删除部门请求。 网关接收请求后，向CloudPortal发送删除部门请求。 CloudPortal收到请求后，删除该部门。 上图的步骤6-26为部门管理接口，且接口调用无顺序要求，根据第三方自身需求进行调用。

响应消息示例 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": [ { "activeCode": null, "activeCodeExpireTime": null, "activeTime": 1601221696783, "adminType": 2, "country": "chinaPR", "deptCode": "1", "deptNamePath": "根部门", "desc": "desc", "email": "******", "englishName": "englishName", "expireTime": null, "hidePhone": false, "id": "a7f78791553d4ec6b3a4b721f0946286", "license": 0, "name": "name", "phone": "+86123456789", "signature": "signature", "sortLevel": 10000, "status": 0, "thirdAccount": "thirdAccount", "title": "manager", "userAccount": "4036ca5e54d144d9b9e3ed25b9368d3a", "userType": 2, "visionAccount": null, "vmrId": "911150978" } ], "limit": 10, "offset": 0 }

请求消息示例 GET /v1/usg/dcs/corp/member Connection: keep-alive X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9 Content-Type: application/json Content-Length: 125 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 offset 否 Integer Query 查询偏移量, 若超过最大数量，则返回最后一页。 limit 否 Integer Query 查询数量。 默认值：10 searchKey 否 String Query 搜索条件，支持名称、手机、邮箱、账号、第三方User ID模糊搜索。 sortField 否 String Query 排序字段名称。 支持的取值： userType adminType ldapAccount deptCode status sortLevel isAsc 否 Boolean Query 是否按升序排序。 deptCode 否 String Query 部门编码，不带则查询所有。 enableSubDept 否 Boolean Query 是否查询子部门。 默认值: true adminType 否 Integer Query 根据管理员类型查询。 1：普通管理员 2：非管理员 enableRoom 否 Boolean Query 查询SmartRooms用户。 说明： 该参数将废弃，请勿使用。 userType 否 Array of integers Query 用户类型，若不携带，则默认查询普通用户。 2：普通用户 12：智慧屏用户 13：IdeaHub用户 14：SmartRooms用户 status 否 Integer Query 用户状态。不带则查询所有。 0：正常 1：停用 containsUnActive 否 Boolean Query 是否查询未激活的终端。 默认值：false 说明： 该参数将废弃，请勿使用。 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 SearchUserResultDTO objects 分页查询企业用户信息。 表5 SearchUserResultDTO 数据结构 参数 类型 描述 activeCode String 激活码。 activeCodeExpireTime Long 激活码到期时间，utc时间戳。 activeTime Long 激活时间，utc时间戳。 adminType Integer 管理员类型。 0：默认（超级）管理员 1：普通管理员 2：非管理员（即为普通企业成员，UserType是2时有效） country String 手机所属国家。 deptCode String 部门编码。 deptNamePath String 部门完整名称。 desc String 备注。 email String 邮箱。 englishName String 英文名称。 expireTime Long 已激活的终端到期时间，utc时间戳。 hidePhone Boolean 是否隐藏手机号码。 id String 用户UUID。 license Integer 许可证。 0：商用 1：免费试用 name String 名称。 phone String 联系电话。 signature String 签名。 sortLevel Integer 通讯录排序等级，序号越低优先级越高。 maximum：10000 minimum：1 status Integer 用户状态。 0：正常 1：停用 thirdAccount String 第三方User ID。 title String 职位。 userAccount String 华为云会议账号。 userType Integer 用户类型。 2：普通用户 12：智慧屏用户 13：IdeaHub用户 14：SmartRooms用户 visionAccount String 智慧屏账号。 vmrId String 个人会议ID。

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' -d '{"enableSSO": true,"domain": "clouddragon.huawei.com","authorizeUrl": "http://127.0.0.1:8444/sns/userinfo","getTokenUrl": "http://127.0.0.1:8444/sns/oauth2/access_token","clientId": "18bc94a643bd4b93aab3179726120943","clientSecret": null,"scope": null,"accFieldName": "openid","getUserInfoUrl": "http://127.0.0.1:8444/sns/userinfo","oauth2ServerType": 0,"pcSchemaUrl": "http://127.0.0.1:8444/schema/pc","androidSchemaUrl": "http://127.0.0.1:8444/schema/android","iosSchemaUrl": "http://127.0.0.1:8444/schema/ios","thirdName": "openid","thirdEmail": null,"thirdMobile": null,"thirdAccessToken": "access_token","thirdHeadImgUrl": null}' 'https://api.meeting.huaweicloud.com/v1/usg/acs/authorizeconfig'

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-ID 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。 Content-Type 是 String Header Body的媒体格式。取值:application/json; charset=UTF-8 enableSSO 是 Boolean Body 是否开启SSO登录。 domain 否 String Body 企业域名。 说明： 开启SSO登录时必填。 authorizeUrl 否 String Body 鉴权中心URL。 说明： 开启SSO登录时必填。 getTokenUrl 否 String Body 获取Token URL。 说明： 开启SSO登录时必填。 clientId 否 String Body APPID。 说明： 开启SSO登录时必填。 clientSecret 否 String Body APP秘钥。 说明： 开启SSO登录时，当getTokenUrl或者getUserInfoUrl有变更时必填。 开启SSO登录时，当getTokenUrl和getUserInfoUrl未变更时，且不修改APP秘钥，则置空即可。 scope 否 String Body 授权范围。 openid：OAuth2.0的OIDC accFieldName 否 String Body 第三方账号的字段名称。 说明： 开启SSO登录时必填。 getUserInfoUrl 否 String Body 用户信息查询URL。 oauth2ServerType 否 Integer Body 鉴权类型。 0：OAuth2.0鉴权 pcSchemaUrl 否 String Body 拉起PC端终端的schema。 androidSchemaUrl 否 String Body 拉起安卓端终端的schema。 iosSchemaUrl 否 String Body 拉起ios端终端的schema。 thirdName 否 String Body 第三方名称的字段名称。 thirdEmail 否 String Body 第三方邮箱的字段名称。 thirdMobile 否 String Body 第三方手机号的字段名称。 thirdAccessToken 否 String Body 第三方accessToken的字段名称。 说明： 开启SSO登录时必填。 thirdHeadImgUrl 否 String Body 第三方头像链接的字段名称。

请求消息示例 POST /v1/usg/acs/authorizeconfig 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) { "enableSSO": true, "domain": "clouddragon.huawei.com", "authorizeUrl": "http://127.0.0.1:8444/sns/userinfo", "getTokenUrl": "http://127.0.0.1:8444/sns/oauth2/access_token", "clientId": "18bc94a643bd4b93aab3179726120943", "clientSecret": null, "scope": null, "accFieldName": "openid", "getUserInfoUrl": "http://127.0.0.1:8444/sns/userinfo", "oauth2ServerType": 0, "pcSchemaUrl": "http://127.0.0.1:8444/schema/pc", "androidSchemaUrl": "http://127.0.0.1:8444/schema/android", "iosSchemaUrl": "http://127.0.0.1:8444/schema/ios", "thirdName": "openid", "thirdEmail": null, "thirdMobile": null, "thirdAccessToken": "access_token", "thirdHeadImgUrl": null }

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

请求参数 表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。

响应参数 表4 响应参数 参数 类型 描述 account String 用户账号。 adminType Integer 管理员类型。 0：默认管理员 1：普通管理员 country String 手机号所属的国家。 dept DeptBasicDTO object 部门基本信息，查询企业级别的管理员时需要显示部门信息。 email String 邮箱。 id String 用户id。 name String 名称。 phone String 手机号。 表5 DeptBasicDTO 参数说明 参数 类型 描述 corpId String 企业id。 deptCode String 部门编码。 deptName String 部门名称 deptNamePath String 部门名称路径。 parentDeptCode String 父部门编码。

请求消息示例 GET /v1/usg/dcs/corp/admin/test006?accountType=0 Connection: keep-alive X-Access-Token: stbH3o4N83uDQPOcFtScKC9nbqCXt3cIDB1U 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 Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: efd3e53b2d9fa554d11267d5d66ca0bf { "id": "ff8080816a024f05016a4e1c2c570a5d", "account": "test006", "name": "test006", "adminType": 1, "email": "******", "phone": null, "country": null, "dept": { "deptCode": "1", "corpId": "15659", "deptName": "wangyue", "deptNamePath": "wangyue", "parentDeptCode": null } }

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" }