Inviting a Participant Using a Meeting ID and Password
Description
This API is used to invite participants using the meeting ID and password. This API is used to invite other terminals to a meeting when the app has obtained the meeting ID and guest password and the SIP numbers of other terminals by scanning the QR code.
![](https://support.huaweicloud.com/intl/en-us/api-meeting/public_sys-resources/note_3.0-en-us.png)
This API can be called when the administrator enables Scan guest QR code to join meetings using hard terminal on the Meeting Settings page of the Management Platform.
Debugging
You can debug this API in API Explorer.
Prototype
Request Method |
POST |
---|---|
Request Address |
/v1/mmc/control/conferences/inviteWithPwd |
Transport Protocol |
HTTPS |
Request Parameters
Parameter |
Mandatory |
Type |
Location |
Description |
---|---|---|---|---|
conferenceID |
Yes |
String |
Query |
Meeting ID. |
callNum |
Yes |
String |
Body |
SIP number of the invited user. |
orgID |
No |
String |
Body |
ID of the enterprise to which the invited user belongs. |
confID |
Yes |
String |
Body |
ID of the current meeting. |
pwd |
Yes |
string |
body |
Meeting password (host or guest password). |
numBelongsType |
No |
Integer |
Body |
SIP number type. Default value: 0.
|
isNotOverlayPidName |
No |
Boolean |
Body |
Whether the participant name is not superimposed (applicable to the VDC scenario). |
Status Codes
HTTP Status Code |
Description |
---|---|
200 |
Operation successful. |
400 |
Invalid parameters. |
401 |
Authentication is not performed or fails. |
403 |
Insufficient permissions. |
500 |
Server exception. |
Response Parameters
None
Example Request
PUT /v1/mmc/control/conferences/inviteWithPwd?conferenceID=914083136 Connection: keep-alive content-type: application/json user-agent: WeLink-desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "callNum":"+99111253020382685", "orgID":"115489", "pwd":"123123", "numBelongsType":0, "isNotOverlayPidName":false, "confID":"914083136" }
Example Response
HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 39 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: 571b4dfceff545fae29aa14cea761079 Server: api-gateway X-Request-Id: f78b007ec2dabf1498620131c7bc19e0
Error Codes
If an error code starting with MMC or USG is returned when you use this API, rectify the fault by following the instructions provided in Huawei Cloud API Error Center.
Example cURL Command
curl -k -i -H 'content-type: application/json' -X POST -d '{"callNum":"+8688665599", "orgID":"115489", "pwd":"123123", "numBelongsType":0, "isNotOverlayPidName":false}' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/ inviteWithPwd?conferenceID=914083136
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