华为云用户手册

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 participantID 是 String Query 与会者标识。 X-Conference-Authorization 是 String Header 会控Token，通过获取会控token接口获得。 applyChair 是 Integer Body 1：申请主持人 0：释放主持人 chairmanPwd 否 String Body 当申请主持人时，携带主持人密码。

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 39 Connection: keep-alive http_proxy_id: 8e6fe9e1d0a45e33398f426a227e855a Server: api-gateway X-Request-Id: 8957e54c2881f52125edd6439995fbf7

CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' -d '{"applyChair":0}' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/participants/role?conferenceID=914083136&participantID=d2c3ae64216e11eabc510dc9b62e3a80

请求消息示例 PUT /v1/mmc/control/conferences/participants/role?conferenceID=914083136&participantID=d2c3ae64216e11eabc510dc9b62e3a80 Connection: keep-alive X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb Content-Type: application/json user-agent: WeLink -desktop Content-Length: 22 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "applyChair": 1, "chairmanPwd": "******" }

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 39 Connection: keep-alive http_proxy_id: 8e6fe9e1d0a45e33398f426a227e855a Server: api-gateway X-Request-Id: 8957e54c2881f52125edd6439995fbf7

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' -d '{"bulkDelAttendInfo":[{"number":"+991116003815","participantID":"ba9acb1e216d11eabc5165c2b91ad427"}]}' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/attendees/delete?conferenceID=914083136

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 X-Conference-Authorization 是 String Header 会控Token，通过获取会控token接口获得。 bulkDelAttendInfo 是 Array of DelAttendInfo objects Body 待删除会场列表。 表3 DelAttendInfo参数说明 参数 是否必须 类型 位置 描述 number 是 String Body 会场号码。 participantID 否 String Body 与会者标识，已入会的必须填写该字段。

请求消息示例 POST /v1/mmc/control/conferences/attendees/delete?conferenceID=914083136 Connection: keep-alive X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb user-agent: WeLink-desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "bulkDelAttendInfo": [ { "number": "+991116003815", "participantID": "ba9acb1e216d11eabc5165c2b91ad427" } ] }

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' -d '{"bulkHangUpParticipants":["ba9acb1e216d11eabc5165c2b91ad427"]}' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/participants/delete?conferenceID=914083136

请求消息示例 POST /v1/mmc/control/conferences/participants/delete?conferenceID=914083136 Connection: keep-alive X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb user-agent: WeLink-desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "bulkHangUpParticipants": [ "ba9acb1e216d11eabc5165c2b91ad427" ] }

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 X-Conference-Authorization 是 String Header 会控Token，通过获取会控token接口获得。 bulkHangUpParticipants 是 String[1..*] Body 批量挂断会场列表，列表元素为与会者标识。 说明： 与会者标识可通过查询会议实时信息接口获得。

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 39 Connection: keep-alive http_proxy_id: 03b6db0b6804090f93fa80d4c1ed6c13 Server: api-gateway X-Request-Id: bd6c09db2be3f986c2382c01deb240e6

请求消息示例 POST /v1/mmc/control/conferences/participants?conferenceID=914083136 Connection: keep-alive X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb Content-Type: application/json user-agent: WeLink-desktop Content-Length: 175 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "attendees": [ { "name": "上海分会场", "role": 1, "phone": "+8657*******", "type": "normal" }] }

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 39 Connection: keep-alive http_proxy_id: b77bb5478e0b1fc0dbbb4e8d4e26ba65 Server: api-gateway X-Request-Id: 479fdc1d80e2e7ae19c4a08c28821822

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' -d '{"attendees":[{"name":"user01","role":0,"phone":"+8657*******"}]}' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/participants?conferenceID=914083136

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 X-Conference-Authorization 是 String Header 会控Token，通过获取会控token接口获得。 attendees 是 Array of attendee objects Body 邀请的与会者列表。 表3 attendee数据结构说明 参数 是否必须 类型 描述 userUUID 否 String 与会者的用户UUID。 accountId 否 String 与会者的华为云会议账号。 name 是 String 与会者名称，长度限制为96个字符。 role 否 Integer 会议中的角色。默认为普通与会者。 0：普通与会者 1：会议主持人 phone 是 String 号码。支持SIP号码或者手机号码。 说明： 号码可以通过查询企业通讯接口录获取。返回的number是SIP号码，phone是手机号码 填SIP号码系统会呼叫对应的软终端或者硬终端；填手机号码系统会呼叫手机 呼叫手机需要开通PSTN权限，否则无法呼叫 phone2 否 String 预留字段，取值类型同参数“phone”。 phone3 否 String 预留字段，取值类型同参数“phone”。 email 否 String 邮件地址。 说明： 会中邀请不发会议通知，不用填写。 sms 否 String 短信通知的手机号码。 说明： 会中邀请不发会议通知，不用填写。 type 是 String 终端类型，类型枚举如下： normal：软终端 terminal：硬终端 outside：外部与会人 mobile：用户手机号码 ideahub：ideahub board: 电子白板（SmartRooms）。含Maxhub、海信大屏、IdeaHub B2 hwvision：华为智慧屏TV deptUUID 否 String 部门编码。 deptName 否 String 部门名称。

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 说明： 创建会议时返回的conferenceID。不是vmrConferenceID。 X-Conference-Authorization 否 String Header 会控Token。 说明： 仅会控Token保活场景需要携带 如果会话已过期并且请求中携带了密码，则进行重新鉴权并回复新的会控Token X-Password 是 String Header 会议的主持人密码。 说明： 对于会控Token保活场景，不对主持人密码鉴权。 X-Login-Type 是 Integer Header 请求类型。 1：固定为1。 X-Nonce 否 String Header 用户临时nonce token。

响应参数 表4 响应参数 参数 类型 描述 data data object 会控Token信息。 addressToken String 企业通讯录查询临时Token。 gloablPublicIP String 华为云会议Portal地址。 表5 data数据结构说明 参数 类型 描述 token String 会控Token。有效期半个小时。 说明： 会控Token支持两种使用方式： 后续所有会控接口，都可以直接使用该token，如：X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb。 使用Base64转码使用，转码格式，Basic空格+Base64(token)，示例如下：X-Conference-Authorization:Basic Y25yYjQyNmNhMzgyMWY4YTE4ZTc4ZDU5ZGE1NzJhNDIxNjQ0YzUyZGZkOWE0NzMwMjk4。 tmpWsToken String 会控WebSocket建链鉴权Token。 wsURL String 会控WebSocket建链URL。 role Integer 会议中的角色。 0 ：普通与会者 1 ：会议主持人 expireTime long 会控Token过期时间戳（单位：毫秒）。 userID String 会议预定者的用户UUID。 orgID String 会议所属企业ID。 participantID String 终端请求时，返回终端入会后会场ID。 说明： 该参数将废弃，请勿使用。 confTokenExpireTime Integer 会控Token有效时长（单位秒）。 vmrCurrentConfID String 云会议室会议的当前会议ID。 supportNotifyType Array of strings 会控WebSocket消息推送支持类型。

请求消息示例 GET /v1/mmc/control/conferences/token?conferenceID=914083901 Connection: keep-alive X-Password: ******* X-Login-Type: 1 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: 337 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: 630c3bc684928cfa780860fe6a14f38f Server: api-gateway X-Request-Id: d689482097c019094f8aa41e57e52e8e { "data": { "token": "stb15afe94b97a5cd7f152d5308c420dbdce85beda4a3b39f26", "tmpWsToken": "stba0a69f40a78e50f3789e72386f7da84809fbc86a1400bea5", "wsURL": "wss://119.3.200.83:443", "role": 1, "expireTime": 1576651143250, "userID": "ff808081699b56cb0169be103500012b", "orgID": "15659", "confTokenExpireTime": 1800, "vmrCurrentConfID": "914083901", "supportNotifyType": [ "INCREMENT" ] }, "addressToken": "stbWdPZ2ooVesQTWqZESu7AjVlH9Pv4O1KcQ", "gloablPublicIP": "meeting.huaweicloud.com" }

请求消息示例 GET /v1/mmc/management/conferences/online/confDetail?conferenceID=914083136 Connection: keep-alive X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC user-agent: WeLink-desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 1394 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: 1e4af24ea29c6641dd73e3a6a027f007 Server: api-gateway X-Request-Id: 696def7842d59349fd7e33319dce3e21 { "conferenceData": { "conferenceID": "914083136", "mediaTypes": "Voice,Data,Video", "subject": "user01的会议", "size": 1, "timeZoneID": "56", "startTime": "2019-12-18 07:28", "endTime": "2019-12-18 09:28", "conferenceState": "Created", "accessNumber": "+991117", "language": "zh-CN", "passwordEntry": [ { "conferenceRole": "chair", "password": "******" }, { "conferenceRole": "general", "password": "******" } ], "userUUID": "ff808081699b56cb0169be103500012b", "scheduserName": "user8002", "multiStreamFlag": 1, "conferenceType": 0, "confType": "IMMEDIATELY", "isAutoMute": 1, "isAutoRecord": 0, "chairJoinUri": "https://c.meeting.huaweicloud.com/#/j/914083136/6a30b8b5a325105da031442627828e496f91021ece36405f", "guestJoinUri": "https://c.meeting.huaweicloud.com/#/j/914083136/9505dc3349228b1ce0db8165590cc977bcff89785130fe0d", "recordType": 0, "recordAuxStream": 0, "confConfigInfo": { "prolongLength": 15, "isGuestFreePwd": false, "isSendNotify": true, "isSendSms": true, "isAutoMute": true, "isSendCalendar": true, "callInRestriction": 0, "allowGuestStartConf": true, "isHardTerminalAutoMute": true, "enableWaitingRoom": true }, "vmrFlag": 0, "scheduleVmr": false, "isHasRecordFile": false, "partAttendeeInfo": [ { "phone": "+99111****815", "name": "user01", "type": "normal" } ], "terminlCount": 0, "normalCount": 1, "deptName": "wangyue", "confUUID": "050c7898216811eaa6958bf3bb9ac167" }, "data": { "offset": 0, "limit": 20, "count": 1, "data": [ { "participantID": "+991116003815", "name": "user01", "role": 0, "state": "MEETTING", "attendeeType": "normal", "accountId": "user01" } ] } }

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

请求消息示例 GET /v1/mmc/management/conferences/online Connection: keep-alive X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC user-agent: WeLink-desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 1410 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache http_proxy_id: afebdbf50a938b965304c57d5c15676a Server: api-gateway X-Request-Id: be9dc6ff2eba30835ca2a5dfe2c4914d { "data": [ { "conferenceID": "914083136", "mediaTypes": "Voice,Data,Video", "subject": "user01的会议", "size": 1, "timeZoneID": "56", "startTime": "2019-12-18 07:28", "endTime": "2019-12-18 09:28", "conferenceState": "Created", "accessNumber": "+991117", "language": "zh-CN", "passwordEntry": [ { "conferenceRole": "chair", "password": "******" }, { "conferenceRole": "general", "password": "******" } ], "userUUID": "ff808081699b56cb0169be103500012b", "scheduserName": "user8002", "multiStreamFlag": 1, "conferenceType": 0, "confType": "IMMEDIATELY", "isAutoMute": 1, "isAutoRecord": 0, "chairJoinUri": "https://c.meeting.huaweicloud.com/#/j/914083136/6a30b8b5a325105da031442627828e496f91021ece36405f", "guestJoinUri": "https://c.meeting.huaweicloud.com/#/j/914083136/9505dc3349228b1ce0db8165590cc977bcff89785130fe0d", "recordType": 0, "recordAuxStream": 0, "confConfigInfo": { "prolongLength": 15, "isGuestFreePwd": false, "isSendNotify": true, "isSendSms": true, "isAutoMute": true, "isSendCalendar": true, "callInRestriction": 0, "allowGuestStartConf": true, "isHardTerminalAutoMute": true, "enableWaitingRoom": true }, "vmrFlag": 0, "scheduleVmr": false, "isHasRecordFile": false, "partAttendeeInfo": [ { "phone": "+99111****815", "name": "user01", "type": "normal" } ], "terminlCount": 0, "normalCount": 1, "deptName": "wangyue", "confUUID": "050c7898216811eaa6958bf3bb9ac167" } ], "offset": 0, "limit": 20, "count": 1 }

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 userUUID 否 String Query 用户UUID。 说明： 该参数将废弃，请勿使用。 offset 否 Integer Query 查询偏移量。默认为0。 limit 否 Integer Query 查询数量。默认是20，最大500条。 queryAll 否 Boolean Query 指定是否查询企业下所有用户的会议记录。默认值是false。 true：查询所有用户的在线会议 false：仅查询管理员自己的在线会议 说明： 仅对企业管理员生效。 searchKey 否 String Query 查询条件 。会议主题、会议预约人和会议ID等可作为搜索内容。长度限制为1-128个字符。 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Authorization-Type 否 String Header 标识是否为第三方portal过来的请求。 说明： 该参数将废弃，请勿使用。 X-Site-Id 否 String Header 用于区分到哪个HCSO站点鉴权。 说明： 该参数将废弃，请勿使用。

业务流程 图1 会议录播流程图 传入预约会议初始化参数，如会议类型，与会者信息，自动开启录制，录播类型等参数。 第三方向网关APIG发起预约会议请求，并传入预约会议初始化参数。 网关APIG接收请求后，向CloudPortal发起预约会议请求。 CloudPortal预约会议成功后，向APIG网关返回会议信息。 网关APIG将收到的会议信息返回给第三方，可以获取会议id(conferenceid)。 如果在预约会议时，没有开启自动录制功能，则第三方向网关APIG发起启动/停止会议录制请求。 网关APIG接收请求后，向CloudPortal发送启动/停止会议录制请求，当CloudPortal收到启动/停止会议录制请求后，开始进行录制。 第三方完成录制后，执行结束会议操作，向网关APIG发起结束会议请求。 网关APIG接收请求后，向CloudPortal发送获取结束会议请求，当CloudPortal收到结束会议请求后，结束该会议。 为了获取confuuid，第三方向网关APIG发起查询历史会议列表请求。 网关APIG接收请求后，向CloudPortal发送查询历史会议列表请求。 CloudPortal查询历史会议列表成功后，向APIG网关返回历史会议信息。 网关APIG将收到的历史会议信息返回给第三方，获取confuuid用于查询录播文件。 为了查看及下载录播文件，第三方向网关APIG发起查询录播文件请求。 网关APIG接收请求后，向CloudPortal发送查询录播文件请求。 CloudPortal查询录播文件成功后，向APIG网关返回录播文件信息。 网关APIG将收到的录播文件返回给第三方，第三方根据返回的URL可以在浏览器查看录制文件及下载录播文件。

业务流程 图1 视频会控流程图 传入预约会议初始化参数，如会议类型(选择视频)，与会者信息等参数。 第三方向网关APIG发起预约会议请求，并传入预约会议初始化参数。 网关APIG接收请求后，向CloudPortal发起预约会议请求。 CloudPortal预约会议成功后，向APIG网关返回会议信息。 网关APIG将收到的会议信息返回给第三方。 预约会议成功后，为了获取会控Token，第三方向网关APIG发起通过会议ID/密码登录会议控制请求。 网关APIG接收请求后，向CloudPortal发送获取会控Token请求。 第三方获取会控Token，供接下来视频会控接口调用。 为了获取与会者的particpantID，第三方向网关APIG发起查询在会会场信息请求。 网关APIG接收请求后，向CloudPortal发送查询在场会场信息请求。 第三方获取与会者particpantID，供接下来视频会控接口调用。 上图中序号12-19为视频会控接口，且接口调用无顺序要求，根据第三方自身需求进行调用。 第三方完成相应的视频会控接口调用，执行结束会议操作，向网关APIG发起结束会议请求。 网关APIG接收请求后，向CloudPortal发送获取结束会议请求，当CloudPortal收到结束会议请求后，结束该会议。

业务流程 图1 基本会控流程图 传入预约会议初始化参数，如会议类型，与会者信息等参数。 第三方向网关APIG发起预约会议请求，并传入预约会议初始化参数。 网关APIG接收请求后，向CloudPortal发起预约会议请求。 CloudPortal预约会议成功后，向APIG网关返回会议信息。 网关APIG将收到的会议信息返回给第三方。 预约会议成功后，为了获取会控Token，第三方向网关APIG发起通过会议ID/密码登录会议控制请求。 网关APIG接收请求后，向CloudPortal发送获取会控Token请求。 第三方获取会控Token，供接下来基本会控接口调用。 为了获取与会者的particpantID，第三方向网关APIG发起查询在会会场信息请求。 网关APIG接收请求后，向CloudPortal发送查询在场会场信息请求。 第三方获取与会者particpantID，供接下来基本会控接口调用。 上图的步骤12-25为基本会控接口，且接口调用无顺序要求，根据第三方自身需求进行调用。 第三方完成相应的基本会控接口调用，执行结束会议操作，向网关APIG发起结束会议请求。 网关APIG接收请求后，向CloudPortal发送获取结束会议请求，当CloudPortal收到结束会议请求后，结束该会议。

请求消息示例 请求示例（普通会议） GET /v1/mmc/management/conferences/confDetail?conferenceID=914083136 Connection: keep-alive X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC user-agent: WeLink-desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)