Starting an Instant Meeting
StartP2pConf
API Description
This API is used to start an instant meeting.
Precautions
- This API is an asynchronous API. The return value only indicates whether the API is successfully called. The actual service processing result is returned in the corresponding callback function.
Method Definition
1
|
HWM_SDK_AGENT_API hwmsdk::HwmErrCode StartP2pConf(const HwmP2PStartCallInfo *startCallInfo); |
Callback Function
1
|
virtual void OnStartP2pConfResult(hwmsdk::HwmErrCode ret, const char* reason, HwmConfInfo *confInfo) {}; |
Parameter Description
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
startCallInfo |
Yes |
HwmP2PStartCallInfo |
Instant meeting details. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
callerInfo |
Yes |
HwmCallerInfo |
Caller information. |
calleeInfo |
Yes |
HwmCalleeInfo |
Called participant information. |
mediaType |
Yes |
Definition Media type. Constraints N/A Default Value HWM_MEDIA_TYPE_AUDIO: voice. |
|
isGuestJoinConfWithoutPwd |
No |
bool |
Definition Whether guests can join the meeting without a password. Constraints N/A Default Value The password is required. |
callInRestriction |
No |
HwmJoinConfPermissionType |
Definition Incoming call restriction. Constraints N/A Default Value RESTRICTION_CALL_IN_ALL: everyone. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
nickName |
No |
char[] |
Definition Name of the caller. Constraints N/A Range 0 to 256 characters. Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
nickName |
No |
char[] |
Definition Name of the called participant. Constraints N/A Range 0 to 256 characters. Default Value N/A |
number |
Yes |
char[] |
Definition Number. Constraints 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. Range 0 to 128 characters. Default Value N/A |
thirdUserId |
Yes |
char[] |
Definition Third-party user ID. Constraints For app ID authentication. Either this parameter or number must be set. Range 0 to 128 characters. Default Value N/A |
userUuid |
No |
char[] |
Definition Participant UUID. Constraints N/A Range 0 to 129 characters. Default Value N/A |
type |
No |
HwmConfAttendeeType |
Definition Meeting user type. Constraints N/A Default Value HWM_ATTENDEE_TYPE_NORMAL: client. |
orgId |
No |
char[] |
Definition Enterprise ID. Constraints N/A Range 0 to 32 characters. Default Value N/A |
Return Values
Type |
Description |
---|---|
HwmErrCode |
If 0 is returned, the operation is successful. If other values are returned, the operation fails. For details about values returned upon failures, see Common Error Codes. |
Meeting details. |
Sample Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
/** * Start an instant meeting. */ int demoStartP2pConfDlg::clickStartP2pConf() { hwmsdkagent::HwmP2PStartCallInfo data{}; // Set the caller information. string callerNickName = CTools::UNICODE2UTF(CString("Caller name")); strncpy_s(data.callerInfo.nickName, callerNickName.c_str(), HWM_MAX_DISPLAY_NAME_LEN); // Set the information about the called participant. string calleeNickName = CTools::UNICODE2UTF(CString("Called participant name")); strncpy_s(data.calleeInfo.nickName, calleeNickName.c_str(), HWM_MAX_DISPLAY_NAME_LEN); string calleeNumber = CTools::UNICODE2UTF(CString("123456")); strncpy_s(data.calleeInfo.number, calleeNumber.c_str(), HWM_MAX_NUMBER_LEN); string calleeThirdUserId = CTools::UNICODE2UTF(CString("123456")); strncpy_s(data.calleeInfo.calleeThirdUserId, calleeThirdUserId.c_str(), HWM_MAX_USER_ID_LEN); // Set the media type. data.mediaType = hwmsdkagent::HWM_MEDIA_TYPE_VIDEO // Call the SDK API. int ret = hwmsdkagent::StartP2pConf(&data); return ret; } |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot