华为云用户手册

入门指引 首次使用SparkRTC，您需要完成如下操作： 注册华为账号 ：单击进入注册页面。 完成实名认证：单击进入实名认证。 账户充值：为确保正常使用SparkRTC，您需要进行账户充值（超过1元）。 提交工单联系华为云技术客服，进行业务咨询。 图1 入门流程 SparkRTC的入门操作流程说明如表1所示。 表1 入门流程说明 序号 操作方法 操作说明 1 获取App ID和 域名 在SparkRTC控制台中创建应用后获取App ID和域名。 2 获取SparkRTC SDK 目前产品已转维，不再对外开放提供SDK开发包，如有疑问，请提交工单处理。 3 集成SparkRTC SDK 集成Android SDK 集成iOS SDK 集成MAC SDK 集成Windows SDK 集成Web SDK SparkRTC提供了Android、iOS、MAC、Windows和Web版本的SDK，您可以根据实际需求进行SDK的集成和开发。 4 实现SparkRTC基本功能 Android SDK功能开发 iOS SDK功能开发 MAC SDK功能开发 Windows SDK功能开发 Web SDK功能开发 集成SDK后，您需要实现SparkRTC的基本功能，如加入房间、发布和订阅流、离开房间等。 5 验证SparkRTC功能 SparkRTC基本功能开发完成后，您可以进行编译验证，其中roomId和userId可以自行定义。

客户端错误码 本章节介绍了Web SDK的客户端错误码RtcErrorCode的详细信息。 表1 错误码说明 类成员 错误码 描述 错误原因或建议处理方式 RTC_ERR_CODE_SUC CES S 0 success 成功。 RTC_ERR_CODE_RTC_SDK_ERROR 90000001 sdk internal error SDK内部错误，请联系技术支持。 RTC_ERR_CODE_WAIT_RSP_TIMEOUT 90000004 message response timeout 消息响应超时，请联系技术支持。 RTC_ERR_CODE_INVALID_PA RAM ETER 90000005 invalid parameter 参数传递错误，请参照API文档排查。 RTC_ERR_CODE_INVALID_OPERATION 90100001 illegal operation 非法操作，用户状态不正确。 RTC_ERR_CODE_NOT_SUPPORT_MEDIA_DEVICES 90100002 not support enumerate devices 浏览器不支持enumerateDevices方法。 RTC_ERR_CODE_NO_AVAILABLE_DEVICES 90100003 no available devices 没有找到可用设备，请排查设备是否就绪。 RTC_ERR_CODE_NO_AVAILABLE_VIDEO_INPUT_DEVICES 90100004 no available video input devices 没有找到可用摄像头设备，请排查视频采集设备是否就绪。 RTC_ERR_CODE_NO_AVAILABLE_AUDIO_INPUT_DEVICES 90100005 no available audio input devices 没有找到音频输入设备，请排查音频采集设备是否就绪。 RTC_ERR_CODE_NO_AVAILABLE_AUDIO_OUTPUT_DEVICES 90100006 no available audio output devices 没有找到音频输出设备。 RTC_ERR_CODE_STATUS_ERROR 90100007 room status error 房间状态不正确，检查是否入会成功。 RTC_ERR_CODE_WEBSOCKET_NOT_CONNECTED 90100008 websocket connection state is not "CONNECTED" websocket 链接未成功，检查链接情况。 RTC_ERR_CODE_WAIT_CONFIG_FAIL 90100009 wait server config fail 获取下发配置失败，请联系技术支持。 RTC_ERR_CODE_PUBLISH_RESPONSE_FAIL 90100010 publish response fail 发布流响应失败，请联系技术支持。 RTC_ERR_CODE_REGION_NOT_COVERED 90100011 current region is not covered, service unavailable 没有找到服务端地址，请联系技术支持。 RTC_ERR_CODE_WEBSOCKET_CONNECT_TIMEOUT 90100012 websocket connect timeout websocket建链超时，请联系技术支持。 RTC_ERR_CODE_WEBSOCKET_RECONNECT_TIMEOUT 90100013 websocket reconnect timeout websocket重连超时，请联系技术支持。 RTC_ERR_CODE_WEBSOCKET_NOT_OPEN 90100014 websocket is not open websocket链接未打开，请联系技术支持。 RTC_ERR_CODE_WEBSOCKET_INTERRUPTED 90100015 websocket connection state is idle, interrupt operation websocket链接被强制关闭，一般为离会或者重连。 RTC_ERR_CODE_WEBSOCKET_CONNECT_ERROR 90100016 websocket connect error websocket监听onerror，服务端主动断链。 RTC_ERR_CODE_CAPTURE_PERMISSION_DENIED 90100017 capture failed, permission denied 采集失败，音视频设备采集权限未被授权。建议提示用户授权摄像头/麦克风访问权限。 RTC_ERR_CODE_CAPTURE_OVER_CONSTRAINED 90100018 capture failed, Constraint parameter invalid 采集失败，音视频采集设备不支持设置的采集约束。 RTC_ERR_CODE_CAPTURE_DEVICE_NOT_FOUND 90100019 capture failed, requested device not found 采集失败，设备未找到。建议在通话开始前引导用户检查通话所需的摄像头或麦克风等设备是够就绪。 RTC_ERR_CODE_CAPTURE_DEVICE_NOT_READABLE 90100020 capture failed, maybe device is occupied by other application 采集失败，设备被占用，请检查使用状态。建议提示用户“暂时无法访问摄像头/麦克风，请确保当前没有其他应用请求访问摄像头/麦克风，并重试”。 RTC_ERR_CODE_PLAY_NOT_ALLOW 90100021 the user didn't interact with the document first, please trigger by gesture 不允许播放。 RTC_ERR_CODE_ROLE_NO_PERMISSION 90100022 the user role have no permission to operate 用户角色没有权限，请检查用户角色。 RTC_ERR_CODE_ANSWER_SDP_INVALID 90100023 the answer sdp is invalid SDP协商错误，请联系技术支持。 RTC_ERR_CODE_MEDIA_UPSTREAM_UNSUPPORTED 90100024 the upstream media is not supported 浏览器不支持媒体采集。 RTC_ERR_CODE_MEDIA_NETWORK_ERROR 90100026 media connection establish failed, please switch network or try again later 媒体建链失败，请切换网络重试。 RTC_ERR_CODE_CLIENT_RELAY_ROOM_OVER_MAXNUM 90100027 relay room number over maximum number 跨房数量超过最大值。 RTC_ERR_CODE_CLIENT_RELAY_JOINER_OVER_MAXNUM 90100028 joiner already exist in relay rooms 跨房内主播人数超过最大值。 RTC_ERR_CODE_ROOM_STREAM_STATUS_PAUSED 90100029 room stream status paused 房间音视频暂停。 RTC_ERR_CODE_SIGNATURE_EXPIRED 90100030 signature expired 签名过期。 RTC_ERR_CODE_SIGNATURE_INVALID 90100031 signature invalid 签名非法。 RTC_ERR_CODE_WINDOW_OR_NAVIGATOR_UNSUPPORTED 90100032 window or navigator error 浏览器window或者navigator异常，请升级或更换浏览器。 RTC_ERR_CODE_CHROME_VERSION_UNSUPPORTED 90100033 the kernel Chrome version is earlier than 67. 浏览器chrome内核版本低于67，请升级或更换浏览器。 RTC_ERR_CODE_WEBSOCKET_UNSUPPORTED 90100034 the websocket component is missing 浏览器websocket能力不支持，请升级或更换浏览器 RTC_ERR_CODE_WEBRTC_AVC_ENCODE_UNSUPPORTED 90100035 RTCPeerConnection unsupport AVC encoders. WebRTC不支持远端画面渲染，请升级或更换浏览器。 RTC_ERR_CODE_WEBRTC_AVC_DECODE_UNSUPPORTED 90100036 RTCPeerConnection unsupport AVC decoders. WebRTC不支持本地画面传输，请升级或更换浏览器。 RTC_ERR_CODE_WEBRTC_WECHAT_UNSUPPORTED 90100037 browser not support, the model is not in the trustlist. 该机型不支持微信浏览器。 RTC_ERR_CODE_RTC_A CS 90100100 server internal exception 服务端内部错误，请联系技术支持。 RTC_ERR_CODE_RTC_CONTROL_ERROR 90100200 server internal exception 服务端内部错误，请联系技术支持。 RTC_ERR_CODE_SFU_ERROR 90100600 server internal exception 服务端内部错误，请联系技术支持。 父主题： 接口参考

SDK介绍 媒体处理 SDK提供了创建转码任务、取消转码任务、查询转码任务、创建转码配置模板、删除转码配置模板、更新转码配置模板、查询转码配置模板等。 目前暂提供了JAVA、Python和Go三种语言SDK，若您有其它开发语言的需求，建议您通过媒体处理API进行调用。 媒体处理SDK代码不支持转义。 如果无法正常打开GitHub仓库，请检查您所使用的网络是否可以正常访问公网。由于GitHub的服务器部署在国外，国内用户访问时容易遇到无法打开的情况，请切换网络后再尝试打开。 表1 服务端SDK 语言 Github地址 参考文档 JAVA huaweicloud-sdk-java-v3 Java SDK使用指导 Python huaweicloud-sdk-python-v3 Python SDK使用指导 Go huaweicloud-sdk-go-v3 Go SDK使用指导

SDK列表 目前MetaStudio提供了Java、Python和Go语言SDK供开发者使用，如表1所示。您可以在GitHub仓库查看SDK更新历史、获取安装包以及查看指导文档。 SDK已知安全漏洞及修复版本、规避方案，请单击表1中的SDK对应语言的Github地址进行查看。 如果无法正常打开GitHub仓库，请检查您所使用的网络是否可以正常访问公网。由于GitHub的服务器部署在国外，国内用户访问时容易遇到无法打开的情况，请切换网络后再尝试打开。 表1 服务端SDK 语言 Github地址 参考文档 JAVA huaweicloud-sdk-java-v3 Java SDK使用指导 Python huaweicloud-sdk-python-v3 Python SDK使用指导 Go huaweicloud-sdk-go-v3 Go SDK使用指导 PHP huaweicloud-sdk-php-v3 PHP SDK使用指导 Node.js huaweicloud-sdk-nodejs-v3 Node.js SDK使用指导

订阅消息示例 { "sequence": "000000000000000001702459164879", "action": "Subscribe", "data": "{\"subscribeType\":[\"ConfBasicInfoNotify\",\"ConfDynamicInfoNotify\",\"ParticipantsNotify\",\"AttendeesNotify\",\"SpeakerChangeNotify\",\"CustomMultiPicNotify\",\"InviteResultNotify\",\"InterpreterGroupNotify\",\"NetworkQualityNotify\",\"WaitingListNotify\"],\"confToken\":\"Basic c3RiZjYyMjZlZWU4YjQ4YjllNThmNGRkYWYzMGVlMWE5YzdlZjJhZTU4ZTkzMDI0MzRh\"}" }

响应消息示例 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": "企业协同云服务项目群" } ]

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": "例行会议" }

请求参数 表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：不支持 confResType 否 Integer Body 会议资源类型,此参数创建后不支持修改: 0: 并发 1: 云会议室 2: 网络研讨会 3: 预留模式,暂未开放

手机号所属的国家 表1 手机号所属的国家 国家 国家码 chinaPR +86(中国大陆) chinaHKG +852（中国香港） chinaOMA +853(中国澳门) chinaTPE +886(中国台湾地区) BVl +1284 (英属维尔京群岛) Bolivia +591(玻利维亚) CZ +420(捷克共和国) GB +245(几内亚比绍) SVGrenadines +1784(圣文森特和格林纳丁斯) TAT +1868(特立尼达和多巴哥) UK +44(英国) afghanistan +93(阿富汗) albania +355(阿尔巴尼亚) algeria +213(阿尔及利亚) andorra +376(安道尔共和国) angola +244(安哥拉) argentina +54(阿根廷) armenia +374(亚美尼亚) australia +61(澳大利亚) austria +43(奥地利) azerbaijan +994(阿塞拜疆) bahamas +1242(巴哈马) bahrain +973(巴林) bangladesh +880(孟加拉国) belarus +375(白俄罗斯) belgium +32(比利时) belize +501(伯利兹) benin +229(贝宁) bosniaAndHerzegovina +387(波斯尼亚和黑塞哥维那) botswana +267(博茨瓦纳) brazil +55(巴西) brunei +673(文莱) bulgaria +359(保加利亚) burkinaFaso +226(布基纳法索) burundi +257(布隆迪) cambodia +855(柬埔寨) cameroon +237(喀麦隆) canada +1(加拿大) capeVerde +238(佛得角) caymanIslands +1345(开曼群岛) centralAfrican +236(中非) chad +235(乍得) chile +56(智利) colombia +57(哥伦比亚) comoros +269(科摩罗) congoB +242(刚果.布) congoJ +243(刚果.金) costarica +506(哥斯达黎加) croatia +385(克罗地亚) curacao +599(库拉索岛) cyprus +357(塞浦路斯) denmark +45(丹麦) djibouti +253(吉布提) dominica +1809(多米尼加共和国) ecuador +593(厄瓜多尔) egypt +20(埃及) equatorialGuinea +240(赤道几内亚) estonia +372(爱沙尼亚) finland +358(芬兰) france +33(法国) gabon +241(加蓬) gambia +220(冈比亚) georgia +995(格鲁吉亚) germany +49(德国) ghana +233(加纳) greece +30(希腊) grenada +1473(格林纳达) guatemala +502(危地马拉) guinea +224(几内亚) guyana +592(圭亚那) honduras +504(洪都拉斯) hungary +36(匈牙利) india +91(印度) indonesia +62(印度尼西亚) iraq +964(伊拉克) ireland +353(爱尔兰) israel +972( 以色列) italy +39(意大利) ivoryCoast +225(科特迪瓦) jamaica +1876(牙买加) japan +81(日本) jordan +962(约旦) kazakhstan +7(哈萨克斯坦) kenya +254(肯尼亚) kuwait +965(科威特) kyrgyzstan +996(吉尔吉斯斯坦) laos +856(老挝) latvia +371(拉脱维亚) lebanon +961(黎巴嫩) lesotho +266(莱索托) liberia +231(利比里亚) libya +218(利比亚) lithuania +370(立陶宛) luxembourg +352(卢森堡) macedonia +389(北马其顿) madagascar +261(马达加斯加) malawi +265(马拉维) malaysia +60(马来西亚) maldives +960(马尔代夫) mali +223(马里) malta +356(马耳他) mauritania +222(毛里塔尼亚) mauritius +230(毛里求斯) mexico +52(墨西哥) moldova +373(摩尔多瓦) mongolia +976(蒙古) montenegro +382 (黑山共和国) morocco +212(摩洛哥) mozambique +258(莫桑比克) myanmar +95(缅甸) namibia +264(纳米比亚) nepal +977(尼泊尔) netherlands +31(荷兰) newZealand +64(新西兰) nicaragua +505(尼加拉瓜) niger +227(尼日尔) nigeria +234(尼日利亚) norway +47(挪威) oman +968(阿曼) pakistan +92(巴基斯坦) palestine +970(巴勒斯坦) panama +507(巴拿马) papuaNewGuinea +675(巴布亚新几内亚) peru +51(秘鲁) philippines +63(菲律宾) poland +48(波兰) portugal +351(葡萄牙) puertoRico +1787(波多黎各) qatar +974(卡塔尔) romania +40(罗马尼亚) russia +7(俄罗斯) rwanda +250(卢旺达) saintMartin +590(圣马丁) salvatore +503(萨尔瓦多) saudiArabia +966(沙特阿拉伯) senegal +221(塞内加尔) serbia +381(塞尔维亚) seychelles +248(塞舌尔) sierraLeone +232(塞拉利昂) singapore +65(新加坡) slovakia +421(斯洛伐克) slovenia +386(斯洛文尼亚) somalia +252(索马里) southAfrica +27(南非) southKorea +82(韩国) spain +34(西班牙) sriLanka +94(斯里兰卡) suriname +597(苏里南) swaziland +268(斯威士兰) sweden +46(瑞典) switzerland +41(瑞士) tajikistan +992(塔吉克斯坦) tanzania +255(坦桑尼亚) thailand +66(泰国) togo +228(多哥) tunisia +216(突尼斯) turkey +90(土耳其) turkmenistan +993(土库曼斯坦) uae +971(阿联酋) uganda +256(乌干达) ukraine +380(乌克兰) uruguay +598(乌拉圭) usa +1(美国) uzbekistan +998(乌兹别克斯坦) venezuela +58(委内瑞拉) vietNam +84(越南) yemen +967(也门) zambia +260(赞比亚) zimbabwe +263(津巴布韦) 父主题： 附录

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'

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

请求参数 表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 用于区分到哪个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 是否使用云会议室或者个人会议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：不支持 confResType 否 Integer Body 会议资源类型,此参数创建后不支持修改: 0: 并发 1: 云会议室 2: 网络研讨会 3: 预留模式,暂未开放

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

响应消息示例 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": "企业协同云服务项目群" } ]

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -d '{"conferenceType": "0","subject": "user01 conference","mediaTypes": "HDVideo","attendees": [{"name": "user01","role": 1,"phone": "+8657*******"}]}' 'https://api.meeting.huaweicloud.com/v1/mmc/management/conferences'

响应参数 表7 响应参数 参数 类型 描述 [数组元素] Array of ConferenceInfo 会议信息列表。 表8 ConferenceInfo 数据结构 参数名称 参数类型 描述 conferenceID String 会议ID。 subject String 会议主题。 size Integer 会议预约时添加的会议者数量。 timeZoneID String 会议通知中会议时间的时区信息。时区信息，参考时区映射关系。 说明： 举例：“timeZoneID”:"26"，则通过华为云会议发送的会议通知中的时间将会标记为如“2021/11/11 星期四 00:00 - 02:00 (GMT) 格林威治标准时间:都柏林, 爱丁堡, 里斯本, 伦敦”。 startTime String 会议起始时间 (YYYY-MM-DD HH:MM )。 endTime String 会议结束时间 (YYYY-MM-DD HH:MM )。 mediaTypes String 会议的媒体类型。 由1个或多个枚举String组成，多个枚举时，每个枚举值之间通过”,”逗号分隔。如：mediaTypes：“Voice,Data,HDVideo” “Voice”：语音 “Video”：标清视频 “HDVideo”：高清视频 “Data”：数据 conferenceState String 会议状态。 “Schedule”：预定状态 “Creating”：正在创建状态 “Created”：会议已经被创建，并正在召开 “Destroyed”：会议已经关闭 language String 会议通知短信或邮件的语言。默认中文。 zh-CN：中文 en-US：英文 accessNumber String 会议接入的SIP号码。 passwordEntry Array of PasswordEntry objects 会议密码。 说明： 创建会议时，返回主持人密码和来宾密码 主持人查询会议时，返回主持人密码和来宾密码 来宾查询会议时，返回来宾密码 userUUID String 会议预订者的用户UUID。 scheduserName String 会议预订者名称。 conferenceType Integer 会议类型。 0 : 普通会议。 2 : 周期性会议。 confType String 会议类型。 FUTURE：将来开始的会议（创建时） IMMEDIATELY：立即开始的会议（创建时） CYCLE：周期会议 cycleParams CycleParams object 周期会议参数。当会议是周期会议的时候携带该参数。 isAutoMute Integer 是否入会自动静音。 0 : 不自动静音 1 : 自动静音 isAutoRecord Integer 是否自动开启云录制。 0 : 不自动启动 1 : 自动启动 chairJoinUri String 主持人会议链接地址。 guestJoinUri String 普通与会者会议链接地址。 audienceJoinUri String 网络研讨会观众会议链接地址。 recordType Integer 录播类型。 0: 禁用 1: 直播 2: 录播 3: 直播+录播 auxAddress String 辅流直播推流地址。 liveAddress String 主流直推流播地址。 recordAuxStream Integer 是否录制辅流。 0：否 1：是 recordAuthType Integer 录播观看鉴权方式。 0：可通过链接观看/下载 1：企业用户可观看/下载 2：与会者可观看/下载 liveUrl String 直播观看地址。 confConfigInfo ConfConfigInfo object 会议其他配置信息。 vmrFlag Integer 是否使用云会议室或个人会议ID召开预约会议。 0：不使用云会议室或个人会议ID 1：使用云会议室或个人会议ID isHasRecordFile Boolean 是否有会议录制文件。仅历史会议查询时返回。 true：有录制文件。 false：没有录制文件。 vmrConferenceID String 云会议室会议ID或个人会议ID。如果“vmrFlag”为“1”，则该字段不为空。 confUUID String 会议的UUID。 说明： 只有创建立即开始的会议才返回UUID，如果是预约未来的会议，不会返回UUID 可以通过查询历史会议列表获取历史会议的UUID partAttendeeInfo Array of PartAttendee objects 被邀请的部分与会者信息。 说明： 只返回被邀请的前20条软终端与会者信息和前20条硬终端与会者信息 不返回会中主动加入的与会者信息 “查询会议列表”和“查询会议详情”接口，返回预约会议时邀请的与会者和会中主持人邀请的与会者 “查询在线会议列表”、“查询在线会议详情”、“查询历史会议列表”和“查询历史会议详情”接口返回预约会议时邀请的与会者。不返回会中主持人邀请的与会者 terminlCount Integer 硬终端个数，如IdeaHub，TE30等。 normalCount Integer 软终端个数，如PC端、手机端App等。 deptName String 会议预定者的企业名称。 role String 与会者角色。 chair ：主持人 general ：来宾 audience ： 观众 说明： 仅在查询会议详情时返回 返回查询者本身的角色 multiStreamFlag Integer 标识是否为多流视频会议。 1 ：多流会议 webinar Boolean 是否是网络研讨会。 onlineAttendeeAmount Integer 当前在线与会人数。包含被邀入会和主动入会的与会者。 说明： 仅在“查询在线会议列表”接口中返回。 confMode String 会议模型。 COMMON ：MCU会议 RTC ：MMR会议 scheduleVmr Boolean VMR预约记录。 true ：VMR会议 false ：普通会议 说明： 该参数将废弃，请勿使用。 vmrID String 云会议室ID。 concurrentParticipants Integer 会议最大与会人数。默认值0。 0：无限制 大于0：会议最大与会人数 supportSimultaneousInterpretation Boolean 会议是否支持同声传译 true ：支持 false ：不支持 picDisplay MultiPicDisplayDO object 多画面信息。 subConfs Array of Subconfs objects 周期子会议列表。 cycleSubConfID String 第一个周期子会议的UUID。 表9 PasswordEntry 数据结构 参数 参数类型 描述 conferenceRole String 会议角色。 chair：会议主持人 general：普通与会者 password String 会议中角色的密码（明文）。 表10 PartAttendee 数据结构 参数 参数类型 描述 name String 与会者名称。 phone String 号码。SIP号码或者手机号码。 phone2 String 预留字段，取值类型同参数“phone”。 phone3 String 预留字段，取值类型同参数“phone”。 type String 终端类型，类型枚举如下： normal：软终端 terminal：硬终端 outside：外部与会人 mobile：用户手机号码 ideahub：ideahub board: 电子白板（SmartRooms）。含Maxhub、海信大屏、IdeaHub B2 hwvision：华为智慧屏TV role Integer 会议中的角色。默认为普通与会者。 0：普通与会者 1：会议主持人 isMute Integer 用户入会时是否需要自动静音 。默认不静音。 0： 不需要静音 1： 需要静音 说明： 仅会中邀请与会者时才生效。 表11 MultiPicDisplayDO 数据结构 参数 类型 描述 manualSet Integer 是否为手工设置多画面。 0 ：系统自动多画面 1 ：手工设置多画面 imageType String 画面类型。取值范围: Single: 单画面 Two: 二画面 Three: 三画面， Three-2: 三画面-2， Three-3: 三画面-3， Three-4: 三画面-4 Four: 四画面， Four-2: 四画面-2， Four-3: 四画面-3 Five: 五画面， Five-2: 五画面-2 Six: 六画面， Six-2: 六画面-2， Six-3: 六画面-3， Six-4: 六画面-4， Six-5: 六画面-5 Seven: 七画面， Seven-2: 七画面-2， Seven-3: 七画面-3， Seven-4: 七画面-4 Eight: 八画面， Eight-2: 八画面-2， Eight-3: 八画面-3， Eight-4: 八画面-4 Nine: 九画面 Ten: 十画面， Ten-2: 十画面-2， Ten-3: 十画面-3， Ten-4: 十画面-4， Ten-5: 十画面-5， Ten-6: 十画面-6 Thirteen: 十三画面， Thirteen-2: 十三画面-2， Thirteen-3: 十三画面-3，Thirteen-4: 十三画面-4， Thirteen-5: 十三画面-5， ThirteenR: 十三画面R， ThirteenM: 十三画面M Sixteen: 十六画面 Seventeen: 十七画面 Twenty-Five: 二十五画面 Custom: 自定义多画面（当前不支持） subscriberInPics Array of PicInfoNotify objects 子画面列表。 switchTime Integer 表示轮询间隔，单位：秒。当同一个子画面中包含有多个视频源时，此参数有效。 picLayoutInfo PicLayoutInfo object 自定义多画面布局信息。预留字段，当前不支持。 表12 PicInfoNotify 数据结构 参数 类型 描述 index Integer 多画面中每个画面的编号，编号从1开始。 id Array of strings 每个画面中的与会者SIP号码。SIP号码可以通过查询企业通讯接口录获取。 share Integer 是否为辅流 0： 不是辅流 1： 是辅流 表13 PicLayoutInfo 数据结构 参数 类型 描述 x Integer 横向小格子数。 y Integer 纵向小格子数。 subPicLayoutInfoList Array of SubPicLayoutInfo objects 多画面信息。 表14 SubPicLayoutInfo 数据结构 参数 类型 描述 id Integer 子画面索引。 left Integer 子画面从左到右的索引。 top Integer 子画面从上到下的索引。 xSize Integer 子画面横向尺寸。 ySize Integer 子画面纵向尺寸。 表15 CycleParams 数据结构 参数 类型 描述 startDate String 周期会议的开始日期，格式：YYYY-MM-DD。 开始日期不能早于当前日期。 说明： 日期是timeZoneID指定的时区的日期，非UTC时间的日期。 endDate String 周期会议的结束日期，格式：YYYY-MM-DD。 开始日期和结束日期间的时间间隔最长不能超过1年。开始日期和结束日期之间最多允许50个子会议，若超过50个子会议，会自动调整结束日期。 说明： 日期是timeZoneID指定的时区的日期，非UTC时间的日期。 cycle String 周期类型。 Day：天 Week：星期 Month：月 interval Integer 子会议间隔。 “cycle”选择了“Day”，表示每几天召开一次，取值范围[1,15] “cycle”选择了“Week”，表示每几周召开一次，取值范围[1,5] “cycle”选择了“Month”，Interval表示隔几月，取值范围[1,3] point Array of integers 周期内的会议召开点。仅当按周和月时有效。 “cycle”选择了“Week”，point中填入了两个元素1和3，则表示每个周一和周三召开会议，0表示周日 “cycle”选择了“Month”，point中填入了12和20则表示每个月的12号和20号召开会议，取值范围为[1,31]，若当月没有该值，则为月末 preRemindDays Integer 提前通知天数。所有与会者在每个子会议开始前N天收到会议通知。取值范围[0,30]。 默认值是1。 表16 ConfConfigInfo 数据结构 参数 类型 描述 isSendNotify Boolean 是否需要发送会议邮件通知。默认值由企业级配置决定。 true：需要 false：不需要 isSendSms Boolean 是否需要发送会议短信通知。 true：需要 false：不需要 说明： 保留字段，暂不提供短信通知能力。 isSendCalendar Boolean 是否需要发送会议日历通知。默认值由企业级配置决定。 true：需要 false：不需要 isAutoMute Boolean 来宾入会，软终端是否自动静音。默认值由企业级配置决定。 true：自动静音 false：不自动静音 isHardTerminalAutoMute Boolean 来宾入会，硬终端是否自动静音。默认值由企业级配置决定。 true：自动静音 false：不自动静音 isGuestFreePwd Boolean 是否来宾免密（仅随机会议有效）。 true：免密 false：需要密码 说明： 仅随机会议ID的会议生效。 callInRestriction Integer 允许加入会议的范围。 0：所有用户 2：企业内用户 3：被邀请用户 allowGuestStartConf Boolean 是否允许来宾启动会议。 true：允许来宾启动会议。 false：禁止来宾启动会议。 说明： 仅随机会议ID的会议生效。 guestPwd String 来宾密码（4-16位长度的纯数字）。 vmr IDT ype Integer 云会议室的会议ID模式。 0：固定会议ID 1：随机会议ID prolongLength Integer 自动延长会议时长（取值范围0-60）。 0：表示会议到点自动结束，不延长会议 其他：表示自动延长的时长 说明： 自动结束会议是按照会议时长计算。比如预定的会议是9:00开始11:00结束，会议时长2个小时，如果与会者8:00就加入会议了，那会议在10:00就会自动结束 设置成其他值时，只要会中还有与会者，会议可以多次延迟 enableWaitingRoom Boolean 开启或者关闭等候室。 true：开启 false：不开启 isHostCameraOn Boolean 主持人入会是否开启摄像头。 true：开启 false：不开启 isGuestCameraOn Boolean 来宾入会是否开启摄像头。 true：开启 false：不开启

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 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: 直播+录播 说明： 当录播类型含有直播属性（recordType为1或3），则liveAddress或者auxAddress至少填一个，否则会中无直播功能。 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 vmrID 否 String Body 绑定给当前创会账号的VMR ID。通过查询云会议室及个人会议ID接口获取。 说明： vmrID取上述查询接口中返回的id，不是vmrId 创建个人会议ID的会议时，使用vmrMode=0的VMR；创建云会议室的会议时，使用vmrMode=1的VMR vmrID使用个人会议ID占用并发资源，使用云会议室ID占用云会议室资源；vmrID既不使用个人会议ID也不使用云会议室ID（vmrflag=0，vmrID=null）占用并发资源 concurrentParticipants 否 Integer Body 会议方数，会议最大与会人数限制。 0：无限制 大于0：会议最大与会人数 supportSimultaneousInterpretation 否 Boolean Body 会议是否支持同声传译 true：支持 false：不支持 confResType 否 Integer Body 会议资源类型,此参数创建后不支持修改: 0: 并发 1: 云会议室 2: 网络研讨会 3: 预留模式,暂未开放 表3 Attendee 数据结构 参数 是否必须 类型 描述 userUUID 否 String 与会者的用户UUID。 accountId 否 String 与会者的账号。 如果是账号/密码鉴权场景: 选填，表示华为云会议账号ID 如果是APP ID鉴权场景：必填，表示第三方的User ID，同时需要携带参数appId appId 否 String App ID。如果是APP ID鉴权场景，此项必填。参考“App ID的申请”。 name 否 String 与会者名称。长度限制为96个字符。 role 否 Integer 会议中的角色。默认为普通与会者。 0：普通与会者 1：会议主持人 phone 否 String 号码。支持SIP号码或者手机号码。 如果是账号/密码鉴权场景：必填 如果是APP ID鉴权场景：选填 说明： 号码可以通过查询企业通讯接口录获取。返回的number是SIP号码，phone是手机号码 填SIP号码系统会呼叫对应的软终端或者硬终端；填手机号码系统会呼叫手机 呼叫手机需要开通PSTN权限，否则无法呼叫 phone2 否 String 预留字段，取值类型同参数“phone”。 phone3 否 String 预留字段，取值类型同参数“phone”。 email 否 String 邮件地址。需要发邮件通知时填写。 sms 否 String 短信通知的手机号码。需要发短信通知时填写。 isMute 否 Integer 用户入会时是否需要自动静音 。默认不静音。 0： 不需要静音 1： 需要静音 说明： 仅会中邀请与会者时才生效。 isAutoInvite 否 Integer 会议开始时是否自动邀请该与会者。默认值由企业级配置决定。 0：不自动邀请。 1：自动邀请。 说明： 仅并发会议资源的随机会议ID会议才生效。 type 否 String 终端类型，类型枚举如下： normal：软终端 terminal：硬终端 outside：外部与会人 mobile：用户手机号码 ideahub：ideahub board: 电子白板（SmartRooms），含Maxhub、海信大屏、IdeaHub B2 hwvision：华为智慧屏TV customnumber： 自定义呼叫号码(包括级联会议号、手机号码、硬终端SIP号码等) address 否 String 预留字段，终端所在会议室信息。 deptUUID 否 String 部门ID。 deptName 否 String 部门名称。最大不超过128个字符。 uniqueType 否 Integer 企业内唯一会场标识, 0标识为普通与会者，1标识为企业内唯一会场 说明： 创建级联会议时，uniqueType 为1， 同时type为customnumber 表4 CycleParams 数据结构 参数 是否必须 类型 描述 startDate 是 String 周期会议的开始日期，格式：YYYY-MM-DD。 开始日期不能早于当前日期。 说明： 日期是timeZoneID指定的时区的日期，非UTC时间的日期。 endDate 是 String 周期会议的结束日期，格式：YYYY-MM-DD。 开始日期和结束日期间的时间间隔最长不能超过1年。开始日期和结束日期之间最多允许50个子会议，若超过50个子会议，会自动调整结束日期。 说明： 日期是timeZoneID指定的时区的日期，非UTC时间的日期。 cycle 是 String 周期类型。 Day：天 Week：星期 Month：月 interval 否 Integer 子会议间隔。 “cycle”选择了“Day”，表示每几天召开一次，取值范围[1,15] “cycle”选择了“Week”，表示每几周召开一次，取值范围[1,5] “cycle”选择了“Month”，Interval表示隔几月，取值范围[1,3] point 否 Array of integers 周期内的会议召开点。仅当按周和月时有效。 “cycle”选择了“Week”，point中填入了两个元素1和3，则表示每个周一和周三召开会议，0表示周日 “cycle”选择了“Month”，point中填入了12和20则表示每个月的12号和20号召开会议，取值范围为[1,31]，若当月没有该值，则为月末 preRemindDays 是 Integer 提前通知天数。所有与会者在每个子会议开始前N天收到会议通知。取值范围[0,30]。 默认值是1。 表5 ConfConfigInfo 数据结构 参数 是否必须 类型 描述 isSendNotify 否 Boolean 是否需要发送会议邮件通知。默认值由企业级配置决定。 true：需要 false：不需要 isSendSms 否 Boolean 是否需要发送会议短信通知。 true：需要 false：不需要 说明： 保留字段，暂不提供短信通知能力。 isSendCalendar 否 Boolean 是否需要发送会议邮件日历通知。默认值由企业级配置决定。 true：需要 false：不需要 isAutoMute 否 Boolean 来宾入会，软终端是否自动静音。默认值由企业级配置决定。 true：自动静音 false：不自动静音 isHardTerminalAutoMute 否 Boolean 来宾入会，硬终端是否自动静音。默认值由企业级配置决定。 true：自动静音 false：不自动静音 isGuestFreePwd 否 Boolean 是否来宾免密。 true：免密 false：需要密码 说明： 仅随机会议ID的会议生效。 callInRestriction 否 Integer 允许加入会议的范围。 0：所有用户 2：企业内用户 3：被邀请用户 allowGuestStartConf 否 Boolean 是否允许来宾启动会议。 true：允许来宾启动会议 false：禁止来宾启动会议 说明： 仅随机会议ID的会议生效。 guestPwd 否 String 来宾密码（4-16位长度的纯数字）。 vmrIDType 否 Integer 云会议室的会议ID模式。 0：固定会议ID 1：随机会议ID prolongLength 否 Integer 自动延长会议时长（取值范围0-60）。 0：表示会议到点自动结束，不延长会议。 其他：表示自动延长的时长。 说明： 自动结束会议是按照会议时长计算。比如预定的会议是9:00开始11:00结束，会议时长2个小时，如果与会者8:00就加入会议了，那会议在10:00就会自动结束 设置成其他值时，只要会中还有与会者，会议自动多次延长 enableWaitingRoom 否 Boolean 是否开启等候室(只对MMR企业生效)。 true：开启 false：不开启 isHostCameraOn 否 Boolean 主持人入会是否开启摄像头。 true：开启 false：不开启 isGuestCameraOn 否 Boolean 来宾入会是否开启摄像头。 true：开启 false：不开启

响应消息示例 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": "986256843", "mediaTypes": "HDVideo,Data,Voice", "subject": "例行周期会议", "size": 0, "timeZoneID": "56", "startTime": "2021-09-01 08:39", "endTime": "2021-09-01 09:09", "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": "fe24d1350a3611ecbe71a328ac3ca004", "conferenceID": "986256843", "startTime": "2021-09-01 08:39", "endTime": "2021-09-01 09:09", "mediaType": "HDVideo,Data,Voice", "isAutoRecord": 0, "recordAuthType": 2, "confConfigInfo": { "callInRestriction": 0, "audienceCallInRestriction": 0, "allowGuestStartConf": true, "enableWaitingRoom": false } }, { "cycleSubConfID": "fe24d1360a3611ecbe71fdd2c36bc8c2", "conferenceID": "986256843", "startTime": "2021-09-02 08:39", "endTime": "2021-09-02 09:09", "mediaType": "HDVideo,Data,Voice", "isAutoRecord": 0, "recordAuthType": 2, "confConfigInfo": { "callInRestriction": 0, "audienceCallInRestriction": 0, "allowGuestStartConf": true, "enableWaitingRoom": false } } ] } ]

请求消息示例 POST /v1/mmc/management/cycleconferences Connection: keep-alive X-Access-Token: cnr1510zTBhrfUsymQ0srhW2RYS99r9G5SQoTLWN 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": "Data,Voice,HDVideo", "startTime": "", "length": 120, "timeZoneID": "56", "vmrFlag": 1, "vmrID": "ff80808167ef1edf0167f339533f05a8", "cycleParams": { "startDate": "2021-08-31", "endDate": "2021-09-02", "cycle": "Day", "interval": 1, "preRemindDays": 1 }, "attendees": [ { "userUUID": "ff80808167ef1edf0167f339533d05a6", "name": "苏州分部", "email": "******", "sms": "+991116006724", "deptName": "企业协同云服务项目群", "role": 0, "phone": "+99119*****724", "type": "normal" } ], "confConfigInfo": { "isSendNotify": "false", "isSendSms": "false", "isSendCalendar": "false" }, "recordType": 0 }

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token:cnr1510zTBhrfUsymQ0srhW2RYS99r9G5SQoTLWN' -d '{"conferenceType": "2","subject": "user01 conference","mediaTypes": "HDVideo","attendees": [{"name": "user01","role": 1,"phone": "+8657*******"}], "cycleParams": {"startDate": "2021-08-31","endDate": "2021-09-02","cycle": "Day","interval": 1,"preRemindDays": 1}}' 'https://api.meeting.huaweicloud.com/v1/mmc/management/cycleconferences'

响应参数 表4 响应参数 参数 类型 描述 [数组元素] Array of ConferenceInfo 会议信息列表。 表5 Subconfs 数据结构 名称 类型 描述 cycleSubConfID string 子会议UUID。 conferenceID string 会议ID。 mediaType string 会议的媒体类型。 Voice：语音 Video：标清视频 HDVideo：高清视频 Data：数据 startTime string 会议起始时间(格式:YYYY-MM-DD HH:MM)。 endTime string 会议结束时间(格式:YYYY-MM-DD HH:MM)。 isAutoRecord Integer 是否自动开启云录制。 0: 不自动启动 1: 自动启动 confConfigInfo Confconfinginfo object 周期子会议其他配置信息。 recordAuthType Integer 观看/下载录播的鉴权方式。 0: 可通过链接观看/下载 1: 企业用户可观看/下载 2: 与会者可观看/下载 description string 会议描述。长度限制为200个字符。 表6 Confconfiginfo 数据结构 名称 类型 描述 callInRestriction Integer 允许加入会议的范围。 0: 所有用户 2: 企业内用户 3: 被邀请用户 audienceCallInRestriction Integer 允许加入网络研讨会的观众范围。 0：所有用户 2：企业内用户和被邀请用户 allowGuestStartConf Boolean 是否允许来宾启动会议。 true: 允许来宾启动会议 false: 禁止来宾启动会议 说明： 仅随机会议ID有效。 enableWaitingRoom Boolean 是否启用等候室。 showAudienceCountInfo ShowAudienceCountInfo object 网络研讨会观众数显示策略。 表7 ShowAudienceCountInfo 数据结构 名称 类型 描述 showAudienceMode Integer 观众显示策略:服务端用来计算观众人数下发给客户端控制观众显示。 0: 不显示 1: 倍增显示与会人数。基于实时与会人数或累计与会人次（假设为N），可以再进行倍增设置。支持设置倍增倍数X和基础人数Y，设置后，显示的人数为：N*X+Y baseAudienceCount Integer 基础人数。范围是0~10000。 multiple Double 倍增倍数。范围是1~10, 支持设置到小数点后1位。

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 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) 格林威治标准时间:都柏林, 爱丁堡, 里斯本, 伦敦”。 startDate和endDate中的日期是timeZoneID指定时区的日期。 recordType 否 Integer Body 录播类型。默认为禁用。 0: 禁用 1: 直播 2: 录播 3: 直播+录播 说明： 当录播类型含有直播属性（recordType为1或3），则liveAddress或者auxAddress至少填一个，否则会中无直播功能。 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 vmrID 否 String Body 绑定给当前创会账号的VMR ID。通过查询云会议室及个人会议ID接口获取。 说明： vmrID取上述查询接口中返回的id，不是vmrId 创建个人会议ID的会议时，使用vmrMode=0的VMR；创建云会议室的会议时，使用vmrMode=1的VMR vmrID使用个人会议ID占用并发资源，使用云会议室ID占用云会议室资源；vmrID既不使用个人会议ID也不使用云会议室ID（vmrflag=0，vmrID=null）占用并发资源 concurrentParticipants 否 Integer Body 会议方数，会议最大与会人数限制。 0：无限制 大于0：会议最大与会人数 supportSimultaneousInterpretation 否 Boolean Body 会议是否支持同声传译 true：支持 false：不支持 confResType 否 Integer Body 会议资源类型,此参数创建后不支持修改: 0: 并发 1: 云会议室 2: 网络研讨会 3: 预留模式,暂未开放

API开发 CodeArts API支持生成接口请求代码和业务代码，缩短前后端开发时长，规范代码结构。 基于接口定义，CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块，接口文档界面右侧，即可看到“生成代码”的入口。 生成接口请求代码 单击“生成代码”下拉框，选择“生成接口请求代码”，弹出“生成接口请求代码”对话框。 支持生成多种语言的接口请求代码，单击右上角，可一键复制并直接粘贴，支持编辑修改和代码格式化。 生成业务代码 单击“生成代码”下拉框，选择“生成业务代码”，弹出“生成业务代码”对话框。 根据需要选择语言、生成范围（包括“仅当前接口及关联模型”和“整个项目”），单击“生成”将生成的代码存储到本地，开发者可以将代码复制到本地的研发工具（如IntelliJ IDEA）。

创建Markdown文件 新建Markdown，可通过以下三种方式完成。 方法一：单击目录树搜索框右侧的，在弹出的下拉框中，选择“新建Markdown”。 方法二：在目录树中选择一个目录，单击右侧图标，在弹出的下拉框中，选择“新建Markdown”。 进入“新建标签页”，在该标签页可以编辑Markdown文件，主要包括：目录、名称、正文。 目录：在上一步中，如果通过方法一和方法二新建Markdown，目录初始内容为空，可以手动选择；如果通过方法三新建Markdown，目录会自动生成为选中的目录，也可以手动修改。 名称：可根据业务需要自定义命名，不能为空。命名规则：只支持中文、英文、下划线、数字和“.”，且以中英文开头，长度为3-64个字符。 正文：可手动输入文字，也可使用组件插入特定的内容，如：表格、超链接、图片；正文样式也可以使用组件进行调整；正文编辑支持全屏模式；在左侧编辑正文时，右侧会同步展示编辑内容，便于查看、修改样式等。 编辑完成后，单击右上角“保存”，左侧目录树同步刷新，界面会自动跳转到文档页面，展示名称、正文，上方标签页的名称也会更新为Markdown文件名称。 移动Markdown（可选）。 单击并拖拽Markdown到目标目录后释放即可，移动成功后，目录树会自动刷新，Markdown文件的目录也会同步改变。

新建变量 在“环境参数”页面，单击，即可添加一个变量，根据需要填写变量信息： 参数项 说明 名称 当前环境变量参数名，可使用“$${参数名}”形式进行引用。 类型 包括：文本、随机字符串、随机整数、时间戳、格式化时间戳、生成UUID、Base64编码、MD5哈希值、密码或认证信息、SHA512编码。 值 当前环境变量的值，支持加密显示。 描述 根据不同类型，自动添加默认描述，也可根据设计需要自定义描述。 敏感变量 勾选为敏感变量后，云测对参数值加密存储，在测试结果日志中使用星号覆盖处理。敏感数据类型适用并不限于个人信息、鉴权信息等，如：姓名、地址、用户名等。 动态变量 动态参数的值可以在用例执行过程中被赋值。动态参数初始值可为空，被赋值之后，此处显示的是最新值。 动态参数赋值方法：在用例测试步骤“响应提取”的“赋值给环境动态参数”中设置后，测试执行时，响应提取的内容将被赋值给动态参数。

参数使用 环境参数可以用于整个项目，如：快捷调试的参数、URL，测试步骤的参数、检查点、变量、URL等都可以引用环境参数。 环境参数的引用形式为“$${参数名}”，如：参数名为“hostname”，则可以使用“$${hostname}”来引用该参数。可以按环境上下文配置环境参数，如：类生产环境中hostname=stage.example.com，生产环境中hostname=prod.example.com。测试执行时可选择环境执行。

邀请其他企业用户 企业A的账号中创建项目后，可以向该项目中添加企业B的账号中的 IAM 用户。 前提条件请参照邀请其他企业用户为项目成员。 单击“添加成员”旁的下拉框，选择“邀请其他企业用户”。 弹出“邀请其他企业用户”对话框，在“企业用户”下拉列表框中选择被邀请用户所属的账号，选择邀请方式并输入对应ID，单击“确定”。 用户ID：被邀请用户的ID，通过“我的凭证 ”获取“IAM用户ID”。获取方式请参考API凭证。 委托ID：被邀请账号中已创建的委托ID，通过IAM服务中的“委托”页面获取。 单击“确定”，可以将其他企业用户添加到项目中。

请求体 在Body页签中，可以查看请求体，目前支持的请求体有如下几类： none：无body参数。 form-data：Content-Type为“multipart/form-data”，可以输入请求体中每个参数的类型、名称和值。 application/x-www-form-urlencoded：Content-Type为“application/x-www-form-urlencoded”，可以输入请求体中每个参数的名称和值。 raw：在文本框中输入文本内容，在“raw”选项旁边可以下拉选择输入文本内容格式，如Text和Json。 请求参数的默认值均来自API设计的样例值。 在API调试页面修改请求参数，不能保存至API设计与API文档中。