Updated on 2023-06-21 GMT+08:00

Overview

This document describes the RESTful application programming interfaces (APIs) provided by Huawei Cloud Meeting. Developers can use these APIs to integrate the audio and video meeting functions of Huawei Cloud Meeting into their service systems.

A RESTful API request URI consists of the following parts:

{URI-scheme}://{Endpoint}/{resource-path}?{query-string}

Table 1 Parameters in a URI

Parameter

Description

URI-scheme

Protocol used to transmit requests. All APIs use HTTPS.

Endpoint

api-intl.meeting.huaweicloud.com for the International site.

resource-path

Path where the resource requested by the API is located.

query-string

(Optional) Query parameter.

API Categories

Table 2 API categories

API Category

Description

Common Authentication and Login

Obtain and update a token, log out of the server, and configure SSO authentication.

Meeting Management

Schedule a meeting, edit or cancel a scheduled meeting, and query the meeting list and meeting details. Create, modify, or cancel a recurring meeting series and modify or cancel a recurring meeting.

Meeting Control

Control a meeting, such as adding and muting participants, setting continuous presence, and applying for or relinquishing the host role, giving the floor, broadcast, and recording.

Meeting Event Push

  • Push information about a specific meeting, including the basic meeting information, meeting statuses, online participants, speaker statuses, media quality statuses, and live captions, via WebSocket.
  • Push enterprise-level meeting information, including meeting start and end statuses, via WebSocket.

Enterprise Management

Manage your enterprise, including querying and modifying enterprise registration details, querying enterprise resources and service permissions as an enterprise administrator, and creating, deleting, querying, modifying, and searching for enterprises as an SP administrator.

Department Management

Add, modify, and delete departments in your enterprise, and query department details.

User Management

Manage user accounts in your enterprise, including adding, modifying, and deleting users, querying user details, and changing users' mobile numbers or email addresses.

Enterprise Administrator Management

Manage enterprise administrators, including adding, deleting, and querying enterprise administrators.

Hard Terminal Management

Manage hard terminals, including adding, modifying, deleting, and querying hard terminals, and resetting activation codes.

Cloud Meeting Room Management

Manage cloud meeting rooms, including deleting, allocating, and reclaiming cloud meeting rooms, and querying and modifying cloud meeting rooms associated with users.

User Password Management

Manage passwords of enterprise users, including changing and resetting passwords as enterprise members, and resetting passwords of enterprise members as enterprise administrators.

Corporate Directory Query

Query the corporate directory.

Enterprise Resource Management

Manage enterprise resources, including allocating, deleting, modifying, and querying enterprise resources, and querying operation records of enterprise resources.

Meeting Minutes

Manage meeting minutes generated on IdeaHubs and other whiteboards, including opening the file list, saving the meeting minutes to eMeetings, querying the list, and querying details.

Bulletin Board Management

  • Publication management

Manage bulletin board publications, including adding, deleting, and modifying bulletin board publications, querying details of a bulletin board publication, and querying the list of bulletin board publications.

  • Program management

Manage bulletin board programs, including adding, deleting, and modifying bulletin board programs, querying details of a bulletin board program, and querying the list of bulletin board programs.

  • Material management

Manage bulletin board materials, including adding, deleting, and modifying bulletin board materials, and querying the list of bulletin board program materials.