接口功能
该接口用于创建即时会议。注意事项：1、该接口默认已将自己作为主持人加入会议，调用接口时，在与会者参数中不需要带上自己的信息； 2、若需要在创建会议的同时邀请其他与会者，需要传入其他与会者信息。若不需要，与会者信息和与会者个数可以为空。
函数原型
createConf(createConfInfo: CreateConfInfo, onCreateConfResult?: (ret: SDKERR, reason: string, createConfResult: CreateConfResult) => void): void
请求参数
表1 入参说明
| 参数名称 |
是否必选 |
参数类型 |
参数说明 |
| createConfInfo |
Y |
CreateConfInfo |
创会信息 |
| onCreateConfResult |
Y |
(ret: SDKERR, reason: string, createConfResult: CreateConfResult) => void |
创建会议回调 |
表2 CreateConfInfo
| 参数名称 |
是否必选 |
参数类型 |
参数说明 |
| subject |
Y |
string |
会议主题。 |
| mediaType |
Y |
MediaType |
会议类型。 |
| needPassword |
Y |
boolean |
是否需要来宾密码（仅对随机会议ID生效）。 |
| isAutoRecord |
N |
boolean |
是否开启自动录制会议。开启自动录制会议开关，内部会默认支持录制会议，录制会议开关的打开与关闭并不影响。 说明：仅对云录制生效，客户端本地录制不生效。 |
| allowRecord |
N |
boolean |
是否支持录制会议。(仅对win平台生效) 说明：仅对云录制生效，客户端本地录制不生效。 |
| confAllowJoinUser |
N |
ConfAllowJoinUserType |
允许入会范围限制。默认所有用户。 |
| vmrId |
N |
string |
云会议室唯一ID。预约随机会议时，设置为空字符串。 |
| vmrConfIdType |
N |
VmrConfIdType |
云会议室的会议ID类型 |
| guestPwd |
N |
string |
来宾密码，如果空则服务器随机生成（仅对随机会议ID生效）。 |
| isOpenWaitingRoom |
N |
boolean |
等候室开启开关。 说明：需要等候室功能开通后才能生效 |
| duration |
N |
number |
会议时长，单位分钟，最小值15分钟，最大值1440分钟。 注：不填时由服务端取默认会议时长 |
| isMicOn |
N |
boolean |
是否开启麦克风，true开启麦克风；false关闭麦克风。 |
| isCameraOn |
N |
boolean |
是否开启摄像头，true开启摄像头；false关闭摄像头。 |
| concurrentParticipants |
N |
number |
会议方数，会议最大与会人数限制. 0: 无限制, 大于0: 会议最大与会人数 |
| numOfAttendee |
Y |
number |
与会者个数。若不需要带与会者，参数值可以为0。 |
| attendees |
Y |
AttendeeBaseInfo |
与会者信息。若不需要带与会者，参数值可以为空。 |
| customInfo |
N |
string |
用户自定义信息。 |
| confResType |
N |
ConfResType |
会议资源类型 |
| defaultSummaryState |
N |
SummaryState |
会议云录制是否包含纪要，初始值(仅对win平台生效) |
| autoMuteMode |
N |
AutoMuteType |
来宾入会，软终端是否自动静音 |
| hardTerminalAutoMuteMode |
N |
AutoMuteType |
来宾入会，硬终端是否自动静音 |
表3 MediaType枚举说明
| 枚举名称 |
枚举值 |
枚举说明 |
| HWM_MEDIA_TYPE_AUDIO |
0 |
音频类型 |
| HWM_MEDIA_TYPE_VIDEO |
1 |
视频类型 |
表4 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 |
被邀请用户。 |
表5 VmrConfIdType枚举说明
| 枚举名称 |
枚举值 |
枚举说明 |
| HWM_VMR_CONF_ID_TYPE_FIXED |
0 |
云会议室的会议ID类型是固定类型。 |
| HWM_VMR_CONF_ID_TYPE_RANDOM |
1 |
云会议室的会议ID类型是随机类型。 |
表6 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 |
表7 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 |
等候室成员 |
表8 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大众版 |
表9 ConfResType枚举说明
| 枚举名称 |
枚举值 |
枚举说明 |
| HWM_CONF_RESTYPE_DEFAULT |
0 |
默认 |
| HWM_CONF_RESTYPE_SHARE_VMR |
3 |
共享vmr |
表10 SummaryState枚举说明
| 枚举名称 |
枚举值 |
枚举说明 |
| SUMMARY_STATE_CLOSE |
0 |
会议纪要关闭 |
| SUMMARY_STATE_OPEN |
1 |
会议纪要开启 |
表11 AutoMuteType枚举说明
| 枚举名称 |
枚举值 |
枚举说明 |
| AUTO_MUTE_TYPE_DEFAULT |
0 |
默认 |
| AUTO_MUTE_TYPE_MUTE |
1 |
静音 |
| AUTO_MUTE_TYPE_UNMUTE |
2 |
非静音 |
回调方法参数说明：
(ret: SDKERR, reason: string, createConfResult: CreateConfResult) => void
表12 入参说明
| 参数名称 |
参数类型 |
参数说明 |
| ret |
SDKERR 请参考错误码参考 |
错误码 |
| reason |
string |
错误描述 |
| createConfResult |
CreateConfResult |
创建会议结果 |
表13 CreateConfResult
| 参数名称 |
参数类型 |
参数说明 |
| confId |
string |
会议id |
| vmrConfId |
string |
VMR会议id(仅对mac平台生效) |
| hostPwd |
string |
主持人密码 |
| guestPwd |
string |
来宾密码 |
| mediaType |
MediaType |
会议媒体类型(仅对mac平台生效) |
| guestJoinUri |
string |
来宾链接 |
| selfConfRole |
ConfRole |
本人在会议中的角色 |
| subject |
string |
会议主题 |
| startTime |
number |
（已废弃，推荐使用字段startTimeStamp）会议开始时间，精度秒(0时区) |
| endTime |
number |
（已废弃，推荐使用字段endTimeStamp）会议结束时间 |
| startTimeStamp |
number |
会议开始时间(时间戳，单位秒) |
| endTimeStamp |
number |
会议结束时间(时间戳，单位秒) |
| schedulerName |
string |
预约者名字 |
| customInfo |
string |
自定义扩展信息 |
