华为云用户手册

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'

请求消息示例 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": "例行会议" }

请求参数 表1 参数说明 参数 是否必须 类型 位置 描述 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 用于区分到哪个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 是否使用云会议室召开预约会议。默认不使用云会议室。 0：不使用云会议室 1：使用云会议室 说明： vmrFlag不支持修改。 vmrID 否 String Body 绑定给当前创会账号的VMR ID。通过查询云会议室及个人会议ID接口获取。 说明： vmrID不支持修改。 concurrentParticipants 否 Integer Body 会议方数，会议最大与会人数限制。 0：无限制 大于0：会议最大与会人数 supportSimultaneousInterpretation 否 Boolean Body 会议是否支持同声传译 true：支持 false：不支持 confResType 否 Integer Body 会议资源类型,此参数创建后不支持修改: 0: 并发 1: 云会议室 2: 网络研讨会 3: 预留模式,暂未开放

响应示例 状态码： 200 响应成功 { "offset" : 0, "limit" : 5, "count" : 1, "data" : [ { "otherNumber" : "", "otherNumberCountry" : "", "country" : "chinaPR", "phone" : "+86135xxxx0611", "email" : "******", "corpName" : null, "deptName" : null, "position" : null, "address" : null, "remarks" : null, "id" : "af4aaae4b29d45649e3c61f48ee2f64b", "name" : "李四", "customNumber" : null, "type" : "CORP", "updateTime" : 1665994358499 } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 offset Integer 页面起始页，从0开始。 limit Integer 每页显示的条目数量。 默认值：10。 count Integer 总数量。 data Array of ExternalContactDTO objects 分页查询外部联系人信息。 表4 ExternalContactDTO 参数 参数类型 描述 otherNumber String 其他号码。 说明： 其他号码必须以国家码作为前缀 otherNumber填写时，otherNumberCountry也必须填写 如果要清空手机号配置，则otherNumberCountry和otherNumber都要置为"" 最小长度：0 最大长度：32 otherNumberCountry String 手机号所属的国家 。 最小长度：0 最大长度：32 country String 手机号所属的国家。 缺省值：chinaPR 最大长度：255 phone String 手机号。 说明： 手机号必须以国家码作为前缀 phone填写时，country也必须填写 如果要清空手机号配置，则country和phone都要置为"" 最小长度：0 最大长度：32 email String 邮箱。 最小长度：0 最大长度：255 corpName String 公司名称。 最小长度：0 最大长度：64 deptName String 部门。 最小长度：0 最大长度：64 position String 职务。 最小长度：0 最大长度：64 address String 个人地址。 最小长度：0 最大长度：1024 remarks String 备注。 最小长度：0 最大长度：1024 id String 外部联系人UUID。 name String 姓名。 customNumber String 外部联系人自定义号码。 说明： 仅VDC场景下使用。 updateTime Number 用户信息最后更新时间戳。 type String 外部联系人类型。 PERSONAL：个人外部联系人 CORP：企业外部联系人

请求参数 表1 Query参数 参数 是否必选 参数类型 位置 描述 offset 否 Integer Query 查询偏移量,若超过最大数量，则返回最后一页的数据。 默认值：0。 最小值：0 缺省值：0 limit 否 Integer Query 查询数量。 默认值：10。 最小值：1 最大值：500 缺省值：10 searchKey 否 String Query 搜索条件。支持名称、手机、邮箱模糊搜索。 最小长度：0 最大长度：1024 searchScope 否 String Query 搜索范围。默认值为ALL。 PERSONAL - 查询个人外部联系人 CORP - 查询企业外部联系人 ALL - 查询所有外部联系人 缺省值：ALL

响应消息示例 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: 0873ec5cc25941897758f4accbbe8480 Server: api-gateway X-Request-Id: 0d29eb126a52b0ad7ebf3df6517e7476

请求消息示例 PUT /v1/mmc/control/conferences/participants/broadcast?conferenceID=914044873&participantID=f131536e21ff11eab12735e1cddf6d01 Connection: keep-alive X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb content-type: application/json user-agent: WeLink-desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' 'https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/participants/broadcast?conferenceID=914044873&participantID=f131536e21ff11eab12735e1cddf6d01'

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

请求消息示例 POST /v1/mmc/management/webhook/link-config 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) { "corpId": "1387317060", "subscriberId": "12345678", "subscriberKey": "123465", "url": "https://meeting.huaweicloud.com" }

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -d '{"corpId": "1387317060","subscriberId": "12345678","subscriberKey": "123465","url": "https://meeting.huaweicloud.com"}' 'https://api.meeting.huaweicloud.com/v1/mmc/management/webhook/link-config'

请求参数 表1 参数说明 名称 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 corpId 否 String Body 企业ID。按企业注册回调时需要填写。 spId 否 String Body SP ID。多租户场景下，按SP注册回调时需要填写。 subscriberId 是 String Body 订阅者ID subscriberKey 是 String Body 订阅者密钥 url 是 String Body 订阅url。 说明： 必须使用HTTPS。

请求消息示例 POST /v1/usg/sss/programs Connection: keep-alive X-Access-Token: cnrfzn5OLRjwoaOf2F7PfMwVjJ6zScFogbDE content-type: application/json Content-Length: 128 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)) { "programItemList": [ { "materialId": "dcf8988212414ecba07368ed1d5f8916", "playTime": 10 } ], "programName": "kY234TVnlL" }

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stbH3o4N83uDQPOcFtScKC9nbqCXt3cIDB1U' -d '{"programItemList": [{"materialId": "dcf8988212414ecba07368ed1d5f8916","playTime": 10}],"programName": "kY234TVnlL"}' https://api.meeting.huaweicloud.com/v1/usg/sss/programs

请求参数 表1 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。 programName 是 String Body 节目名称。 programItemList 是 Array of ProgramItemRequestBase objects Body 节目素材列表。 表2 ProgramItemRequestBase 数据结构 参数 是否必须 类型 位置 描述 materialId 是 String Body 素材ID。 playTime 是 Integer Body 播放时长。

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

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

请求参数 表1 参数说明 参数 是否必须 类型 位置 描述 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

请求消息示例 GET /v1/mmc/management/conferences/history/confDetail?confUUID=9a0fa6d10a5b11eaae5e191763c22c0e 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)

CURL命令示例 curl -k -i -X GET -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' 'https://api.meeting.huaweicloud.com/v1/mmc/management/conferences/history/confDetail?confUUID=9a0fa6d10a5b11eaae5e191763c22c0e'

请求参数 表1 参数说明 参数 是否必须 类型 位置 描述 confUUID 是 String Query 会议UUID。 offset 否 Integer Query 查询偏移量。默认为0。针对PageParticipant 中的与会者分页。 limit 否 Integer Query 查询数量。默认值20。 searchKey 否 String Query 查询条件 。会议主题、会议预约人和会议ID等可作为搜索内容。长度限制为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 用于区分到哪个HCSO站点鉴权。 说明： 该参数将废弃，请勿使用。

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 1816 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: b74350ba75078e9ad1ec3610f2ec5550 Server: api-gateway X-Request-Id: e71ece483fad1f909dd45c796af8360 { "conferenceData": { "conferenceID": "914083388", "mediaTypes": "Data,Voice,Video", "subject": "user8001测试会议", "size": 1, "timeZoneID": "56", "startTime": "2019-11-18 23:31", "endTime": "2019-11-18 23:32", "accessNumber": "+991117", "language": "zh-CN", "passwordEntry": [ { "conferenceRole": "chair", "password": "******" }, { "conferenceRole": "general", "password": "******" } ], "userUUID": "ff8080816a024f05016a4e2342480a60", "scheduserName": "test008", "multiStreamFlag": 1, "conferenceType": 0, "confType": "IMMEDIATELY", "isAutoMute": 1, "isAutoRecord": 0, "chairJoinUri": "https://c.meeting.huaweicloud.com/#/j/914083388/69a5b84756d19dc9a222805819ec68945f8d86369d966d43", "guestJoinUri": "https://c.meeting.huaweicloud.com/#/j/914083388/1f215673e636444b55845ee1d1af630e8d8ca0235e491972", "recordType": 0, "recordAuxStream": 0, "recordAuthType": 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****380", "name": "user8002", "type": "normal" } ], "terminlCount": 0, "normalCount": 1, "deptName": "wangyue" }, "data": { "offset": 0, "limit": 20, "count": 1, "data": [ { "participantID": "+991116004380", "name": "user8002", "role": 1, "state": "MEETTING", "attendeeType": "normal", "accountId": "user8002@corpnew", "sms": "+8612*****5965", "deptName": "wangyue", "userUUID": "ff808081699b56cb0169be103500012b" } ] } }

CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' 'https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/stop?conferenceID=914044873'

响应消息示例 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: 46df973984b4ce317502460cd4860600 Server: api-gateway X-Request-Id: 0c4d9e9ce2dc2dca8cac816cad7c42d6

请求消息示例 PUT /v1/mmc/control/conferences/stop?conferenceID=914044873 Connection: keep-alive X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb Content-Type: application/json Content-Length: 24 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: 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": "企业协同云服务项目群" } ]

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