发起立即会议呼叫
startP2PConf
接口描述
该接口用于发起立即会议呼叫。
方法定义
1 | startP2PConf(p2pParam: HWMP2PCallParam): Promise<HWMCreateConfResult>; |
参数描述
| 参数 | 是否必须 | 类型 | 描述 |
|---|---|---|---|
| p2pParam | 是 | HWMP2PCallParam | 发起立即会议呼叫信息。 |
| 参数 | 是否必须 | 类型 | 描述 |
|---|---|---|---|
| calleeInfo | 是 | 被叫信息。 | |
| callerInfo | 否 | 主叫信息。 | |
| mediaType | 是 | 参数解释: 会议媒体类型。 约束限制: 仅支持视频会议,填HWM_CONF_MEDIA_VIDEO 默认取值: 不涉及 | |
| isGuestJoinConfWithoutPwd | 否 | boolean | 参数解释: 是否来宾免密。 约束限制: 不涉及 默认取值: false 来宾不免密 |
| confAllowJoinUser | 否 | 参数解释: 允许入会范围限制。 约束限制: 不涉及 默认取值: HWM_CONF_ALLOW_JOIN_ANYONE 所有用户。 | |
| isSpeakerOff | 否 | boolean | 参数解释: 移动端:true-打开听筒,false-打开扬声器; PC端:true-关闭扬声器,false-打开扬声器。 约束限制: 不涉及 默认取值: false。 |
| 参数 | 是否必须 | 类型 | 描述 |
|---|---|---|---|
| nickName | 是 | string | 参数解释: 被叫名称。 约束限制: 不涉及 取值范围: 0-256个字符 默认取值: 不涉及 |
| number | 是 | string | 参数解释: 号码。 约束限制:
取值范围: 0-128个字符 默认取值: 不涉及 |
| thirdUserId | 否 | string | 参数解释: 第三方用户ID。 约束限制: 与number二选一,App ID鉴权时使用。 取值范围: 0-129个字符 默认取值: 不涉及 |
| corpId | 否 | string | 参数解释: 企业id。 约束限制: 不涉及 取值范围: 0-32个字符 默认取值: 不涉及 |
| 参数 | 是否必须 | 类型 | 描述 |
|---|---|---|---|
| nickName | 否 | string | 参数解释: 主叫名称。 约束限制: 不涉及 取值范围: 0-256个字符 默认取值: 不涉及 |
返回值
示例代码
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | /** * 发起立即会议呼叫 */ handleStartP2pConf(){ const callee: HWMP2PCalleeInfo = { nickName: this.nickName, number: this.sipNumber }; const p2pConf: HWMP2PCallParam = { calleeInfo: callee }; UISDK.getConfCtrlApi().startP2PConf(p2pConf).then((res) => { const message: string = res.result === SDKERR.HWM_SDKERR_SUCCESS ? '发起立即会议成功' : '发起立即会议失败'; console.log(message); }); } |