函数原型
startP2pConf(startCallInfo: StartCallInfo, onStartP2pConfResult?: (ret: SDKERR, reason: string, createConfResult: CreateConfResult) => void): void
请求参数
表1 入参说明
参数名称 |
是否必选 |
参数类型 |
参数说明 |
startCallInfo |
Y |
StartCallInfo |
创建立即会议信息 |
onStartP2pConfResult |
Y |
(ret: SDKERR, reason: string, createConfResult: CreateConfResult) => void |
发起立即会议回调 |
表2 StartCallInfo
参数名称 |
是否必选 |
参数类型 |
参数说明 |
callerInfo |
Y |
CallerInfo |
主叫信息 |
calleeInfo |
Y |
CalleeInfo |
被叫信息 |
mediaType |
Y |
MediaType |
媒体类型 |
isGuestJoinConfWithoutPwd |
N |
boolean |
是否来宾免密 |
confAllowJoinUser |
N |
ConfAllowJoinUserType |
允许入会范围限制。默认所有用户。 |
表3 CallerInfo
参数名称 |
是否必选 |
参数类型 |
参数说明 |
nickName |
N |
string |
主叫姓名 |
表4 CalleeInfo
参数名称 |
是否必选 |
参数类型 |
参数说明 |
nickName |
N |
string |
被叫姓名 |
number |
Y |
string |
被叫号码,如果填分配给账号的sip号码(如+99111244216210249)则呼叫该账号的App; 如果填PSTN号码(如18700000000),则通过VoIP网关呼叫该号码,前提是该企业已开通PSTN呼叫权限。 与thirdUserId二选一(优先级 : number>thirdUserId),账号密码鉴权时使用。 |
thirdUserId |
Y |
string |
被叫三方账号,与number二选一(优先级 : number>thirdUserId),appId鉴权时使用 |
userUuid |
N |
string |
与会者uuid |
type |
N |
AttendeeType |
成员类型 |
表5 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大众版 |
表6 MediaType枚举说明
枚举名称 |
枚举值 |
枚举说明 |
HWM_MEDIA_TYPE_AUDIO |
0 |
音频类型 |
HWM_MEDIA_TYPE_VIDEO |
1 |
视频类型 |
表7 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 |
被邀请用户。 |
回调方法参数说明:
(ret: SDKERR, reason: string, createConfResult: CreateConfResult) => void
表8 入参说明
参数名称 |
参数类型 |
参数说明 |
ret |
SDKERR 请参考错误码参考 |
错误码 |
reason |
string |
错误描述 |
createConfResult |
CreateConfResult |
创建会议结果 |
表9 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 |
自定义扩展信息 |
表10 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 |
等候室成员 |