OpenIMDocs

Type at least two characters to search titles and routes.

EN

Language

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

Schedule a meeting

Copy

Schedule a meeting for a future start time. This endpoint is available only in OpenIM Enterprise.

HTTP request

POST {API_ADDRESS}/rtc-meeting/book_meeting

Request example

curl --request POST "${API_ADDRESS}/rtc-meeting/book_meeting" --header "Content-Type: application/json" --header "operationID: ${OPERATION_ID}" --header "token: ${TOKEN}" --data-raw '{"creatorUserID":"user_001","creatorDefinedMeetingInfo":{"title":"Weekly sync","scheduledTime":1719800000000,"meetingDuration":3600,"password":"123456","timeZone":"Asia/Shanghai","hostUserID":"user_001","coHostUSerID":["user_002"],"inviteeUserIDs":["user_003"]},"setting":{"canParticipantsEnableCamera":true,"canParticipantsUnmuteMicrophone":true,"canParticipantsShareScreen":true,"disableCameraOnJoin":false,"disableMicrophoneOnJoin":true,"canParticipantJoinMeetingEarly":false,"lockMeeting":false,"audioEncouragement":true,"videoMirroring":true,"recordOn":false},"repeatInfo":{"endDate":1722400000000,"repeatTimes":4,"repeatType":1,"interval":1,"repeatDaysOfWeek":[1]}}'

Request body

ParameterRequiredTypeDescription
creatorUserIDYesstringMeeting creator.
creatorDefinedMeetingInfoYesCreatorDefinedMeetingInfoTitle, schedule, password, host, co-hosts, and invitees.
settingYesMeetingSettingMeeting-level media, joining, locking, and recording settings.
repeatInfoYesMeetingRepeatInfoReqRecurrence rule. Use a non-recurring rule when scheduling a single meeting.

Response

data.detail contains the created MeetingInfoSetting. Scheduling does not return a real-time connection token.

Errors

See Error codes.

Permissions and limits

  • Available only in OpenIM Enterprise.
  • Validate creator, host, co-host, invitee, and tenant boundaries on your backend.
  • All meeting times are Unix timestamps in milliseconds; meetingDuration is in seconds.