Platform APIEnterprise
Overview
The meeting module provides scheduled and immediate meetings, participant controls, recurring meetings, meeting chat, recording queries, and real-time call recovery. All endpoints in this module are available only in OpenIM Enterprise and must be called through an authorized business backend.
Capabilities
Meeting management
- Schedule a meeting
- Create an immediate meeting
- Join a meeting
- Get a meeting token
- Update a meeting
- Get a meeting
- List a user's meetings
- Invite users to a meeting
- Leave a meeting
- End or cancel a meeting
Meeting controls and records
- Set personal meeting preferences
- Control participant media streams
- Remove meeting participants
- Create a recurring meeting
- Get meeting recordings
- Get meeting attendance
Real-time calls and meeting chat
- Get a call room by group ID
- Get a startup call invitation
- Send a meeting chat message
- Pull meeting chat messages
Resource representations
LiveKit
| Property | Type | Description |
|---|---|---|
| token | string | Participant access token. |
| url | string | Real-time service URL. |
SystemGeneratedMeetingInfo
| Property | Type | Description |
|---|---|---|
| creatorUserID | string | Creator user ID. |
| creatorNickname | string | Creator display name. |
| status | string | Meeting status. |
| startTime | int | Start time in Unix milliseconds. |
| meetingID | string | Meeting ID. |
CreatorDefinedMeetingInfo
| Property | Type | Description |
|---|---|---|
| title | string | Meeting title. |
| scheduledTime | int | Scheduled start in Unix milliseconds. |
| meetingDuration | int | Duration in seconds. |
| password | string | Password, or empty when not required. |
| timeZone | string | Creator-selected time zone. |
| hostUserID | string | Primary host user ID. |
| coHostUSerID | string[] | Co-host user IDs. The protocol uses this exact capitalization. |
| inviteeUserIDs | string[] | Invitee user IDs. |
MeetingInfo
| Property | Type | Description |
|---|---|---|
| systemGenerated | SystemGeneratedMeetingInfo | Server-generated identity and status. |
| creatorDefinedMeeting | CreatorDefinedMeetingInfo | Creator-defined meeting information. |
MeetingSetting
| Property | Type | Description |
|---|---|---|
| canParticipantsEnableCamera | bool | Whether participants may enable cameras. |
| canParticipantsUnmuteMicrophone | bool | Whether participants may unmute microphones. |
| canParticipantsShareScreen | bool | Whether participants may share screens. |
| disableCameraOnJoin | bool | Whether cameras start disabled. |
| disableMicrophoneOnJoin | bool | Whether microphones start muted. |
| canParticipantJoinMeetingEarly | bool | Whether participants may join early. |
| lockMeeting | bool | Whether new participants are prevented from joining. |
| audioEncouragement | bool | Whether active-speaker highlighting is enabled. |
| videoMirroring | bool | Whether video mirroring is enabled. |
| recordOn | bool | Whether server-side recording is enabled by policy. |
MeetingInfoSetting
| Property | Type | Description |
|---|---|---|
| info | MeetingInfo | Meeting identity and creator-defined information. |
| setting | MeetingSetting | Meeting-level settings. |
| repeatInfo | MeetingRepeatInfo | Recurrence information for this instance. |
MeetingRepeatInfoReq
| Property | Type | Description |
|---|---|---|
| endDate | int | Recurrence end in Unix milliseconds. |
| repeatTimes | int | Planned number of instances. |
| repeatType | RepeatType | Recurrence frequency. |
| interval | int | Interval between occurrences. |
| repeatDaysOfWeek | DayOfWeek[] | Weekdays included by the rule. |
MeetingRepeatInfo
Includes every MeetingRepeatInfoReq property plus repeatMeetingID and repeatSequence.
RepeatMeetingData
| Property | Type | Description |
|---|---|---|
| repeatMeetingID | string | Recurring meeting ID. |
| creatorUserID | string | Creator user ID. |
| creatorDefinedMeetingInfo | CreatorDefinedMeetingInfo | Shared meeting information. |
| setting | MeetingSetting | Shared settings. |
| repeatInfo | MeetingRepeatInfo | Recurrence rule and identity. |
| generatedCount | int | Number of generated instances. |
| nextScheduleTime | int | Next scheduled generation time. |
| status | RepeatStatus | Recurrence status. |
PersonalMeetingSetting
| Property | Type | Description |
|---|---|---|
| cameraOnEntry | bool | Whether the camera is enabled on entry. |
| microphoneOnEntry | bool | Whether the microphone is enabled on entry. |
MeetingUser
| Property | Type | Description |
|---|---|---|
| userID | string | OpenIM user ID. |
| nickname | string | Display name. |
FileRecord
| Property | Type | Description |
|---|---|---|
| size | string | File size in the format returned by the service. |
| fileURL | string | Recording file URL. |
MeetingRecord
| Property | Type | Description |
|---|---|---|
| roomID | string | Meeting or call room ID. |
| meetingName | string | Meeting name. |
| ex | string | Business extension data. |
| hostUserID | string | Host user ID. |
| hostUserNickname | string | Host display name. |
| createTime | int | Creation time in Unix milliseconds. |
| startTime | int | Start time in Unix milliseconds. |
| endTime | int | End time in Unix milliseconds. |
| joinedUsers | MeetingUser[] | Participants recorded for the meeting. |
| status | int | Meeting record status. |
| fileRecords | FileRecord[] | Recording files. |
| egressID | string | Recording job ID. |
| downloadUrl | string | Recording download URL. |
| egressUploading | bool | Whether a recording is still uploading. |
| recordStatus | int | See RecordStatus. |
| videoFileSize | int | Video size in bytes. |
| videoCoverUrl | string | Video cover URL. |
| videoName | string | Video filename. |
UserMeetingHistory
Contains roomID, meetingName, hostUserID, hostUserNickname, startTime, endTime, status, and ex for a meeting attended by a user.
HostedMeeting
Contains roomID, meetingName, status, startTime, endTime, and ex for a meeting hosted by a user.
MeetingChatMessage
| Property | Type | Description |
|---|---|---|
| seq | int | Meeting-chat Seq. |
| sendID | string | Sender user ID. |
| contentType | int | Content type. See Message content types. |
| content | string | Message content. |
| createTimeMs | int | Creation time in Unix milliseconds. |
| dstUserIDs | string[] | Target users; empty means room broadcast. |
| nickname | string | Sender display name. |
| faceURL | string | Sender avatar URL. |
InviteeInfo
| Property | Type | Description |
|---|---|---|
| inviteeUserIDs | string[] | Replacement invitee list used by meeting updates. |
InvitationInfo
| Property | Type | Description |
|---|---|---|
| inviterUserID | string | Invitation sender. |
| inviteeUserIDList | string[] | Invitees. |
| customData | string | Business extension data. |
| groupID | string | Related group ID. |
| roomID | string | Call room ID. |
| timeout | int | Invitation timeout. |
| mediaType | string | Call media type. |
| platformID | int | Originating platform. See PlatformID. |
| sessionType | int | Call session type. See ConversationType. |
| initiateTime | int | Invitation initiation time. |
| busyLineUserIDList | string[] | Users whose lines are busy. |
Enumerations
RepeatType
| Value | Name | Description |
|---|---|---|
| 0 | REPEAT_TYPE_NONE | Does not repeat. |
| 1 | REPEAT_TYPE_DAILY | Daily. |
| 2 | REPEAT_TYPE_WEEKLY | Weekly. |
| 3 | REPEAT_TYPE_WEEKDAY | Weekdays. |
| 4 | REPEAT_TYPE_MONTHLY | Monthly. |
| 5 | REPEAT_TYPE_YEARLY | Yearly. |
| 6 | REPEAT_TYPE_HOURLY | Hourly. |
DayOfWeek
| Value | Name |
|---|---|
| 0 | SUNDAY |
| 1 | MONDAY |
| 2 | TUESDAY |
| 3 | WEDNESDAY |
| 4 | THURSDAY |
| 5 | FRIDAY |
| 6 | SATURDAY |
RepeatStatus
| Value | Name | Description |
|---|---|---|
| 0 | REPEAT_STATUS_UNKNOWN | Unknown. |
| 1 | REPEAT_STATUS_ACTIVE | Active. |
| 2 | REPEAT_STATUS_COMPLETED | Completed. |
RecordStatus
| Value | Name | Description |
|---|---|---|
| 0 | NotStarted | Not started. |
| 1 | Completed | Completed. |
| 2 | Failed | Failed. |
| 3 | Processing | Processing. |
Integration guidance
- Authenticate users and validate meeting, room, recording, and tenant permissions in the business backend.
- Treat real-time connection tokens and recording URLs as sensitive resources.
- Use the meeting-chat Seq and creation marker together when incrementally restoring meeting chat.
Was this page helpful?