OpenIMDocs

Type at least two characters to search titles and routes.

EN

Language

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

Join a meeting

Copy

Validate the meeting and password, admit a participant, and issue real-time connection details.

HTTP request

POST {API_ADDRESS}/rtc-meeting/join_meeting

Request example

curl --request POST "${API_ADDRESS}/rtc-meeting/join_meeting" --header "Content-Type: application/json" --header "operationID: ${OPERATION_ID}" --header "token: ${TOKEN}" --data-raw '{"meetingID":"meeting_001","userID":"user_002","password":"123456"}'

Request body

ParameterRequiredTypeDescription
meetingIDYesstringMeeting ID.
userIDYesstringParticipant user ID.
passwordYesstringMeeting password; use an empty string for a meeting without a password.

Response

data.liveKit contains the LiveKit service URL and participant access token.

Errors

See Error codes.

Permissions and limits

  • Available only in OpenIM Enterprise.
  • Issue connection details only after authenticating userID in your business system.
  • Do not share or persist the returned participant token outside the meeting session.