获取会议详情

接口功能

该接口用于获取会议的详细信息。注意事项：1、该接口在已登录状态下才能调用。

函数原型

getConfDetail(getConfDetailParam: GetConfDetailParam, onGetConfDetailResult?: (ret: SDKERR, reason: string, confDetail: ConfDetail) => void): void

请求参数

表1 入参说明
参数名称	是否必选	参数类型	参数说明
getConfDetailParam	Y	GetConfDetailParam	获取会议详情的参数体
onGetConfDetailResult	Y	(ret: SDKERR, reason: string, confDetail: ConfDetail) => void	会议详情通知，获取会议详情返回

表2 GetConfDetailParam
参数名称	是否必选	参数类型	参数说明
confId	Y	string	会议ID。

返回值

void

回调方法参数说明：

(ret: SDKERR, reason: string, confDetail: ConfDetail) => void

表3 入参说明
参数名称	参数类型	参数说明
ret	SDKERR 请参考错误码参考	错误码
reason	string	错误描述
confDetail	ConfDetail	会议详情

表4 ConfDetail
参数名称	参数类型	参数说明
confListInfo	ConfListItem	会议基本信息
vmrId	string	云会议室唯一ID。
vmrFlag	boolean	是否是vmr会议。
isAutoRecord	boolean	是否开启自动录制会议。
allowRecord	boolean	是否支持录制会议
allowLive	boolean	保留。编辑会议时透传会议详情此字段
needPassword	boolean	是否需要密码。
isSendSms	boolean	是否发送短信通知。
isSendEmail	boolean	是否发送邮件通知。
isSendCalendar	boolean	是否发送日历通知。
confAllowJoinUser	ConfAllowJoinUserType	会议准入设置。
attendees	Array<AttendeeBaseInfo>	与会者列表。
isOpenWaitingRoom	boolean	是否开启等候室
allowGuestStartConf	boolean	允许来宾启动会议
forbiddenScreenShots	boolean	是否禁止截屏
allowGuestStartConfTime	number	允许来宾提前入会时间范围(单位：分钟) 0-随时，n-提前n分钟启动会议
vmrConfIdType	VmrConfIdType	云会议室的会议ID类型
concurrentParticipants	number	会议方数，会议最大与会人数限制. 0: 无限制, 大于0: 会议最大与会人数
defaultSummaryState	SummaryState	会议云录制是否包含纪要，初始值（周期会议暂不支持）
autoMuteMode	AutoMuteType	软终端是否自动静音
hardTerminalAutoMuteMode	AutoMuteType	硬终端是否自动静音
supportWatermark	boolean	是否支持水印
autoPublishSummary	boolean	是否自动发布纪要（免人工审核）

表5 ConfListItem
参数名称	参数类型	参数说明
confId	string	会议ID。
subject	string	会议主题。
hostPwd	string	主持人密码。
guestPwd	string	来宾密码。
audiencePwd	string	观众密码。(仅对win平台生效)
startTime	number	（已废弃，推荐使用字段startTimeStamp）会议开始时间(utc时间)，单位秒。
endTime	number	（已废弃，推荐使用字段endTimeStamp）会议结束时间(utc时间)，单位秒。
startTimeStamp	number	会议开始时间(时间戳，单位秒)
endTimeStamp	number	会议结束时间(时间戳，单位秒)
timezone	Timezone	时区码(仅对win平台生效)
mediaType	MediaType	媒体类型
schedulerName	string	会议预定者名称。
vmrConfId	string	用于云会议显示的ID。
hostJoinUri	string	主持人加入会议uri链接
guestJoinUri	string	来宾加入会议uri链接
audienceJoinUri	string	观众加入会议的链接(仅对win平台生效)
confStateType	ConfState	会议状态(仅对win平台生效)
isWebinar	boolean	是否是网络研讨会(仅对win平台生效)
selfConfRole	ConfRole	本人在会议中的角色
conferenceType	ConferenceType	会议类型
cycleParam	CycleConfParam	周期会议的参数
subConfParam	Array<SubCycleConfParam>	周期子会议参数
customInfo	string	用户自定义信息。

表6 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	马加丹

表7 MediaType枚举说明
枚举名称	枚举值	枚举说明
HWM_MEDIA_TYPE_AUDIO	0	音频类型
HWM_MEDIA_TYPE_VIDEO	1	视频类型

表8 ConfState枚举说明
枚举名称	枚举值	枚举说明
HWM_CONF_STATE_SCHEDULE	0	预定状态。
HWM_CONF_STATE_CREATING	1	正在创建状态。
HWM_CONF_STATE_GOING	2	会议已经开始。
HWM_CONF_STATE_DESTROYED	3	会议已经关闭。

表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** ConferenceType枚举说明
枚举名称	枚举值	枚举说明
HWM_CONF_TYPE_COMMON	0	普通会议
HWM_CONF_TYPE_CYCLE	1	周期会议

**表11** CycleConfParam
参数名称	参数类型	参数说明
startDate	number	（已废弃，推荐使用字段startTimeStamp）开始日期-时间戳，精度秒(0时区)
endDate	number	（已废弃，推荐使用字段endTimeStamp）结束日期-时间戳，精度秒(0时区)
startTimeStamp	number	开始时间，startTimeStamp、startDate二选一，优先使用startTimeStamp(时间戳，单位秒)
endTimeStamp	number	结束时间，endTimeStamp、endDate二选一，优先使用endTimeStamp(时间戳，单位秒)
cycleType	CycleType	周期类型
interval	number	周期区间 1、周期类型选择了按天，表示每几天召开一次，取值范围[1,15]；2、周期类型选择了Week，表示每几周召开一次，取值范围[1,5]；3、周期类型选择了Month，interval表示隔几月，取值范围[1,3]
listPoints	string	周期内的会议召开点。仅当按周和月时有效。数据格式(中间用逗号隔开):1,3,5,7
preRemindDays	number	周期子会议提前通知天数。

**表12** CycleType枚举说明
枚举名称	枚举值	枚举说明
CYCLE_TYPE_DAY	0	以天为周期
CYCLE_TYPE_WEEK	1	以周为周期
CYCLE_TYPE_MONTH	2	以月为周期

**表13** SubCycleConfParam
参数名称	参数类型	参数说明
subConfID	string	子会议唯一标识UUID
mediaType	MediaType	媒体类型
startTime	number	（已废弃，推荐使用字段startTimeStamp）会议起始时间
endTime	number	（已废弃，推荐使用字段endTimeStamp）会议结束时间
startTimeStamp	number	会议开始时间(时间戳，单位秒)
endTimeStamp	number	会议结束时间(时间戳，单位秒)
isAutoRecord	boolean	会议开始后是否自动开启录制
recordAuthType	RecordAuthType	录播鉴权方式
confAllowJoinUser	ConfAllowJoinUserType	允许入会范围限制。默认所有用户。
allowGuestStartConf	boolean	允许来宾启动会议
allowGuestStartConfTime	number	允许来宾提前入会时间范围(单位：分钟) 0-随时，n-提前n分钟启动会议

**表14** RecordAuthType枚举说明
枚举名称	枚举值	枚举说明
REOCRD_AUTH_TYPE_ANYONE	0	可通过连接观看/下载（不拼接nonce）
REOCRD_AUTH_TYPE_IN_COMPANY_USER	1	企业用户可观看/下载
REOCRD_AUTH_TYPE_ATTENDEE	2	与会者可观看/下载

**表15** 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	被邀请用户。

**表16** AttendeeBaseInfo
参数名称	参数类型	参数说明
nickName	string	与会者名称。
number	string	号码。如果填分配给账号的sip号码（如+99111244216210249）则呼叫该账号的App；如果填PSTN号码（如18700000000），则通过VoIP网关呼叫该号码，前提是该企业已开通PSTN呼叫权限。与thirdUserId二选一，账号密码鉴权时使用。
thirdUserId	string	第三方用户ID。与number二选一，App ID鉴权时使用。
accountId	string	云会议账号
email	string	电子邮箱地址，用于发送邮件通知。
sms	string	短信通知手机号码，用于发送短信通知。
isAutoInvite	boolean	是否自动外邀。
isMute	boolean	是否闭音。
role	ConfRole	会议角色。
type	AttendeeType	成员类型
userUuid	string	与会者uuid
corpId	string	企业id
autoInviteType	AutoInviteType	自动邀请类型（仅创建会议生效）

**表17** 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大众版