华为云用户手册

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

请求消息示例 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 部门名称。

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

CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token: stb0nPMBk5cKDjKMT9H1QpDHRqvv4XV1acli' -d '{"account":"user001"}' 'https://api.meeting.huaweicloud.com/v1/usg/acs/password/admin/reset'

请求消息示例 PUT /v1/usg/acs/password/admin/reset Connection: keep-alive Content-Type: application/json X-Access-Token: stb0nPMBk5cKDjKMT9H1QpDHRqvv4XV1acli Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_131) { "account": "user001" }

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 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 被修改密码的用户账号。

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 21 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: 43689056504b4ff22663262d44e141aa { "value": "818803911" }

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' -d '{"account": "zhangsan@corp","country": "chinaPR","email": "******","name": "zhangsan","phone": "+86191****9092","pwd": "******","sendNotify": false},"basicInfo": {"address": "浙江杭州","country": "chinaPR","description": "description","domain": "huawei.com","email": "******","fax": "+123456789","language": "zh-CN","name": "华为技术有限公司","phone": "+86191****9092","spId": "","timeZoneId": "56"},"groupId": "297e87ec7713734b01771458c2d80000","resInfo": {"resource": [{"count": 10,"expireDate": 2549030400000,"id": "36f2c0117cf14c3db61a7880eb73cee6","type": "VMR","typeId": "2c90bb2871e577590171e57bfec908b2"}]}}' https://api.meeting.huaweicloud.com/v1/usg/dcs/sp/corp

请求消息示例 POST /v1/usg/dcs/sp/corp Connection: keep-alive X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Content-Type: application/json Content-Length: 561 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "adminInfo": { "account": "zhangsan@corp", "country": "chinaPR", "email": "******", "name": "zhangsan", "phone": "+86191****9092", "pwd": "******" }, "basicInfo": { "address": "浙江杭州", "country": "chinaPR", "description": "description", "domain": "huawei.com", "email": "******", "fax": "+123456789", "language": "zh-CN", "name": "华为技术有限公司", "phone": "+86191****9092", "spId": "", "timeZoneId": "56" }, "groupId": "297e87ec7713734b01771458c2d80000", "resInfo": { "resource": [ { "count": 10, "expireDate": 2549030400000, "id": "36f2c0117cf14c3db61a7880eb73cee6", "type": "VMR", "typeId": "2c90bb2871e577590171e57bfec908b2" } ] } }

使用已购买的专用云会议室资源发起会议 1、使用企业管理员账号，调用企业管理员分页查询企业云会议室接口，可以查询到企业下云会议室资源的信息及分配情况 2、将购买的云会议室分配给指定的会议用户账号，详见分配云会议室 3、登录刚被分配会议室的会议用户账号，调用“创建会议”接口的时候，需要填写vmrFlag和vmrID两个参数，如图3。 ① vmrFlag按照提示填写1即可； ② vmrID为步骤1时查询到的“id”，如图。

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stbH3o4N83uDQPOcFtScKC9nbqCXt3cIDB1U' -d '["test006"]' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/admin/delete?accountType=0

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 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。 [数组元素] 是 Array of strings Body 用户的账号列表。 maxLength：100 minLength：1

请求消息示例 POST /v1/usg/dcs/corp/admin/delete?accountType=0 Connection: keep-alive X-Access-Token: stbH3o4N83uDQPOcFtScKC9nbqCXt3cIDB1U content-type: application/json Content-Length: 13 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) ["test006"]

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

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' -d '{"model": "TE20","name": "test20","deptCode": "1","phone": "+86**********","email": "****@huawei.com","sn": "asdasfscasd","country": "chinaPR"}' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/device

响应参数 表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 终端类型，区分自研和第三方终端。

请求消息示例 POST /v1/usg/dcs/corp/device Connection: keep-alive X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Content-Type: application/json Content-Length: 155 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "model": "TE20", "name": "Hangzhou Z5-3-A29", "deptCode": "1", "phone": "+86**********", "email": "****@huawei.com", "sn": "asdasfscasd", "country": "chinaPR" }

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 164 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: 65c132ec8939a66775df1382e7d35fc9 { "name": "Hangzhou Z5-3-A29", "type": "TE", "model": "TE20", "sn": "asdasfscasd", "account": "df8bce2178294683bb83a4985fef7165", "number": "+991118029589", "prjCodeMode": 0, "deptCode": "1", "deptName": "wangyue", "deptNamePath": "wangyue", "phone": "+86***********", "country": "chinaPR", "email": "****@huawei.com", "description": null, "status": 0 }

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 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。 deptCode 否 String Body 部门编码，默认为根部门。 默认值：1 description 否 String Body 终端描述。 maxLength：128 minLength：0 email 否 String Body 统一邮箱格式。 model 是 String Body 终端型号，枚举类型。当前支持TE系列和部分第三方硬件终端，具体的终端类型可以通过获取所有终端类型接口查询。 name 是 String Body 终端名称，可以自定义，建议为具体位置，方便识别。 maxLength：64 minLength：1 phone 否 String Body 手机号，必须加上国家码，例如中国大陆手机为“+86xxxxxxxxxxx”。当填写手机号时 “country”参数必填。 手机号只允许输入纯数字。 说明： 手机号或者邮箱至少填写一个。 prjCodeMode 否 Integer Body 投影码生成模式，默认为自动。 0：自动 该模式下根据消息上报的IP地址内部控制复杂度。私网地址配置成简单模式，公网地址配置成复杂模式 1：简单 2：复杂 sendNotify 否 string Body 是否发送邮件和短信通知。 0：不发送 不填或者其他值就发送 sn 否 String Body 终端SN码，仅可包含数字、字母和下划线。 status 否 Integer Body 终端状态。默认值：0。 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。 [数组元素] 是 Array of strings Body 所请求查询的终端的号码。

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stbtsadx6U2jBKxODtf3Ylnff5uGZX8mzu1K' -d '["+99*******"]' https://api.meeting.huaweicloud.com/v1/usg/acs/ap/userstatus

响应参数 表4 响应参数 参数 类型 描述 [数组元素] Array of UserStatusDTO 设备状态列表 表5 UserStatusDTO数据结构 参数 类型 描述 CallStatus String 呼叫状态。 0：未上线 1：空闲中 2：使用中 3：非会议硬终端统一的无效值 Number String 终端号码。 RegStatus String 注册状态。 0：已注册 1：未注册

请求消息示例 POST /v1/usg/acs/ap/userstatus Connection: keep-alive X-Access-Token: stbtsadx6U2jBKxODtf3Ylnff5uGZX8mzu1K content-type: application/json Content-Length: 40 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_131) [ "+99*******" ]

响应消息示例 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: a48502799c8d43519ba81502110cf213 [ { "Number": "tel:+991116173924", "RegStatus": "0", "CallStatus": "1" } ]

请求参数 表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。 [数组元素] 是 Array of strings Body 云会议室唯一ID列表。 maxLength：100 minLength：1