华为云用户手册

  • 响应参数 表4 响应参数 参数 类型 描述 accessToken String 接入Token字符串。 clientType Integer 登录账号类型。 72:API调用类型 createTime Long 业务token的创建时间戳,单位:毫秒。 daysPwdAvailable Integer 密码有效天数。 delayDelete Boolean 是否延时删除状态。 expireTime Long Token的失效时间戳,单位:秒。 firstLogin Boolean 是否首次登录。 说明: 首次登录表示尚未修改过密码。首次登录时,系统会提醒用户需要修改密码。 默认值:false。 forceLoginInd Integer 抢占登录标识。 0:非抢占 1:抢占(未启用) proxyToken ProxyTokenDTO object 代理鉴权信息。 pwdExpired Boolean 密码是否过期。 默认值:false。 refreshCreateTime Long 刷新token的创建时间戳,单位:毫秒。 refreshExpireTime Long 刷新token的失效时间戳,单位:秒。 refreshToken String 刷新token字符串。 refreshValidPeriod Long 刷新token有效时长,单位:秒。 tokenIp String 用户IP。 tokenType Integer token类型。 0:用户ACCESS TOKEN 1:会控TOKEN 2:一次性TOKEN user UserInfo object 用户鉴权信息。 validPeriod Long Token的有效时长,单位:秒。
  • 请求消息示例 POST /v1/usg/acs/token/validate Connection: keep-alive Content-Type: application/json Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "needGenNewToken": false, "needAccountInfo": true, "token": "stbNYluHvordsmyF2Ubt271qDr6WDAVLtLRb" }
  • 请求参数 表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。 token 是 String Body Access Token。 needGenNewToken 是 Boolean Body 是否生成新的token。 true:生成新的token值。 false:不生成新的token值。 needAccountInfo 否 Boolean Body 是否需要返回用户账号信息(账号、用户名称等信息)。
  • 请求消息示例 PUT /v1/mmc/management/conferences?conferenceID=914087436 Connection: keep-alive X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC Content-Type: application/json user-agent: WeLink-desktop Content-Length: 372 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "mediaTypes": "HDVideo", "startTime": "2022-08-30 12:00", "length": 120, "attendees": [ { "accountId": "zhangshan@huawei.com", "appId": "caaab5a3e584497990f6a9b582a0ae42" } ], "subject": "例行会议" }
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -d '{"mediaTypes": "Voice","attendees": [{"name": "user02","role": 1,"phone": "+8657*******"}],"conferenceType": "0","subject": "user02 conference"}' 'https://api.meeting.huaweicloud.com/v1/mmc/management/conferences?conferenceID=914087436'
  • 响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 1157 Connection: keep-alive http_proxy_id: 462abfcfa8a41c2c5450eb7648bf5ad2 Server: api-gateway X-Request-Id: 7ba6f742610c03a64262b126fb336a5d [ { "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": "企业协同云服务项目群" } ]
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 说明: 创建会议时返回的conferenceID。不是vmrConferenceID。 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 是否使用云会议室召开预约会议。默认不使用云会议室。 0:不使用云会议室 1:使用云会议室 说明: vmrFlag不支持修改。 vmrID 否 String Body 绑定给当前创会账号的VMR ID。通过查询云会议室及个人会议ID接口获取。 说明: vmrID不支持修改。 concurrentParticipants 否 Integer Body 会议方数,会议最大与会人数限制。 0:无限制 大于0:会议最大与会人数 supportSimultaneousInterpretation 否 Boolean Body 会议是否支持同声传译 true:支持 false:不支持
  • 响应消息示例 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 { "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 } ] }
  • 请求消息示例 GET /v1/usg/dcs/corp/member/3e48b79b660e403cb5e0208f7be83961?accountType=0 Connection: keep-alive X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
  • 响应参数 表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。
  • 响应消息示例 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": [ { "count": 10, "editable": true, "expireDate": 2549030400000, "id": "b974dfbe2daf456880afd10c80d12c9f", "status": 0, "type": "VMR", "typeDesc": null, "typeId": "ff808081699b56cb0169c411a0980152" } ], "limit": 5, "offset": 0 }
  • 请求消息示例 GET /v1/usg/dcs/sp/corp/818803911/resource?offset=0&limit=5&searchKey=&startExpireDate=&endExpireDate=&type=&typeId=&status=0 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)
  • CURL命令示例 curl -k -i -X GET -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' https://api.meeting.huaweicloud.com/v1/usg/dcs/sp/corp/818803911/resource?offset=0&limit=5&searchKey=&startExpireDate=&endExpireDate=&type=&typeId=&status=0
  • 响应参数 表4 响应参数 参数 类型 描述 count Integer 总数量。 limit Integer 每页显示的条目数量。 默认值:10。 offset Integer 页面起始页,从0开始。 data Array of QueryResourceResultDTO objects 分页查询企业用户信息。 表5 QueryResourceResultDTO 数据结构 参数 类型 描述 count Integer 资源数量。 editable Boolean 标识资源是否可以编辑或删除,为false时,前台需要屏蔽操作按钮。 expireDate Long 到期时间,utc时间戳。 id String 唯一标识若携带则以携带为准,企业内保证唯一,否则后台自动生成UUID。 status Integer 资源状态: 0:正常 1:到期 2:停用 type String 资源类型。 VMR - 云会议室 CONF_CALL - 会议并发数 HARD_1080P - 1080P硬终端 HARD_720P - 720P硬终端 SOFT - 软终端用户数 ROOM - 大屏软终端 LIVE - 直播推流 RECORD - 录播空间 HARD_THIRD_PARTY - 第三方硬终端账号 HUAWEI_VISION -智慧屏 IDEA_HUB - ideahub typeDesc String 资源标识对应的回显描述,比如资源类型为VMR ,则该参数为vmrPkgName。 typeId String 资源标识,比如资源类型为VMR ,则该参数为vmrPkgId。 vmrMode Integer VMR模式。 0:个人会议ID 1:云会议室 2:网络研讨会 orderId String 资源对应的订单id。
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 corp_id 是 String Path 企业id。 offset 否 Integer Query 查询偏移量,若超过最大数量,则返回最后一页。 默认值:0 limit 否 Integer Query 查询数量。 默认值:10 searchKey 否 String Query 搜索条件。 startExpireDate 否 Integer Query 查询过期时间在该时间戳之后的资源项。 endExpireDate 否 Integer Query 查询过期时间在该时间戳之前的资源项。 type 否 String Query 资源类型。 typeId 否 String Query 资源类型Id,若想搜索5方VMR时,需携带5方vmrpkg对应的id。 status 否 Integer Query 资源状态: 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。
  • 修订记录 表1 修订记录 日期 版本 修订内容 2022-11-11 28 新增申请联席主持人、批量举手、准入等候室、移入等候室、允许客户端录制、查询多画面布局、保存多画面布局、删除多画面布局。 2022-03-30 27 新增激活会议。 2021-09-26 26 新增SSO登录配置和主持人邀请与会者打开/关闭摄像头。 2021-09-10 25 新增周期性会议接口:创建周期性会议、取消周期性会议、取消周期性会议的子会议、编辑周期性会议、编辑周期性会议的子会议。 新增会场挂断原因事件推送:邀请结果信息推送。 2021-08-28 24 新增企业级会议事件推送。 2021-08-25 23 新增仪表盘的会议统计。 2021-08-06 22 如下几个接口的由于参数填写错误导致的错误响应从500修改为403: /v1/mmc/control/conferences/record /v1/mmc/control/conferences/participants/mute /v1/mmc/control/conferences/participants/rollCall /v1/mmc/control/conferences/participants/broadcast /v1/mmc/control/conferences/participants/role 2021-06-10 21 新增如下章节: 网络研讨会管理:支持第三方应用通过接口创建网络研讨会。 企业管理员分页查询企业资源订单列表:支持企业管理员根据条件查询企业资源订单列表 2021-05-11 20 新增如下章节: 查询录制文件下载链接:支持有管理员权限的账号查询某个会议录制文件下载链接 会议仪表盘: 面向第三方应用,提供查询会议、与会者、以及QoS数据的操作 2021-02-09 19 新增如下章节: 会议事件推送:第三方应用可以通过Websocket接口订阅某个会议的信息 2020-09-22 18 新增如下章节: 执行App ID鉴权:提供App ID鉴权功能。 2020-09-01 17 新增如下章节: 会议纪要:对会议纪要的管理,包括打开会议纪要文件列表、保存会议纪要到个人云空间、查询会议纪要列表、查询会议纪要详情功能。 2020-07-21 16 新增如下章节: 信息窗:提供信息窗素材管理功能。 信息窗节目管理:提供信息窗节目管理功能。 信息窗发布管理:提供信息窗发布管理功能。 2020-05-13 15 新增如下章节: SP管理员创建企业:提供SP管理员创建企业功能。 SP管理员删除企业:提供SP管理员删除企业功能。 SP管理员修改企业:提供SP管理员修改企业功能。 SP管理员分页搜索企业:提供SP管理员分页搜索企业功能。 企业资源管理:提供SP管理员对企业资源管理功能。 2020-04-15 14 会议控制新增章节会场选看、锁定会场视频源。 2020-04-14 13 查询录播文件、批量删除录制文件、查询历史会议信息、查询历史会议的会控记录信息、查询历史会议的与会者记录信息、一键入会鉴权章节由会议控制目录移动到会议管理目录; 2020-04-09 12 修改: 普通登录鉴权业务流程:增加应用场景描述 WeLink 代理登录鉴权业务流程:增加应用场景描述 企业管理、企业部门管理、用户管理、企业管理员管理、用户密码管理、查询企业通讯录增加接口参考章节,其中所有接口移到接口参考章节中。 新增每类接口业务的应用场景描述和开发过程指导: 企业注册信息、资源和业务权限管理应用场景 部门管理应用场景 个人信息管理应用场景 企业用户管理应用场景 企业管理员管理应用场景 个人密码修改应用场景 个人密码重置应用场景 企业用户密码重置应用场景 企业通讯录查询应用场景 2020-02-29 11 新增如下章节: WeLink 代理登录鉴权业务流程:提供WeLink代理鉴权业务流程图及具体流程步骤。 校验Token:提供校验token合法性功能。 WeLink代理鉴权:提供WeLink三方代理鉴权功能。 修改: 查询企业通讯录:修改响应参数章节。 删除接口: 执行第三方鉴权。 2020-02-12 10 新增如下章节: 云会议室管理:对云会议室的管理,包括云会议室的查询、删除、分配、回收以及个人用户关联的云会议室的查询和修改功能。 2019-12-24 09 修改: 所有接口URL及部分接口请求方法进行了规范性整改; 除执行鉴权接口外,其余接口鉴权头域由Authorization改为X-Access-Token,并且不需Base64转码; 返回值正常统一为200,并且消息内容中删除returnCode及returnMessage字段; 注销登录、企业管理员修改企业注册信息、修改部门、删除部门、修改用户、批量删除用户、批量修改用户状态、用户修改自己的信息、获取验证码、校验手机和邮箱对应的验证码、修改手机或邮箱、添加企业管理员、批量删除企业管理员、修改终端、批量删除终端、批量修改终端状态、重置激活码、修改密码、企业管理员重置企业成员密码、用户重置密码、取消预约会议、邀请与会者、与会者离开会议、删除与会者、申请/释放主持人、静音/取消静音、全场静音/取消全场静音、举手/取消举手、锁定/解锁会议、延长会议、结束会议、设置多画面、切换会议显示策略、主持人选看视频画面、启动/停止会议录制、启动/停止会议直播、重命名会场、点名会场、广播会场、批量删除录制文件接口正常返回200后不再有Body体; 分页查询用户、分页查询企业管理员、分页查询终端、查询企业通讯录、查询会议列表、查询会议信息、查询在线会议列表、查询在线会议信息、查询录播文件列表、查询历史会议列表、查询历史会议信息、查询历史会议的会控记录信息、查询历史会议的与会者记录信息接口请求参数位置改成在URL中,返回信息中参数pageIndex、pageSize、totalCount相应地改为offset、limit、count; ModCorpBasicInfoDTO 数据结构增加参数:autoUserCreate; QueryCorpResDetailResultDTO 数据结构增加参数:enableHybridCloud; DeptDTO 数据结构增加参数:inPermission、outPermission、designatedOutDeptCodes; MemberDTO 数据结构增加参数:englishName、signature、title、desc; QueryDeptResultDTO 数据结构增加参数:inPermission、outPermission、designatedOutDeptCodes; 查询企业通讯录参数searchScope修改枚举值; VerifyCodeSendDTOV1 数据结构删除language与checkType; ResetPwdReqDTOV1 数据结构删除language; 取消预约会议、修改预约会议、查询会议信息、查询在线会议信息、获取会控Token、查询会议实时信息、邀请与会者、与会者离开会议、删除与会者、申请/释放主持人、静音/取消静音、全场静音/取消全场静音、举手/取消举手、锁定/解锁会议、延长会议、结束会议、设置多画面、切换会议显示策略、主持人选看视频画面、启动/停止会议录制、启动/停止会议直播、重命名会场、点名会场、广播会场、查询录播文件、批量删除录制文件、查询历史会议信息、查询历史会议的会控记录信息、查询历史会议的与会者记录信息、一键入会鉴权接口URL请求参数位置改在query中; Attendee数据结构增加参数:deptUUID、supportSVC、isTruckNum; ConfConfigInfo数据结构增加参数:videoConfMode、inviteMode、prolongLength、isAutoMute; 取消预约会议、修改预约会议、查询会议列表、查询会议信息、查询在线会议列表、查询在线会议信息、查询录播文件列表、查询录播文件、批量删除录制文件、查询历史会议列表、查询历史会议信息、查询历史会议的会控记录信息、查询历史会议的与会者记录信息接口请求头域增加X-Authorization-Type; 与会者离开会议请求方法由DELETE修改为POST,且增加body; 删除与会者请求方法由DELETE修改为POST,且增加body; 静音/取消静音、全场静音/取消全场静音的body数据结构增加allowUnmuteByOneself参数; 删除资源下载、快速体验Demo、Demo环境安装及配置、Java启动端口占用、执行cnpm install命令下载软件包、删除录播文件章节。 2019-09-30 08 修改: 所有接口的取值增加默认值以及填写的格式要求,提供更明确的参数取值说明。 2019-08-30 07 新增如下章节: 查询设备状态:提供终端状态查询功能,供第三方应用集成实现状态查询的业务功能。 修改如下章节: 查询会议实时信息:增加数据结构RealTimeConfInfo。 企业管理员查询企业注册信息:增加参数autoUserCreate。 添加用户:增加body体:id、englishName、function、sortLevel、hidePhone,QueryUserResultDTO增加参数:englishName、title、desc、function。 获取验证码:增加参数verificationCode。 增加终端:增加参数prjCodeMode。 修改终端:增加参数prjCodeMode。 查询终端详情:增加参数prjCodeMode。 查询企业通讯录:数据结构UserDTO增加参数statusCode、englishName、vmrId、signature、title、description。 添加企业管理员:增加参数menuTemplateId。 修改企业管理员:增加参数menuTemplateId。 分页查询企业管理员:请求参数添加sortField、isAsc。 校验滑块验证码:请求参数clientType增加“18:workplace mobile”。 2019-07-29 06 新增如下章节: 查询在线会议列表:提供查询在线会议列表功能,供第三方应用集成实现查询在线会议列表的业务功能。 查询在线会议信息:提供查询在线会议信息功能,供第三方应用集成实现查询在线会议信息的业务功能。 举手/取消举手:提供举手/取消举手功能,供第三方应用集成实现举手/取消举手的业务功能。 延长会议:提供延长会议功能,供第三方应用集成实现延长会议的业务功能。 主持人选看视频画面:提供主持人选看视频画面功能,供第三方应用集成实现选看视频画面的业务功能。 启动/停止会议直播:提供启动/停止会议直播功能,供第三方应用集成实现启动/停止会议直播的业务功能。 2019-06-29 05 新增如下章节: 查询会议实时信息:提供企业用户查询会议实时信息。 修改如下章节: 开发环境准备:增加了需要先注册华为云账号的提醒。 2019-06-03 04 新增如下章节: 企业成员忘记密码:提供企业用户在忘记密码后,重置密码功能。 企业管理员重置企业成员密码:提供企业管理员重置企业成员密码的功能。 2019-05-09 03 新增如下章节: 快速体验Demo:提供第三方应用实现快速体验Demo的功能。 FAQ:提供常见FAQ的解决方法。 新增如下接口: 企业通讯录:提供查询企业通讯录的开放,供第三方应用集成实现查询企业通讯录业务功能。 删除如下章节: 快速入门 2019-04-30 02 新增如下接口: 企业部门管理接口:提供企业部门管理能力的开放,供第三方应用集成实现创建企业部门等业务功能。 用户管理接口:提供企业用户能力的开放,供第三方应用集成实现开户等业务功能。 企业管理员管理接口:提供企业管理员管理能力的开放,供第三方应用集成实现管理员管理等业务功能。 硬终端管理接口:提供硬终端管理能力的开放,供第三方应用集成实现硬终端管理等业务功能。 新增每类接口业务的应用场景描述和开发过程指导。 登录鉴权应用场景 一键入会应用场景 基本会控应用场景 视频会控应用场景 会议录播应用场景 2019-03-31 01 第一次正式发布。
  • 请求消息示例 POST /v1/usg/acs/verifycode/send Connection: keep-alive Content-Type: application/json Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "token": "R7PE9vsaEUHjiLsraWTF3WQhmBet16SbI", "user": "+86136********" }
  • 请求参数 表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。 sendMethod 否 String Body 验证码发送方式。 user类型是用户真实账号时必选;如果没有选择的话,优先短信方式。 sms:短信方式 email:邮件方式 token 否 String Body 访问Token字符串。通过校验滑块验证码接口获取。 user 是 String Body 用户身份信息(手机号码或邮箱账号或用户真实账号)。 说明: 必须和发送滑块验证码时带的用户身份信息相同。
  • 响应参数 表4 响应参数 参数 类型 描述 bindEmail String 如果通过邮箱发送验证码,则该字段携带用户绑定的邮箱账号(邮箱账号经过处理,屏蔽中间几位,如tes****ount@huawei.com)。 bindPhone String 如果通过手机发送验证码,则该字段携带该用户绑定的手机号(手机号经过处理,屏蔽中间几位,如+86181****2345)。 expire Integer 过期时间,单位:秒。
  • 响应消息示例 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 { "expire":180, "bindPhone":"+8618*********", "bindEmail":null }
  • API分类 表2 API分类 接口 描述 登录鉴权 获取鉴权、刷新鉴权、注销鉴权及SSO鉴权配置。 会议管理 预约会议、编辑或取消预约会议、查询会议列表及会议信息。创建周期会议、编辑或取消周期会议,编辑或取消周期会议子会议。 会议控制 加入会议后的会控操作,包括添加与会者、静音、多画面设置、申请/释放主持人等基本会控,还包括点名、广播会场、录播等会控操作。 会议事件推送 通过Websocket推送单个指定会议的信息,包括:会议基本信息、会议状态、在线与会者、发言方状态、会议媒体质量状态、实时字幕等。 通过Webhook推送企业级的会议信息,包括:会议开始、会议结束。 仪表盘 会议QoS查询和会议统计信息查询。 网络研讨会 网络研讨会管理,包括预约、编辑、取消、查询网络研讨会及对网络研讨会的高级设置。 企业管理 对企业的管理,包括企业管理员查询、修改企业注册信息,企业管理员查询企业内资源及业务权限以及SP管理员创建、删除、查询、修改,搜索企业等功能。 企业部门管理 企业中部门的添加、修改、删除以及部门信息查询等功能。 用户管理 企业中用户账号的管理,包括添加、修改、删除用户以及查询用户详情、修改用户的手机或邮箱等功能。 企业管理员管理 对企业管理员的管理,包括添加、删除、查询等功能。 硬终端管理 对硬终端的管理,包括硬终端的添加、修改、删除、查询以及重置激活码等功能。 云会议室管理 对云会议室的管理,包括云会议室的查询、删除、分配、回收以及个人用户关联的云会议室的查询和修改功能。 用户密码管理 对企业用户的密码的管理,包括企业用户修改密码、企业用户忘记密码重置、以及企业管理员重置企业成员密码等功能。 查询企业通讯录 企业通讯录的查询功能。 企业资源管理 对企业资源的管理,包括分配、删除、修改、分页查询企业资源以及分页查询企业资源操作记录等功能。 会议纪要 IdeaHub等电子版本上生成的会议纪要内容的管理,包括打开文件列表、保存到个人空间、查询列表、查询详情 信息窗管理 信息窗发布管理: 对信息窗发布的管理,包括新增、删除、查询、修改信息窗发布以及查询信息窗发布详情等功能。 信息窗节目管理: 对信息窗节目的管理,包括新增、删除、查询、修改信息窗节目以及查询信息窗节目详情等功能。 信息窗素材管理: 对信息窗素材的管理,包括新增、删除、更新、分页查询信息窗素材等功能。
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Request-ID: 5162fa32dc7e47afafeee39a72a2eec3,Content-Type: application/json,Accept-Language: zh-CN' -H 'date: 20190329T074551Z' -d '{"clientType":0,"authServerType":"workplace","authType":"AccountAndPwd","pwd":"******","createTokenType":0,"account":"******"}' 'https://api.meeting.huaweicloud.com/v1/usg/acs/auth/proxy'
  • 响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 745 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Expires: Thu, 01 Jan 1970 00:00:00 GMT X-XSS-Protection: 1; mode=block X-Download-Options: noopen X-Content-Type-Options: nosniff strict-transport-security: max-age=16070400; includeSubDomains X-Frame-Options: SAMEORIGIN Content-Security-Policy: default-src 'self' 'unsafe-inline' 'unsafe-eval' blob: data: http: https: ; child-src * ; connect-src * x-request-id: 5162fa32dc7e47afafeee39a72a2eec3 Server: CloudPortal { "accessToken": "stbNxmD2UXEDkHQD73sqMhXB6eXw6ngvSbo9", "clientType": 0, "createTime": 1599102826754, "daysPwdAvailable": -18172, "delayDelete": false, "expireTime": 1577979513, "firstLogin": true, "forceLoginInd": null, "proxyToken": null, "pwdExpired": false, "refreshCreateTime": 1599102826754, "refreshExpireTime": 1601694826, "refreshToken": "stbYaza5VVRr3IGuLSs6ZvF0lMHHvGO0tQ0f", "refreshValidPeriod": 2592000, "tokenIp": "10.8.0.90", "tokenType": 0, "user": { "adminType": 2, "alias1": null, "appId": null, "cloudUserId": "76aaaba8a12f4c0a8a43192...", "companyDomain": null, "companyId": "f5968fc4f9c14d50905e8e66672dabc6", "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:xxxx@huaweicloud.com", "spId": "666bd8558e4646e1a7e1a0c99cf898e8", "status": 0, "thirdAccount": "62fe180o133fd...", "tr069Account": "X3M537A6IX4SC...", "ucloginAccount": "z8b2vo875ioh54r29ad5e3552vb3gm8np2j167...", "userId": "0d5202707123429d876....", "userType": 2, "visionAccount": null, "weLinkUser": false }, "validPeriod": 84616 }
  • 请求参数 表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。 account 否 String Body 认证账号。 maxLength: 255 minLength: 0 authServerType 是 String Body 鉴权服务类型。 workplace:WeLink代理鉴权 oauth2:OAuth2.0鉴权 authType 是 String Body 鉴权类型。 AccountAndPwd:Welink代理鉴权 AuthCode:OAuth2.0鉴权 clientType 是 Integer Body 登录账号类型。 72:API调用类型。 createTokenType 否 Integer Body 是否生成Token。默认0。 0:生成,用于登录鉴权; 1:不生成。 credential 否 String Body OAuth2.0时填从鉴权中心获取的临时Code。 domain 否 String Body 企业域名。OAuth2.0鉴权时需要填写。 pwd 否 String Body 认证密码。Welink代理鉴权时需要填写。 maxLength: 255 minLength: 0 remark 否 String Body 备注信息。
  • 响应参数 表4 响应参数 参数 类型 描述 accessToken String 接入Token字符串。 clientType Integer 登录账号类型。 72:API调用类型; createTime Long 业务token的创建时间戳,单位:毫秒。 daysPwdAvailable Integer 密码有效天数。 delayDelete Boolean 是否延时删除状态。 expireTime Long Token的失效时间戳,单位:秒。 firstLogin Boolean 是否首次登录。 说明: 首次登录表示尚未修改过密码。首次登录时,系统会提醒用户需要修改密码。 默认值:false。 forceLoginInd Integer 抢占登录标识。 0:非抢占 1:抢占(未启用) proxyToken ProxyTokenDTO object 代理鉴权信息。 pwdExpired Boolean 密码是否过期。 默认值:false。 refreshCreateTime Long 刷新token的创建时间戳,单位:毫秒。 refreshExpireTime Long 刷新token的失效时间戳,单位:秒。 refreshToken String 刷新token字符串。 refreshValidPeriod Long 刷新token有效时长,单位:秒。 tokenIp String 用户IP。 tokenType Integer token类型。 0:用户ACCESS TOKEN 1:会控TOKEN 2:一次性TOKEN user UserInfo object 用户鉴权信息。 validPeriod Long Token的有效时长,单位:秒。
  • 请求消息示例 POST /v1/usg/acs/auth/proxy Connection: keep-alive Content-Type: application/json X-Request-ID: 5162fa32dc7e47afafeee39a72a2eec3 Accept-Language: zh-CN Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "clientType": "72", "authServerType": "workplace", "authType": "AccountAndPwd", "pwd": "******", "createTokenType": 0, "account": "******" }
  • 描述 该接口使用第三方的账号进行代理鉴权,鉴权通过后生成一个Access Token。当前支持的第三方代理账号包括: Welink的账号和密码 支持OAuth2.0标准的第三方账号 当clientType取值为72时,同一个account,同时最多能创建64个Token。比如已经创建了64个Token,并且Token都在有效期内,再用同一个account创建一个Token,前64个Token中最早创建的Token将失效。 当clientType取值为非72时,同一个account,同时最多能创建1个Token。 Token有效期是12~24小时。
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9' -d '["test010"]' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/member/status/0?accountType=0
  • 请求消息示例 PUT /v1/usg/dcs/corp/member/status/0?accountType=0 Connection: keep-alive X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9 Content-Type: application/json Content-Length: 11 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) ["test010"]
共100000条