OpenIMDocs

Type at least two characters to search titles and routes.

EN

Language

ENEnglishEnglish docs简中简体中文中文文档
Browse Platform API
Platform APIEnterprise

Create an immediate meeting

Copy

Create a meeting immediately and return the real-time audio and video connection details for the creator.

HTTP request

POST {API_ADDRESS}/rtc-meeting/create_immediate_meeting

Request example

curl --request POST "${API_ADDRESS}/rtc-meeting/create_immediate_meeting" --header "Content-Type: application/json" --header "operationID: ${OPERATION_ID}" --header "token: ${TOKEN}" --data-raw '{"creatorUserID":"user_001","creatorDefinedMeetingInfo":{"title":"Support call","scheduledTime":1719800000000,"meetingDuration":3600,"password":"","timeZone":"Asia/Shanghai","hostUserID":"user_001","coHostUSerID":[],"inviteeUserIDs":["user_002"]},"setting":{"canParticipantsEnableCamera":true,"canParticipantsUnmuteMicrophone":true,"canParticipantsShareScreen":true,"disableCameraOnJoin":false,"disableMicrophoneOnJoin":true,"canParticipantJoinMeetingEarly":true,"lockMeeting":false,"audioEncouragement":true,"videoMirroring":true,"recordOn":false}}'

Request body

ParameterRequiredTypeDescription
creatorUserIDYesstringMeeting creator.
creatorDefinedMeetingInfoYesCreatorDefinedMeetingInfoTitle, schedule metadata, password, host, co-hosts, and invitees.
settingYesMeetingSettingMeeting-level media, joining, locking, and recording settings.

Response

PropertyTypeDescription
data.detailMeetingInfoSettingCreated meeting details and settings.
data.liveKitLiveKitReal-time service URL and access token for the creator.

Errors

See Error codes.

Permissions and limits

  • Available only in OpenIM Enterprise.
  • Return data.liveKit only to the authenticated participant for whom it was issued.