华为云用户手册

  • 请求消息示例 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'
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 Accept-Language 否 String Header 语言参数,默认为中文zh-CN,英文为en-US。 subject 是 String Body 网络研讨会主题。长度限制为128个字符。 description 否 String Body 网络研讨会描述。长度限制为1000个字符。 startTime 是 String Body 网络研讨会开始时间(UTC时间),格式“yyyy-MM-dd HH:mm”。 duration 是 Integer Body 网络研讨会持续时长,单位分钟,取值范围[15,1440]。 timeZoneId 是 Integer Body 会议通知中会议时间的时区信息。时区信息,参考时区映射关系。 说明: 举例:“timeZoneID”:"26",则通过华为云会议发送的会议通知中的时间将会标记为如“2021/11/11 星期四 00:00 - 02:00 (GMT) 格林威治标准时间:都柏林, 爱丁堡, 里斯本, 伦敦”。 attendees 否 Array of Attendee objects Body 与会嘉宾列表。 说明: 观众只能自己通过链接或者会议ID+密码加入,不支持被邀请。 notifySetting 否 NotifySetting object Body 网络研讨会通知配置。 vmrID 是 String Body 绑定给当前创建网络研讨会账号的VMR ID。通过查询云会议室及个人会议ID接口获取。 说明: vmrID取上述查询接口中返回的id,不是vmrId 创建网络研讨会时,使用vmrMode=2的VMR guestPasswd 否 String Body 嘉宾密码(4-16位长度的纯数字)。不指定则系统自动生成。 audiencePasswd 否 String Body 观众密码(4-16位长度的纯数字)。不指定则系统自动生成。 callRestriction 否 Boolean Body 入会范围开关。 false:不限制入会范围 true:限制入会范围 scope 否 Integer Body 主持人、嘉宾入会范围 。仅callRestriction设置成true后生效。 0: 所有用户 2: 企业内用户 3: 被邀请用户 audienceScope 否 Integer Body 观众入会范围。仅callRestriction设置成true后生效。 0: 所有用户 2: 企业内用户和被邀请用户 enableRecording 否 String Body 录制是否开启。 Y: 开启 N: 不开启 liveAddress 否 String Body 主流直播推流地址,最大不超过255个字符。若仅填写liveAddress,未填写auxAddress,无人共享时直播画面显示演讲者视图,有人共享时直播画面显示共享屏幕视图。若同时填写了liveAddress和auxAddress,liveAddress对应直播画面显示演讲者视图,auxAddress对应直播画面显示共享屏幕视图。 auxAddress 否 String Body 辅流直播推流地址,最大不超过255个字符。在填写liveAddress后可增加填写auxAddress,liveAddress对应直播画面显示演讲者视图,auxAddress对应直播画面显示共享屏幕视图。 liveUrl 否 String Body 直播观看地址 表3 Attendee 数据结构 参数 是否必须 类型 描述 appId 是 String App ID。如果是APP ID鉴权场景,此项必填。参考“App ID的申请”。 userAccount 否 String 嘉宾的账号。 如果是账号/密码鉴权场景: 选填,表示华为云会议账号ID 如果是APP ID鉴权场景:必填,表示第三方的User ID,同时需要携带参数appId userName 否 String 嘉宾的名称。长度限制为96个字符。 deptName 否 String 部门名称,最大128字符。 phone 否 String 号码。支持SIP号码或者手机号码。 如果是账号/密码鉴权场景:必填 如果是APP ID鉴权场景:选填 说明: 号码可以通过查询企业通讯接口录获取。返回的number是SIP号码,phone是手机号码 填SIP号码系统会呼叫对应的软终端或者硬终端;填手机号码系统会呼叫手机 呼叫手机需要开通PSTN权限,否则无法呼叫 email 否 String 邮件地址。需要发邮件通知时填写。 sms 否 String 短信通知的手机号码。需要发短信通知时填写。 isHardTerminal 否 Boolean 是否硬终端(会议室或硬终端)。 表4 NotifySetting 数据结构 参数 是否必须 类型 描述 enableCalendar 是 String 发送邮件日历是否开启。 Y:开启 N: 不开启 enableSms 是 String 发送短信通知是否开启。 Y:开启 N: 不开启 enableEmail 是 String 发送邮件是否开启。 Y:开启 N: 不开启
  • 业务流程 图1 一键入会流程图 初始化参数,填入API网关接入地址、用户账号等参数。 第三方向网关APIG发起预约会议请求,并传入预约会议初始化参数。 网关APIG接收请求后,向CloudPortal发起预约会议请求。 CloudPortal预约会议成功后,向APIG网关返回会议信息。 网关APIG将收到的会议信息返回给第三方。 预约会议成功后,获取conferenceID以及密码。为了实现链接入会,第三方向网关APIG发起会议鉴权请求。 网关APIG接收请求后,向CloudPortal发送会议鉴权请求。 CloudPortal会议鉴权成功后,向APIG网关返回认证信息。 网关APIG将收到的认证信息返回给第三方,获取鉴权随机数(random)和下一跳url(siteUrl)。 构造华为云会议客户端的自定义URL Protocol,然后拉起华为云会议客户端并加入会议。
  • 预约与会者推送示例 { "data": [{ "mode": 0, "orgID": "44252", "thirdAccount": "zhangsan", "phone": "+86571********", "accountId": "zhangsan", "userUUID": "271682cfdbe14fa9ae3a8b25f7502627", "name": "张三", "role": 1, "isMute": 0, "isAutoInvite": 0, "type": "normal", "deptUUID": "ff808081689de0d901689df549fe0009", "deptName": "department2", "hidePhone": false, "isNotOverlayPidName": false }], "confID": "900487914", "msgID": "23a450f962d111eb980aa1747c1cf8f9", "msgMode": 0, "version": 1611993595059, "createTime": 1611993595059, "action": "AttendeesNotify" }
  • 响应消息示例 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: 551aeb8cafbbaa7bbbdc7b1c76bba8ac
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 accountType 否 Integer Query 账号类型。 0:华为云会议账号。用于账号/密码鉴权方式。 1:第三方User ID,用于App ID鉴权方式。 默认0 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 Accept-Language 否 String Header 语言参数,默认为中文zh-CN,英文为en-US。 [数组元素] 是 Array of strings Body 企业用户账号列表。
  • 请求消息示例 POST /v1/usg/dcs/corp/member/delete?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) ["test963"]
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9' -d '["test963"]' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/member/delete?accountType=0
  • 业务流程 图1 企业注册信息、资源和业务权限管理流程图 第三方通过企业管理员账号、密码登录, 获取Token 。 第三方向网关APIG发送账号鉴权请求。 网关接收请求后,向CloudPortal发送账号鉴权请求。 CloudPortal鉴权通过后返回Token。 网关APIG将Token信息返回给第三方。 为了查询企业注册信息,第三方向网关APIG发送查询企业注册信息请求。 网关接收请求后,向CloudPortal发送获取企业注册信息请求。 CloudPortal返回企业注册信息给网关APIG。 网关APIG将企业注册信息返回给第三方。 为了查询企业内资源及业务权限,第三方向网关APIG发送查询企业内资源及业务权限请求。 网关接收请求后,向CloudPortal发送获取企业内资源及业务权限请求。 CloudPortal返回企业内资源及业务权限信息给网关APIG。 网关APIG将企业内资源及业务权限信息返回给第三方。 为了修改企业注册信息,填入新企业地址等请求参数,第三方携带该参数向网关APIG发送修改企业注册信息请求。 网关接收请求后,向CloudPortal发送获取企业注册信息请求。 CloudPortal收到请求后,修改企业注册信息。 上图的步骤6-16为企业注册信息、资源和业务权限管理接口,且接口调用无顺序要求,根据第三方自身需求进行调用。
  • 响应参数 表4 响应参数 参数 类型 描述 count Integer 总数量。 limit Integer 每页显示的条目数量。 默认值:10 offset Integer 页面起始页,从0开始。 data Array of QueryAdminResultDTO objects 查询企业管理员返回的结果。 表5 QueryAdminResultDTO 参数说明 参数 类型 描述 account String 用户账号(华为云会议账号)。 adminType Integer 管理员类型。 0:默认管理员 1:普通管理员 country String 手机号所属的国家。 dept DeptBasicDTO object 部门基本信息。 email String 邮箱。 id String 用户UUID。 name String 用户名称。 phone String 手机号。 表6 DeptBasicDTO 参数说明 参数 类型 描述 corpId String 企业id。 deptCode String 部门编码。 deptName String 部门名称。 deptNamePath String 部门名称路径。 parentDeptCode String 父部门编码。
  • 请求消息示例 GET /v1/usg/dcs/corp/admin Connection: keep-alive X-Access-Token: stbH3o4N83uDQPOcFtScKC9nbqCXt3cIDB1U content-type: application/json Content-Length: 40 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 { "offset": 0, "limit": 10, "count": 1, "data": [ { "id": "ff8080816a024f05016a4e1c2c570a5d", "account": "test006", "name": "test006", "adminType": 1, "email": "******", "phone": null, "country": null, "dept": null } ] }
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 offset 否 Integer Query 查询偏移量,若超过最大数量,则返回最后一页。 limit 否 Integer Query 查询数量。 默认值:10 searchKey 否 String Query 搜索条件,支持名称、手机、邮箱、账号、第三方账号模糊搜索。 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/dcs/corp/device/asdasfscasd Connection: keep-alive X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
  • 响应参数 表4 响应参数 参数 类型 描述 account String 硬终端对应的内置账号。 country String 手机号所属的国家。 deptCode String 部门编码。 deptName String 部门名称。 deptNamePath String 部门名称路径。 description String 终端描述。 email String 邮箱。 model String 终端型号,枚举类型。当前支持TE系列硬件终端,具体的终端类型可以通过获取所有终端类型接口查询。 name String 终端名称。 number String 终端绑定的号码。 phone String 手机号。 prjCodeMode Integer 投影码生成模式。 0:自动 该模式下根据消息上报的IP地址内部控制复杂度。私网地址配置成简单模式,公网地址配置成复杂模式。 1:简单 2:复杂 sn String 终端SN号,仅可包含数字、字母和下划线。 status Integer 终端状态。 0:正常 1:冻结 type String 终端类型,区分自研和第三方终端。
  • 响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 407 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: efa03c0b6cb71b96129744f5a1a8a736 { "name": "test", "type": "TE", "model": "TE20", "sn": "asdasfscasd", "account": "df8bce2178294683bb83a4985fef7165", "number": "+991118029589", "prjCodeMode": 0, "deptCode": "1", "deptName": "wangyue", "deptNamePath": "wangyue", "phone": "+86***********", "country": "chinaPR", "email": "******", "description": "test", "status": 0 }
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 sn 是 String Path 终端SN号,仅可包含数字、字母和下划线。 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/dcs/sp/resource?queryGroup=true Connection: keep-alive X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
  • 响应消息示例 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: 439e8b710378987ffc5eb844b5e5c297 { "confCallCount": { "expiredCount": 0, "expiringCount": 0, "sumCount": 20, "trialCount": 0, "usedCount": 6 }, "corpCount": { "expiredCount": 0, "expiringCount": 0, "sumCount": 1, "trialCount": 0, "usedCount": 0 }, "enablePstn": true, "enable SMS ": true, "hwVisionCount": { "expiredCount": 0, "expiringCount": 0, "sumCount": 2, "trialCount": 0, "usedCount": 0 }, "ideaHubCount": { "expiredCount": 0, "expiringCount": 0, "sumCount": 0, "trialCount": 0, "usedCount": 0 }, "liveCount": { "expiredCount": 0, "expiringCount": 0, "sumCount": 20, "trialCount": 0, "usedCount": 6 }, "recordCapability": { "expiredCount": 0, "expiringCount": 0, "sumCount": 20, "trialCount": 0, "usedCount": 5 }, "roomCount": { "expiredCount": 0, "expiringCount": 0, "sumCount": 20, "trialCount": 0, "usedCount": 4 }, "te1080pHardCount": { "expiredCount": 0, "expiringCount": 0, "sumCount": 20, "trialCount": 0, "usedCount": 1 }, "te720pHardCount": { "expiredCount": 0, "expiringCount": 0, "sumCount": 20, "trialCount": 0, "usedCount": 2 }, "teSoftCount": { "expiredCount": 0, "expiringCount": 0, "sumCount": 20, "trialCount": 0, "usedCount": 3 }, "thirdPartyHardCount": { "expiredCount": 0, "expiringCount": 0, "sumCount": 20, "trialCount": 0, "usedCount": 7 }, "groupList": [ { "groupId": "297e87ec7713734b01771458c2d80000", "groupName": "测试分组", "groupType": 3, "regionId": "393e8fec7413734b01s71458c2d80s01", "remarks": "测试", "status": 0 } ] }
  • 响应参数 表4 响应参数 参数 类型 描述 confCallCount ResDetailDTO object 会议并发方数。 corpCount ResDetailDTO object 企业总数。 enablePstn Boolean 在创建企业的时候设置的pstn权限开关。 enableSMS Boolean 企业是否通过短信形式发送会议通知。 groupList Array of QueryCorpGroupDTO objects SP管理员绑定的分组列表。 hwVisionCount ResDetailDTO object 智慧屏TV接入数。 ideaHubCount ResDetailDTO object IdeaHub接入数。 liveCount ResDetailDTO object 推流并发方数。 recordCapability ResDetailDTO object 录播存储空间 (单位:G)。 roomCount ResDetailDTO object 电子白板(SmartRooms)接入数。 te1080pHardCount ResDetailDTO object 1080P硬终端接入数。 te720pHardCount ResDetailDTO object 720P硬终端接入数。 teSoftCount ResDetailDTO object 软终端账号数。 thirdPartyHardCount ResDetailDTO object 第三方硬终端接入数。 表5 QueryCorpGroupDTO 数据结构 参数 类型 描述 groupId String 媒体接入分组id。 groupName String 分组名称。 groupType Integer 分组类型。 regionId String 区域ID,仅服务列表类型场景必填。 remarks String 分组备注信息。 status Integer 分组状态。 0: 正常 1: 停用,服务列表类型停用后创建企业就不会再自动分配到该分组
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 queryGroup 否 Boolean Query 是否在查询资源信息时返回媒体接入分组id,默认不查询。 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 Accept-Language 否 String Header 语言参数,默认为中文zh-CN,英文为en-US。
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token:cnr1510zTBhrfUsymQ0srhW2RYS99r9G5SQoTLWN' -d '{"mediaTypes": "HDVideo","cycleParams": {"startDate": "2021-09-01","endDate": "2021-09-02","cycle": "Day","preRemindDays": 1}}' 'https://api.meeting.huaweicloud.com/v1/mmc/management/cycleconferences?conferenceID=986256843'
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 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) 格林威治标准时间:都柏林, 爱丁堡, 里斯本, 伦敦”。 非周期会议,如果会议通知是通过第三方系统发送,则这个字段不用填写。 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 说明: vmrFlag不支持修改。 vmrID 否 String Body 绑定给当前创会账号的VMR ID。通过查询云会议室及个人会议ID接口获取。 说明: vmrID不支持修改。 concurrentParticipants 否 Integer Body 会议最大与会人数。默认值0。 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: 2164 Connection: keep-alive http_proxy_id: 462abfcfa8a41c2c5450eb7648bf5ad2 Server: api-gateway X-Request-Id: 7ba6f742610c03a64262b126fb336a5d [ { "conferenceID": "986256843", "mediaTypes": "HDVideo,Data,Voice", "subject": "Conference Topic", "size": 0, "timeZoneID": "56", "startTime": "2021-09-01 08:46", "endTime": "2021-09-01 09:16", "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": "ff1cf7020a3711ecbe71e167f3b9d5b1", "conferenceID": "986256843", "startTime": "2021-09-01 08:46", "endTime": "2021-09-01 09:16", "mediaType": "HDVideo,Data,Voice", "isAutoRecord": 0, "recordAuthType": 2, "confConfigInfo": { "callInRestriction": 0, "audienceCallInRestriction": 0, "allowGuestStartConf": true, "enableWaitingRoom": false } }, { "cycleSubConfID": "ff1cf7030a3711ecbe7183f6162d654d", "conferenceID": "986256843", "startTime": "2021-09-02 08:46", "endTime": "2021-09-02 09:16", "mediaType": "HDVideo,Data,Voice", "isAutoRecord": 0, "recordAuthType": 2, "confConfigInfo": { "callInRestriction": 0, "audienceCallInRestriction": 0, "allowGuestStartConf": true, "enableWaitingRoom": false } } ] } ]
  • 请求消息示例 PUT /v1/mmc/management/cycleconferences?conferenceID=914087436 Connection: keep-alive X-Access-Token: cnr1510zTBhrfUsymQ0srhW2RYS99r9G5SQoTLWN 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", "cycleParams": { "startDate": "2021-09-01", "endDate": "2021-09-02", "cycle": "Day", "preRemindDays": 1 } }
共100000条