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

Activating a Meeting

Description

This API is used to activate a meeting using the meeting ID and password. All meeting control APIs can be called only after a meeting is activated.

Whether the guest password can be used to activate a meeting depends on whether allowGuestStartConf is set to true when the meeting is created.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

POST

Request Address

/v1/mmc/management/conferences/start

Transport Protocol

HTTPS

Request Parameters

Table 2 Parameters

Parameter

Mandatory

Type

Location

Description

X-Access-Token

Yes

String

Header

Authorization token. Use the value of accessToken in the response to the request for Authenticating an App ID.

conferenceID

Yes

String

Body

Meeting ID.

password

Yes

String

Body

Meeting password.

Status Codes

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

Table 4 Response parameters

Parameter

Type

Description

uuid

String

UUID.

NOTE:

This parameter is discarded. Do not use it.

regionIP

String

Public IP address of the region where the meeting is held.

Example Request

POST /v1/mmc/management/conferences/start HTTP/1.1
Connection: keep-alive
X-Access-Token: *******
user-agent: WeLink-desktop
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
    "conferenceID": "986030665",
    "password": "123456"
}

Example Response

HTTP/1.1 200 OK
Content-Length: 141
Cache-Control: no-store
Connection: keep-alive
Content-Type: application/json
Date: Thu, 24 Dec 2020 06:25:59 GMT
Server: api-gateway
X-APIG-Latency: 261
X-APIG-Ratelimit-Api: remain:99,limit:100,time:1 minute
X-APIG-Ratelimit-Api-Allenv: remain:199,limit:200,time:1 second
X-APIG-Upstream-Latency: 259
X-Envoy-Upstream-Service-Time: 210
X-Request-Id: f991eeec77df1692c74f253d765ca146

{
 "uuid": "stb7fe307f8971e44acc5cf8be2112575ff8387ff6ddea68a5e",
 "regionIP": "100.94.23.40"
}

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-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -d '{"conferenceID": "986030665","password": "132456"}' 'https://api.meeting.huaweicloud.com/v1/mmc/management/conferences/start'
Parent topic: APIs