Updated on 2024-12-27 GMT+08:00

Starting an Instant Meeting

Function

This API is used to start an instant meeting.

Function Prototype

startP2pConf(startCallInfo: StartCallInfo, onStartP2pConfResult?: (ret: SDKERR, reason: string, createConfResult: CreateConfResult) => void): voidstartP2pConf(startCallInfo: StartCallInfo, onStartP2pConfResult?: (ret: SDKERR, reason: string, createConfResult: CreateConfResult) => void): void

Request Parameters

Table 1 Input parameter description
Parameter Mandatory Type Description
startCallInfo Yes StartCallInfo Information about starting an instant meeting.
onStartP2pConfResult Yes (ret: SDKERR, reason: string, createConfResult: CreateConfResult) => void Callback of starting the instant meeting.
Table 2 StartCallInfo
Parameter Mandatory Type Description
callerInfo Yes CallerInfo Caller information.
calleeInfo Yes CalleeInfo Called participant information.
mediaType Yes MediaType Media type.
Table 3 CallerInfo
Parameter Mandatory Type Description
nickName No string Caller name.
Table 4 CalleeInfo
Parameter Mandatory Type Description
nickName No string Called participant name.
number Yes string Called number. If this parameter is set to the SIP number (for example, +99111244216210249) allocated to the account, the Huawei Cloud Meeting app is called. If this parameter is set to a PSTN number (for example, 18700000000), the number is called through the VoIP gateway if the enterprise has enabled PSTN call. This parameter is used for account and password authentication. Either this parameter or thirdUserId must be set (number is prior to thirdUserId).
thirdUserId Yes string Third-party account of the called participant. Either this parameter or number is used. The priority is as follows: number > thirdUserId. This parameter is used for app ID authentication.
userUuid No string Participant UUID.
Table 5 Enumerated values of MediaType
Enumeration Name Enumerated Value Description
HWM_MEDIA_TYPE_AUDIO 0 Audio.
HWM_MEDIA_TYPE_VIDEO 1 Video.

Return Values

void

Callback Method Parameters

(ret: SDKERR, reason: string, createConfResult: CreateConfResult) => void

Table 6 Input parameter description
Parameter Type Description
ret For details about SDKERR, see Error Code Reference. Error code.
reason string Error description.
createConfResult CreateConfResult Meeting creation result.
Table 7 CreateConfResult
Parameter Type Description
confId string Meeting ID.
vmrConfId string Cloud meeting room ID (valid only for the macOS platform).
hostPwd string Host password.
guestPwd string Guest password.
mediaType MediaType Meeting media type (valid only for the macOS platform).
guestJoinUri string Guest link.
selfConfRole ConfRole Role in the meeting.
subject string Meeting topic.
startTime number (Discarded. The startTimeStamp field is recommended.) Meeting start time, accurate to seconds (UTC).
endTime number (Discarded. The endTimeStamp field is recommended.) Meeting end time.
startTimeStamp number Meeting start time (timestamp, in seconds).
endTimeStamp number Meeting end time (timestamp, in seconds).
schedulerName string Name of the user who schedules the meeting.
customInfo string Custom extension information.
Table 8 Enumerated values of ConfRole
Enumeration Name Enumerated Value Description
HWM_CONF_ROLE_ATTENDEE 0 Guest.
HWM_CONF_ROLE_HOST 1 Host.
HWM_CONF_ROLE_AUDIENCE 2 Attendee.
HWM_CONF_ROLE_COHOST 3 Co-host.
HWM_CONF_ROLE_WAITING 4 Waiting room member.