Help Center/ Meeting/ Server API Reference/ Meeting Control/ APIs/ Inviting Participants
Updated on 2023-12-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Inviting Participants

Description

This API is used to invite a participant to a meeting.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

POST

Request Address

/v1/mmc/control/conferences/participants

Transport Protocol

HTTPS

Request Parameters

Table 2 Parameters

Parameter

Mandatory

Type

Location

Description

conferenceID

Yes

String

Query

Meeting ID.

X-Conference-Authorization

Yes

String

Header

Meeting control token, which can be obtained by calling the API for Obtaining a Meeting Control Token.

attendees

Yes

Array of attendee objects

Body

List of participants to invite.
Table 3 attendee data structure

Parameter

Mandatory

Type

Description

userUUID

No

String

Participant UUID.

accountId

No

String

Huawei Cloud Meeting account of the participant.

name

Yes

String

Participant name. The value contains up to 96 characters.

role

No

Integer

Participant role in the meeting. Default value: 0.

  • 0: common participant.
  • 1: meeting host.

phone

Yes

String

Number. SIP numbers or mobile numbers are supported.

NOTE:
  • The number can be obtained through the API for Querying the Corporate Directory. The return value of number is a SIP number, and the return value of phone is a mobile number.
  • If you enter a SIP number, the system calls the corresponding soft terminal or hard terminal. If you enter a mobile number, the system dials the mobile number.
  • To make a call to a mobile phone, the PSTN permission must be enabled. Otherwise, the call cannot be made.

phone2

No

String

Reserved field. The value types are the same as those of the phone parameter.

phone3

No

String

Reserved field. The value types are the same as those of the phone parameter.

email

No

String

Email address.

NOTE:

You do not need to set this parameter because no meeting notification is sent to participants invited during the meeting.

sms

No

String

Mobile number for receiving SMS notifications.

NOTE:

You do not need to set this parameter because no meeting notification is sent to participants invited during the meeting.

type

Yes

String

Terminal type. The options are as follows:

  • normal: soft client.
  • terminal: hard terminal.
  • outside: external participant.
  • mobile: mobile number.
  • ideahub: IdeaHub.
  • board: whiteboard (SmartRooms), including MaxHub, Hisense devices, and IdeaHub B2.
  • hwvision: smart TV.

deptUUID

No

String

Department code.

deptName

No

String

Department name.

Status Codes

Table 4 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

POST /v1/mmc/control/conferences/participants?conferenceID=914083136
Connection: keep-alive
X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb
Content-Type: application/json
user-agent: WeLink-desktop
Content-Length: 175
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
    "attendees": [
    {
        "name": "Shanghai Venue",
        "role": 1,
        "phone": "+8657*******",
        "type": "normal"
    }]
}

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
http_proxy_id: b77bb5478e0b1fc0dbbb4e8d4e26ba65
Server: api-gateway
X-Request-Id: 479fdc1d80e2e7ae19c4a08c28821822

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 -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' -d '{"attendees":[{"name":"user01","role":0,"phone":"+8657*******"}]}' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/participants?conferenceID=914083136
Parent topic: APIs