> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Introduces the capabilities of DingTalk Meetings, live streaming, and smart meeting rooms, providing digital records throughout the meeting lifecycle and open APIs.

## DingTalk Video Meeting

### Introduction

DingTalk Video Meeting is a **secure, clear, stable, and smooth** video meeting service provided by DingTalk. Deeply integrated with DingTalk, it delivers digital records throughout the entire meeting lifecycle and end-to-end meeting workflow.

A video meeting supports up to **500 participants** online at the same time. Participants can join from **phones, tablets, or computers** (both Windows and Mac are supported), enabling meetings anytime, anywhere. DingTalk Video Meeting also provides organizations with a digital, intelligent video meeting solution covering **all perspectives, full integration, all terminals, and the full workflow**.

### Key features

* Use DingTalk Video Meeting for remote audio and video meetings, screen and file sharing, and meeting management to meet intelligent communication and collaboration needs.
* DingTalk Video Meeting also provides the DingTalk Room Connector, bridging online software meetings and offline meeting rooms. Enjoy 1080p high-definition quality, stable and smooth.
* Join with one click in multiple ways. Participants can quickly locate a specified room and join with one click via link, SMS, join code, meeting card, and more.
* Meeting security is controllable and guaranteed. Use rich security management features such as organization-only meetings, force-mute all, and meeting lock as needed to ensure every meeting runs securely, in a controlled manner, and in order.
* Online interaction features are rich and engaging. Use features such as Spotlight, pin participants, meeting whiteboard, beauty filter, and meeting recording to ensure efficient communication.
* Seamlessly switch meeting devices and modes. Participants can share screens and files, and play local audio or video files while sharing. The organizer can control screen sharing permissions to prevent unauthorized sharing.
* Events are automatically created and synced. Organizers can book a meeting time in advance and sync the event to all participants. Reminders are sent automatically at the scheduled time, and the video meeting can be started with one click, making internal team communication simple and convenient.
* For corporate training, participant video is displayed in real time, just like face-to-face communication, breaking the limits of time and space and improving work efficiency as if attending an on-site meeting.

### How to start a video meeting

* Option 1: Open the DingTalk PC client and sign in. Click the **Meeting** icon on the left side of the client, and then click New Meeting.

* Option 2: Start a video meeting from a chat window.

  * Start a video meeting from a group chat window: Click the phone icon above the input box.

  * Start a video meeting from a direct message window: Click the phone icon above the input box.

### List of open APIs

Video Meeting provides a rich set of open APIs. Developers can use APIs to integrate video meetings with their organization's business systems.

| **API**                                                                                                                             | **Description**                                                                                                                             | **API version** |
| ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | --------------- |
| [Create a video meeting](/open/development/create-a-video-conference)                                                               | Create a video meeting.                                                                                                                     | New             |
| [Close a video meeting](/open/development/close-audio-video-conference)                                                             | Close a video meeting. Only the host of the meeting has the permission to close it.                                                         | New             |
| [Query video meeting information](/open/development/querying-video-conference-information)                                          | Query the basic information of a video meeting.                                                                                             | New             |
| [Batch query video meeting information](/open/development/batch-query-of-video-conference-information)                              | Query meeting information and participant details.                                                                                          | New             |
| [Query video meeting members](/open/development/querying-video-conference-members)                                                  | Query the information of video meeting participants by page.                                                                                | New             |
| [Query a user's ongoing meeting list](/open/development/api-queryuserongoingconference)                                             | Query the user's ongoing meeting list. Returns the IDs of ongoing meetings and the participant information of that user in the meetings.    | New             |
| [Query an organization's ongoing meeting list](/open/development/api-queryorgconferencelist)                                        | Call this API to query the list of ongoing meetings in an organization by pagination parameters.                                            | New             |
| [Query meeting information by meeting code](/open/development/api-queryconferenceinfobyroomcode)                                    | Call this API to query meeting information by meeting roomCode and pagination parameters.                                                   | New             |
| [Lock a meeting](/open/development/api-lockconference)                                                                              | Call this API to lock a meeting.                                                                                                            | New             |
| [Invite users to join a meeting](/open/development/invite-users-to-join)                                                            | Invite new users to join an ongoing meeting. After this API is called, the invited users receive a notification to join the meeting.        | New             |
| [Remove meeting members](/open/development/kick-out-meeting-members)                                                                | Remove members during a meeting. After this API is called, the removed user leaves the meeting and is notified that they have been removed. | New             |
| [Set Spotlight](/open/development/set-the-whole-staff-to-see-him)                                                                   | During a meeting, use this API to enable or cancel Spotlight.                                                                               | New             |
| [Set co-hosts](/open/development/set-up-co-hosts)                                                                                   | Add or remove co-hosts during a meeting.                                                                                                    | New             |
| Start video meeting live streaming                                                                                                  | Start video meeting live streaming.                                                                                                         | New             |
| Stop video meeting live streaming                                                                                                   | Stop video meeting live streaming.                                                                                                          | New             |
| [Mute or unmute a specified user](/open/development/specify-person-to-mute-or-unmute)                                               | During an ongoing meeting, use this API to mute or unmute a specified user.                                                                 | New             |
| [Mute all or unmute all](/open/development/mute-all-staff-or-unmute-all-staff)                                                      | During a meeting, use this API to mute all or unmute all participants.                                                                      | New             |
| [Create a booked meeting](/open/development/create-appointment-meeting)                                                             | Create a booked meeting based on the creator, title, start time, end time, and other information.                                           | New             |
| [Update a booked meeting](/open/development/update-appointment-meeting)                                                             | Update the title, start time, end time, and other information of a booked meeting.                                                          | New             |
| [Cancel a booked meeting](/open/development/cancel-appointment-meeting)                                                             | Cancel a booked meeting by its booked meeting ID.                                                                                           | New             |
| [Query a booked meeting](/open/development/query-meeting-reservation)                                                               | Query a booked meeting's title and other information by its booked meeting ID.                                                              | New             |
| [Query booked meeting settings](/open/development/api-queryscheduleconfsettings)                                                    | Query the settings of a booked meeting by its booked meeting ID.                                                                            | New             |
| [Update booked meeting settings](/open/development/api-updatescheduleconfsettings)                                                  | Call this API to update booked meeting settings.                                                                                            | New             |
| [Create a user-exclusive short link](/open/development/api-createcustomshortlink)                                                   | Create a user-exclusive short link based on user information.                                                                               | New             |
| [Query historical meeting information of a booked meeting](/open/development/query-appointment-meeting-history-meeting-information) | Query the historical meeting information of a booked meeting that has been started. The information of the most recent meeting is returned. | New             |
| [Start cloud recording for a video meeting](/open/development/video-conference-open-cloud-recording)                                | Start cloud recording for a video meeting.                                                                                                  | New             |
| [Stop cloud recording for a video meeting](/open/development/video-conferencing-stops-cloud-recording)                              | Stop cloud recording for a video meeting.                                                                                                   | New             |
| [Query meeting recording details](/open/development/query-recording-information)                                                    | Query the details of a meeting recording.                                                                                                   | New             |
| [Query video information in a meeting recording](/open/development/queries-the-playback-information-about-a-recorded-cloud-video)   | Query the video information in a meeting recording.                                                                                         | New             |
| [Query text information in a meeting recording](/open/development/queries-the-text-information-about-cloud-recording)               | Query speech-to-text information from a video meeting recording.                                                                            | New             |

### List of callback events

Video Meeting supports HR profile change callback events. For more events, see the event subscription overview.

## Live

### Introduction

DingTalk Live provides comprehensive features such as live booking, flexible permission settings, multi-group simulcast, real-time interaction, live recording, and live data analytics. It breaks the constraints of time and space, making it easy to run a live event, efficiently communicate top-down or bottom-up, and transform traditional training management models.

DingTalk Live easily handles a wide range of scenarios, including corporate training, recruitment briefings, event livestreams, and online classrooms. Professional priority support is also available to ensure the on-site execution team smoothly deploys and debugs equipment, safeguarding the overall quality and experience of the livestream from online to offline.

### Key features

* Live booking: Get the live link in advance for promotion. Integrated with DingTalk Calendar to send reminders before the livestream starts.
* Flexible permission settings: The host can set the livestream to be publicly visible or visible within the organization.
* Multi-group simulcast: Easily sync a single livestream to multiple groups.
* Real-time interaction: A variety of interactive formats including raise hand, chat, like, check-in, and Q\&A.
* Live recording: Automatically save the livestream recording for easy content retention and re-distribution.
* Live data analytics: Detailed metrics such as viewer count and viewing duration are recorded, making the effectiveness of live training measurable.

### How to start a livestream

On the **DingTalk PC client** page, click **More** on the left side of the client, and then click **Live > Start Live**.

### List of open APIs

Live provides a rich set of open APIs. Developers can use APIs to invoke DingTalk Live's native capabilities.

| **API**                             | **Description**                                               | **API version** |
| ----------------------------------- | ------------------------------------------------------------- | --------------- |
| Create a livestream                 | Create a livestream.                                          | New             |
| Delete a livestream                 | Delete a livestream.                                          | New             |
| Query livestream information        | Query livestream information by livestream ID.                | New             |
| Modify livestream attributes        | Modify livestream attribute information.                      | New             |
| Query livestream viewer information | Query the detailed viewing information of livestream viewers. | New             |

### List of callback events

Live supports callback events for status changes, information modifications, and playback viewing data.

* Live status change
* Live information modification
* Live playback viewing data push
* Live end data processing completed event

### Glossary

#### Custom cover

The livestream cover. You can upload a custom livestream cover image.

#### Add livestream group

After the livestream starts, a livestream start notification is automatically sent to the added groups.

#### Live ID

Each livestream has a unique ID, defined as `liveId`. Call the Create Livestream API to obtain the `liveId` value.

#### Viewer count

The number of viewers of the livestream, excluding the host. Defined as `liveUv`.

## Smart meeting room

### Introduction

DingTalk Smart Meeting Room provides comprehensive features such as room booking, room approval management, smart hardware integration, and data report analytics. It enables efficient management of physical meeting spaces within an organization, transforms traditional meeting room management and booking models, and helps organizations achieve digital transformation.

### Key features

* Online meeting rooms: Book and manage meeting rooms online for convenient and orderly bookings.
* Efficient use of meeting room resources: Overdue bookings can be claimed by others to ensure efficient and reasonable use of resources.
* More efficient meeting room management: Supports grouping and statistical report export for more efficient management.
* Smart meeting check-in: Scan to check in and automatically tally attendance.
* Integrated software and hardware: Use booked events to start or join meetings on hardware video meeting devices with one click.
* Meeting rooms joined via booking automatically have cloud meeting co-host permissions for efficient meeting management and control.

### How to enable Smart Meeting Room

Smart Meeting Room is an official app installed by default in DingTalk. Employees can add and use the app on the DingTalk workbench.

* **Mobile**

  On the **Workbench** page of the DingTalk mobile client, click **Add** under **All Employees**, enter **Smart Meeting Room** in the search box, and click **Add**.

* **Desktop**

  On the **Workbench** page of the DingTalk desktop client, click **Add** under **All Employees**, enter **Smart Meeting Room** in the search box, and click **Add**.

### List of open APIs

Smart Meeting Room provides a rich set of open APIs. Developers can use APIs to manage DingTalk smart meeting rooms.

#### Meeting room

| **API**                                                                                                           | **Description**                                                                         | **API version** |
| ----------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------- |
| [Create a meeting room](/open/development/create-a-meeting-room)                                                  | Create a meeting room.                                                                  | New             |
| [Delete a meeting room](/open/development/delete-a-meeting-room)                                                  | Delete a meeting room.                                                                  | New             |
| [Update meeting room information](/open/development/update-meeting-room-information)                              | Update meeting room information.                                                        | New             |
| [Query meeting room list](/open/development/check-the-meeting-room-list)                                          | Query the meeting room list.                                                            | New             |
| [Query meeting room details](/open/development/check-meeting-room-details)                                        | Query meeting room details.                                                             | New             |
| [Create a meeting room booking blocklist](/open/development/api-createbookingblacklist)                           | Call this API to create a meeting room booking blocklist.                               | New             |
| [Delete a meeting room booking blocklist](/open/development/api-deletebookingblacklist)                           | Call this API to delete a meeting room booking blocklist.                               | New             |
| [Query video meeting device information](/open/development/querying-video-conference-device-information)          | Query video meeting device information.                                                 | New             |
| [Query video meeting device attributes](/open/development/querying-video-conference-device-attribute-information) | Query video meeting device attribute information.                                       | New             |
| [Send Rooms central control API signaling](/open/development/api-sendcentralcontrol)                              | Send central control signaling to devices in a meeting room. This is a premium feature. | New             |

#### Meeting room group

| **API**                                                                               | **Description**                                 | **API version** |
| ------------------------------------------------------------------------------------- | ----------------------------------------------- | --------------- |
| [Create a meeting room group](/open/development/create-meeting-room-groups)           | Create a meeting room group.                    | New             |
| [Delete a meeting room group](/open/development/delete-a-conference-room-group)       | Delete a meeting room group.                    | New             |
| [Update meeting room group information](/open/development/update-meeting-room-groups) | Update the information of a meeting room group. | New             |
| [Query meeting room group list](/open/development/query-meeting-rooms-groups)         | Query the meeting room group list.              | New             |
| [Query meeting room group information](/open/development/query-meeting-room-groups)   | Query meeting room group information.           | New             |

#### Custom screen template

| **API**                                                                                        | **Description**                                                             | **API version** |
| ---------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------- |
| [Create a custom screen template](/open/development/api-createdevicecustomtemplate)            | Call this API to create a custom screen template by template name.          | New             |
| [Delete a custom screen template](/open/development/api-deletedevicecustomtemplate)            | Call this API to delete a custom screen template by template ID.            | New             |
| [Update a custom screen template](/open/development/api-updatedevicecustomtemplate)            | Update a custom screen template's information by custom screen template ID. | New             |
| [Query custom screen information](/open/development/api-querydevicecustomtemplate)             | Query custom screen information by template ID.                             | New             |
| [Query custom screen template list](/open/development/api-querylistdevicecustomscreentemplate) | Call this API to directly query the custom screen template list.            | New             |

### List of callback events

Meeting Room supports booking events, including booking success and cancellation.

* Device central control event
* Meeting room event

### Glossary

#### Book a meeting room

Book meeting room resources in advance through the Smart Meeting Room app. Parameters such as bookable time and the user range allowed to book can be configured by the admin in the backend.

#### Meeting room group

Admins can use the meeting room group feature to manage meeting rooms in the organization hierarchically. For example, distinguish a three-level hierarchy by city, campus, and building, and associate different sets of meeting rooms with each level. Three-level grouping is currently supported.

#### Meeting room approval

The use of certain special meeting rooms within an organization requires approval by a designated admin before booking. The admin can configure which meeting rooms require approval and who the approvers are in the backend.

#### Meeting room claim

As a scarce resource, meeting rooms should not be wasted. If a booked meeting room is unused beyond a specified time, others can be allowed to claim it on site. The admin can configure parameters such as whether claiming is allowed and the idle time threshold in the backend.

#### Meeting room exclusive booking time

Meeting rooms support both global configuration and per-room settings. You can enable "Exclusive booking time" for a specified meeting room and configure its parameters.
