接口功能
  该接口用于编辑已预约的会议。注意事项:1、该接口在已登录状态下才能调用;2、调用该接口时,仅能编辑尚未开始的会议,若会议已召开,接口将返回失败;3、所有字段必填,编辑会议前需要查询会议详情,不需要变更的数据请使用查询会议详情返回的数据赋值。
  
 
  函数原型
  editConf(editConfParam: EditConfParam, onEditConfResult?: (ret: SDKERR, reason: string) => void): void
  
 
  请求参数
  
   
    
     表1 入参说明
    
    
     
      | 参数名称 | 
      是否必选 | 
      参数类型 | 
      参数说明 | 
     
    
    
     
      | editConfParam | 
      Y | 
      EditConfParam | 
      编辑会议的参数体 | 
     
     
      | onEditConfResult | 
      Y | 
      (ret: SDKERR, reason: string) => void | 
      修改会议预约回调 | 
     
    
   
   
  
 
  
   
    表2 EditConfParam
   
   
    
     | 参数名称 | 
     是否必选 | 
     参数类型 | 
     参数说明 | 
    
   
   
    
     | confId | 
     Y | 
     string | 
     会议ID。 | 
    
    
     | startTime | 
     N | 
     number | 
     (已废弃,推荐使用字段startTimeStamp)会议开始时间,如果没有指定开始时间,则表示会议马上开始,精度秒(0时区)。说明:UTC时间与UTC偏移量(转换为秒)的差值,如东八区为 UTC时间戳 - (8 x 60 x 60)。 | 
    
    
     | startTimeStamp | 
     N | 
     number | 
     会议开始时间,startTimeStamp、startTime二选一,优先使用startTimeStamp(时间戳,单位秒) | 
    
    
     | duration | 
     Y | 
     number | 
     会议持续时长,单位分钟 | 
    
    
     | confCommonParam | 
     Y | 
     ConfCommonParam | 
     会议公用参数 | 
    
    
     | isSendCalendar | 
     N | 
     boolean | 
     是否发送日历通知 | 
    
   
  
  
 
  
   
    表3 ConfCommonParam
   
   
    
     | 参数名称 | 
     是否必选 | 
     参数类型 | 
     参数说明 | 
    
   
   
    
     | subject | 
     Y | 
     string | 
     会议主题。 | 
    
    
     | mediaType | 
     N | 
     MediaType | 
     会议类型。默认音频会议。 | 
    
    
     | needPassword | 
     N | 
     boolean | 
     是否需要来宾密码。默认不需要来宾密码(仅对随机会议ID生效)。 | 
    
    
     | isAutoRecord | 
     N | 
     boolean | 
     会议自动录制开关。默认不开启。 开启会议自动录制开关,内部会默认支持录制会议,录制会议开关的打开与关闭并不影响。 说明:仅对云录制生效,客户端本地录制不生效。 | 
    
    
     | allowRecord | 
     N | 
     boolean | 
     是否支持录制会议。(仅对win平台生效) 说明:仅对云录制生效,客户端本地录制不生效。 | 
    
    
     | allowLive | 
     N | 
     boolean | 
     保留。编辑会议时透传会议详情此字段 | 
    
    
     | timezone | 
     Y | 
     Timezone | 
     时区码。用于发送会议通知。 | 
    
    
     | vmrId | 
     N | 
     string | 
     云会议室唯一ID。预约并发会议时,设置为空字符串。编辑会议时不可修改,填入会议详情返回值。 | 
    
    
     | confAllowJoinUser | 
     N | 
     ConfAllowJoinUserType | 
     允许入会范围限制。默认所有用户。 | 
    
    
     | isSendSms | 
     N | 
     boolean | 
     发送短信通知开关。企业配置里面需要开启,否则不生效。 | 
    
    
     | isSendEmail | 
     N | 
     boolean | 
     发送邮件通知开关。 | 
    
    
     | vmrConfIdType | 
     N | 
     VmrConfIdType | 
     云会议室的会议ID类型。编辑会议时不可修改会议详情中vmrConfId非空,填入HWM_VMR_CONF_ID_TYPE_FIXED; 会议详情中vmrConfId为空,填入HWM_VMR_CONF_ID_TYPE_RANDOM | 
    
    
     | guestPwd | 
     N | 
     string | 
     来宾密码,如果空则服务器随机生成(仅对随机会议ID生效)。 | 
    
    
     | isOpenWaitingRoom | 
     N | 
     boolean | 
     等候室开启开关。 说明:需要等候室功能开通后才能生效 | 
    
    
     | attendees | 
     N | 
     Array<AttendeeBaseInfo> | 
     与会者列表。若不需要带与会者,参数值可以为空。 | 
    
    
     | allowGuestStartConf | 
     N | 
     boolean | 
     允许来宾启动会议 | 
    
    
     | allowGuestStartConfTime | 
     N | 
     number | 
     允许来宾提前入会时间范围(单位:分钟) 0-随时,n-提前n分钟启动会议 | 
    
    
     | forbiddenScreenShots | 
     N | 
     boolean | 
     是否禁止截屏 | 
    
    
     | concurrentParticipants | 
     Y | 
     number | 
     会议方数,会议最大与会人数限制. 0: 无限制, 大于0: 会议最大与会人数 | 
    
    
     | customInfo | 
     N | 
     string | 
     用户自定义信息。 | 
    
    
     | confResType | 
     N | 
     ConfResType | 
     会议资源类型 | 
    
    
     | defaultSummaryState | 
     N | 
     SummaryState | 
     会议云录制是否包含纪要,初始值(周期会议暂不支持) | 
    
    
     | autoMuteMode | 
     N | 
     AutoMuteType | 
     来宾入会,软终端是否自动静音 | 
    
    
     | hardTerminalAutoMuteMode | 
     N | 
     AutoMuteType | 
     来宾入会,硬终端是否自动静音 | 
    
    
     | supportWatermark | 
     N | 
     boolean | 
     是否支持水印 | 
    
    
     | autoPublishSummary | 
     N | 
     boolean | 
     是否自动发布纪要(免人工审核) | 
    
    
     | attendeesExcludeSelf | 
     N | 
     boolean | 
     与会者列表是否排除自己,默认不排除自己 | 
    
   
  
  
 
  
   
    表4 MediaType枚举说明
   
   
    
     | 枚举名称 | 
     枚举值 | 
     枚举说明 | 
    
   
   
    
     | HWM_MEDIA_TYPE_AUDIO | 
     0 | 
     音频类型 | 
    
    
     | HWM_MEDIA_TYPE_VIDEO | 
     1 | 
     视频类型 | 
    
   
  
  
 
  
   
    表5 Timezone枚举说明
   
   
    
     | 枚举名称 | 
     枚举值 | 
     枚举说明 | 
    
   
   
    
     | HWM_TIMEZONE_DEFAULT | 
     0 | 
     Mediax默认时区值 | 
    
    
     | HWM_TIMEZONE_INTERDATE_LINE | 
     1 | 
     日界线西 | 
    
    
     | HWM_TIMEZONE_MIDWAY_ISLAND | 
     2 | 
     中途岛,萨摩亚群岛 | 
    
    
     | HWM_TIMEZONE_HAWAII | 
     3 | 
     夏威夷 | 
    
    
     | HWM_TIMEZONE_ALASKA | 
     4 | 
     阿拉斯加 | 
    
    
     | HWM_TIMEZONE_PACIFIC_TIME | 
     5 | 
     太平洋时间(美国和加拿大);蒂华纳 | 
    
    
     | HWM_TIMEZONE_ARIZONA | 
     6 | 
     亚利桑那 | 
    
    
     | HWM_TIMEZONE_MOUNTAIN_TIME | 
     7 | 
     山地时间(美国和加拿大) | 
    
    
     | HWM_TIMEZONE_CENTRAL_AMERICA | 
     8 | 
     中美洲 | 
    
    
     | HWM_TIMEZONE_CENTRAL_TIME | 
     9 | 
     中间时间(美国和加拿大) | 
    
    
     | HWM_TIMEZONE_MEXICO_CITY | 
     10 | 
     墨西哥城 | 
    
    
     | HWM_TIMEZONE_SASKATCHEWAN | 
     11 | 
     萨斯喀彻温 | 
    
    
     | HWM_TIMEZONE_BOGOTA | 
     12 | 
     波哥大,利马,基多 | 
    
    
     | HWM_TIMEZONE_EASTERN_TIME | 
     13 | 
     东部时间(美国和加拿大) | 
    
    
     | HWM_TIMEZONE_INDIANA | 
     14 | 
     印第安纳(东部) | 
    
    
     | HWM_TIMEZONE_ATLANTIC_TIME | 
     15 | 
     大西洋时间(加拿大) | 
    
    
     | HWM_TIMEZONE_CARACAS | 
     16 | 
     加拉加斯,拉巴斯 | 
    
    
     | HWM_TIMEZONE_SANTIAGO | 
     17 | 
     圣地亚哥 | 
    
    
     | HWM_TIMEZONE_NEWFOUNDLAND | 
     18 | 
     纽芬兰 | 
    
    
     | HWM_TIMEZONE_BRASILIA | 
     19 | 
     巴西利亚 | 
    
    
     | HWM_TIMEZONE_BUENOS_AIRES | 
     20 | 
     布宜诺斯艾利斯,乔治敦 | 
    
    
     | HWM_TIMEZONE_GREENLAND | 
     21 | 
     格陵兰 | 
    
    
     | HWM_TIMEZONE_MID_ATLANTIC | 
     22 | 
     中大西洋 | 
    
    
     | HWM_TIMEZONE_AZORES | 
     23 | 
     亚速尔群岛 | 
    
    
     | HWM_TIMEZONE_CAPEVERDE | 
     24 | 
     佛得角群岛 | 
    
    
     | HWM_TIMEZONE_MONROVIA | 
     25 | 
     蒙罗维亚 | 
    
    
     | HWM_TIMEZONE_GREENWICH_MEANTIME | 
     26 | 
     格林威治标准时:都柏林,爱丁堡,里斯本,伦敦 | 
    
    
     | HWM_TIMEZONE_AMSTERDAM | 
     27 | 
     阿姆斯特丹,柏林,伯尔尼,罗马,斯德哥尔摩,维也纳 | 
    
    
     | HWM_TIMEZONE_BELGRADE | 
     28 | 
     贝尔格莱德,布拉迪斯拉发,布达佩斯,卢布尔亚纳,布拉格 | 
    
    
     | HWM_TIMEZONE_BRUSSELS | 
     29 | 
     布鲁塞尔,哥本哈根,马德里,巴黎 | 
    
    
     | HWM_TIMEZONE_SARAJEVO | 
     30 | 
     萨拉热窝,斯科普里,维尔纽斯,索非亚,华沙,萨格勒布 | 
    
    
     | HWM_TIMEZONE_WESTCENTRAL_AFRICA | 
     31 | 
     中非西部 | 
    
    
     | HWM_TIMEZONE_ATHENS | 
     32 | 
     雅典,伊斯坦布尔,明斯克 | 
    
    
     | HWM_TIMEZONE_BUCHAREST | 
     33 | 
     布加勒斯特 | 
    
    
     | HWM_TIMEZONE_CAIRO | 
     34 | 
     开罗 | 
    
    
     | HWM_TIMEZONE_HARARE | 
     35 | 
     哈拉雷,比勒陀利亚 | 
    
    
     | HWM_TIMEZONE_HELSINKI | 
     36 | 
     赫尔辛基,里加,塔林 | 
    
    
     | HWM_TIMEZONE_JERUSALEM | 
     37 | 
     耶路撒冷 | 
    
    
     | HWM_TIMEZONE_BAGHDAD | 
     38 | 
     巴格达 | 
    
    
     | HWM_TIMEZONE_KUWAIT | 
     39 | 
     科威特,利雅得 | 
    
    
     | HWM_TIMEZONE_MOSCOW | 
     40 | 
     莫斯科,圣彼得堡,喀山,伏尔加格勒 | 
    
    
     | HWM_TIMEZONE_NAIROBI | 
     41 | 
     内罗毕 | 
    
    
     | HWM_TIMEZONE_TEHRAN | 
     42 | 
     德黑兰 | 
    
    
     | HWM_TIMEZONE_ABU_DHABI | 
     43 | 
     阿布扎比,马斯喀特 | 
    
    
     | HWM_TIMEZONE_TBILISI | 
     44 | 
     第比利斯,埃里温 | 
    
    
     | HWM_TIMEZONE_KABUL | 
     45 | 
     喀布尔 | 
    
    
     | HWM_TIMEZONE_EKATERINBURG | 
     46 | 
     叶卡捷琳堡 | 
    
    
     | HWM_TIMEZONE_ISLAMABAD | 
     47 | 
     伊斯兰堡,卡拉奇,塔什干 | 
    
    
     | HWM_TIMEZONE_CALCUTTA | 
     48 | 
     加尔各答,马德拉斯,孟买,新德里 | 
    
    
     | HWM_TIMEZONE_KATHMANDU | 
     49 | 
     加德满都 | 
    
    
     | HWM_TIMEZONE_ALMATY | 
     50 | 
     阿拉木图 | 
    
    
     | HWM_TIMEZONE_ASTANA | 
     51 | 
     阿斯塔纳,达卡 | 
    
    
     | HWM_TIMEZONE_SRIJAYA | 
     52 | 
     斯里哈亚华登尼普拉 | 
    
    
     | HWM_TIMEZONE_RANGOON | 
     53 | 
     仰光 | 
    
    
     | HWM_TIMEZONE_BANGKOK | 
     54 | 
     曼谷,雅加达,河内 | 
    
    
     | HWM_TIMEZONE_NOVOSIBIRSK | 
     55 | 
     新西伯利亚 | 
    
    
     | HWM_TIMEZONE_BEIJING | 
     56 | 
     北京,重庆,香港,乌鲁木齐,台北 | 
    
    
     | HWM_TIMEZONE_KRASNOYARSK | 
     57 | 
     克拉斯诺亚尔斯克,乌兰巴托 | 
    
    
     | HWM_TIMEZONE_KUALA_LUMPUR | 
     58 | 
     吉隆坡,新加坡 | 
    
    
     | HWM_TIMEZONE_PERTH | 
     59 | 
     珀斯 | 
    
    
     | HWM_TIMEZONE_OSAKA | 
     60 | 
     东京,大阪,札幌 | 
    
    
     | HWM_TIMEZONE_SEOUL | 
     61 | 
     汉城 | 
    
    
     | HWM_TIMEZONE_YAKUTSK | 
     62 | 
     雅库茨克 | 
    
    
     | HWM_TIMEZONE_ADELAIDE | 
     63 | 
     阿德莱德 | 
    
    
     | HWM_TIMEZONE_DARWIN | 
     64 | 
     达尔文 | 
    
    
     | HWM_TIMEZONE_BRISBANE | 
     65 | 
     布里斯班 | 
    
    
     | HWM_TIMEZONE_CANBERRA | 
     66 | 
     堪培拉,墨尔本,悉尼 | 
    
    
     | HWM_TIMEZONE_GUAM | 
     67 | 
     关岛,莫尔兹比港 | 
    
    
     | HWM_TIMEZONE_HOBART | 
     68 | 
     霍巴特 | 
    
    
     | HWM_TIMEZONE_VLADIVOSTOK | 
     69 | 
     符拉迪沃斯托克 | 
    
    
     | HWM_TIMEZONE_SOLOMON | 
     70 | 
     所罗门群岛,新喀里多尼亚 | 
    
    
     | HWM_TIMEZONE_AUCKLAND | 
     71 | 
     奥克兰,惠灵顿 | 
    
    
     | HWM_TIMEZONE_FIJI | 
     72 | 
     富士,堪察加半岛,马绍尔群岛 | 
    
    
     | HWM_TIMEZONE_NUKUALOFA | 
     73 | 
     努库阿洛法 | 
    
    
     | HWM_TIMEZONE_IRKUTSK | 
     74 | 
     伊尔库茨克 | 
    
    
     | HWM_TIMEZONE_CASABLANCA | 
     75 | 
     卡萨布兰卡 | 
    
    
     | HWM_TIMEZONE_BAKU | 
     76 | 
     巴库 | 
    
    
     | HWM_TIMEZONE_MAGADAN | 
     77 | 
     马加丹 | 
    
   
  
  
 
  
   
    表6 ConfAllowJoinUserType枚举说明
   
   
    
     | 枚举名称 | 
     枚举值 | 
     枚举说明 | 
    
   
   
    
     | CONF_ALLOW_JOIN_ANYONE | 
     0 | 
     所有用户。 | 
    
    
     | CONF_ALLOW_JOIN_LOGINED_USER | 
     1 | 
     已登录用户。 | 
    
    
     | CONF_ALLOW_JOIN_IN_COMPANY_USER | 
     2 | 
     企业内用户。 | 
    
    
     | CONF_ALLOW_JOIN_INVITED_USER | 
     3 | 
     被邀请用户。 | 
    
   
  
  
 
  
   
    表7 VmrConfIdType枚举说明
   
   
    
     | 枚举名称 | 
     枚举值 | 
     枚举说明 | 
    
   
   
    
     | HWM_VMR_CONF_ID_TYPE_FIXED | 
     0 | 
     云会议室的会议ID类型是固定类型。 | 
    
    
     | HWM_VMR_CONF_ID_TYPE_RANDOM | 
     1 | 
     云会议室的会议ID类型是随机类型。 | 
    
   
  
  
 
  
   
    表8 AttendeeBaseInfo
   
   
    
     | 参数名称 | 
     是否必选 | 
     参数类型 | 
     参数说明 | 
    
   
   
    
     | nickName | 
     Y | 
     string | 
     与会者名称。 | 
    
    
     | number | 
     Y | 
     string | 
     号码。如果填分配给账号的sip号码(如+99111244216210249)则呼叫该账号的App; 如果填PSTN号码(如18700000000),则通过VoIP网关呼叫该号码,前提是该企业已开通PSTN呼叫权限。 与thirdUserId二选一,账号密码鉴权时使用。 | 
    
    
     | thirdUserId | 
     Y | 
     string | 
     第三方用户ID。与number二选一,App ID鉴权时使用。 | 
    
    
     | accountId | 
     N | 
     string | 
     华为云会议账号 | 
    
    
     | email | 
     N | 
     string | 
     电子邮箱地址,用于发送邮件通知。 | 
    
    
     | sms | 
     N | 
     string | 
     短信通知手机号码,用于发送短信通知。 | 
    
    
     | isAutoInvite | 
     N | 
     boolean | 
     是否自动外邀。 | 
    
    
     | isMute | 
     N | 
     boolean | 
     是否闭音。 | 
    
    
     | role | 
     N | 
     ConfRole | 
     会议角色。 | 
    
    
     | type | 
     N | 
     AttendeeType | 
     成员类型 | 
    
    
     | userUuid | 
     N | 
     string | 
     与会者uuid | 
    
    
     | corpId | 
     N | 
     string | 
     企业id | 
    
    
     | autoInviteType | 
     N | 
     AutoInviteType | 
     自动邀请类型(仅创建会议生效) | 
    
   
  
  
 
  
   
    表9 ConfRole枚举说明
   
   
    
     | 枚举名称 | 
     枚举值 | 
     枚举说明 | 
    
   
   
    
     | HWM_CONF_ROLE_ATTENDEE | 
     0 | 
     普通与会者 | 
    
    
     | HWM_CONF_ROLE_HOST | 
     1 | 
     主持人 | 
    
    
     | HWM_CONF_ROLE_AUDIENCE | 
     2 | 
     观众 | 
    
    
     | HWM_CONF_ROLE_COHOST | 
     3 | 
     联席主持人 | 
    
    
     | HWM_CONF_ROLE_WAITING | 
     4 | 
     等候室成员 | 
    
   
  
  
 
  
   
    表10 AttendeeType枚举说明
   
   
    
     | 枚举名称 | 
     枚举值 | 
     枚举说明 | 
    
   
   
    
     | ATTENDEE_TYPE_NORMAL | 
     0 | 
     语音、高清、标清与会者地址 | 
    
    
     | ATTENDEE_TYPE_TELEPRESENCE | 
     1 | 
     智真与会者地址类型,单屏、三屏智真均属此类 | 
    
    
     | ATTENDEE_TYPE_TERMINAL | 
     2 | 
     会议室或硬终端 | 
    
    
     | ATTENDEE_TYPE_OUTSIDE | 
     3 | 
     外部与会人 | 
    
    
     | ATTENDEE_TYPE_CUSTOMNUMBER | 
     4 | 
     custom number | 
    
    
     | ATTENDEE_TYPE_MOBILE | 
     5 | 
     软终端用户手机 | 
    
    
     | ATTENDEE_TYPE_ANONYMOUS | 
     6 | 
     匿名用户 | 
    
    
     | ATTENDEE_TYPE_TELEPHONE | 
     7 | 
     电话用户 | 
    
    
     | ATTENDEE_TYPE_BOARD | 
     8 | 
     白板用户 | 
    
    
     | ATTENDEE_TYPE_IDEAHUB | 
     9 | 
     海思芯片的大屏设备 | 
    
    
     | ATTENDEE_TYPE_HWVISION | 
     10 | 
     智慧屏 | 
    
    
     | ATTENDEE_TYPE_WELINKC | 
     11 | 
     welink大众版 | 
    
   
  
  
 
  
   
    表11 AutoInviteType枚举说明
   
   
    
     | 枚举名称 | 
     枚举值 | 
     枚举说明 | 
    
   
   
    
     | AUTO_INVITE_NONE | 
     0 | 
     不设置(默认自动邀请) | 
    
    
     | AUTO_INVITE_OPEN | 
     1 | 
     自动邀请开启 | 
    
    
     | AUTO_INVITE_CLOSE | 
     2 | 
     自动邀请关闭 | 
    
   
  
  
 
  
   
    表12 ConfResType枚举说明
   
   
    
     | 枚举名称 | 
     枚举值 | 
     枚举说明 | 
    
   
   
    
     | HWM_CONF_RESTYPE_DEFAULT | 
     0 | 
     默认 | 
    
    
     | HWM_CONF_RESTYPE_SHARE_VMR | 
     3 | 
     共享vmr | 
    
   
  
  
 
  
   
    表13 SummaryState枚举说明
   
   
    
     | 枚举名称 | 
     枚举值 | 
     枚举说明 | 
    
   
   
    
     | SUMMARY_STATE_CLOSE | 
     0 | 
     会议纪要关闭 | 
    
    
     | SUMMARY_STATE_OPEN | 
     1 | 
     会议纪要开启 | 
    
   
  
  
 
  
   
    表14 AutoMuteType枚举说明
   
   
    
     | 枚举名称 | 
     枚举值 | 
     枚举说明 | 
    
   
   
    
     | AUTO_MUTE_TYPE_DEFAULT | 
     0 | 
     默认 | 
    
    
     | AUTO_MUTE_TYPE_MUTE | 
     1 | 
     静音 | 
    
    
     | AUTO_MUTE_TYPE_UNMUTE | 
     2 | 
     非静音 | 
    
   
  
  
 
 
  回调方法参数说明:
  (ret: SDKERR, reason: string) => void
  
   
    
     表15 入参说明
    
    
     
      | 参数名称 | 
      参数类型 | 
      参数说明 | 
     
    
    
     
      | ret | 
      SDKERR 请参考错误码参考 | 
      错误码 | 
     
     
      | reason | 
      string | 
      错误描述 |