Platform APIEnterprise
Invite users to a meeting
Invite multiple users to an existing meeting and return per-user processing results.
HTTP request
POST {API_ADDRESS}/rtc-meeting/invite_meeting_inviteesRequest example
curl --request POST "${API_ADDRESS}/rtc-meeting/invite_meeting_invitees" --header "Content-Type: application/json" --header "operationID: ${OPERATION_ID}" --header "token: ${TOKEN}" --data-raw '{"meetingID":"meeting_001","inviterUserID":"user_001","inviteeUserIDs":["user_002","user_003"]}'Request body
| Parameter | Required | Type | Description |
|---|---|---|---|
| meetingID | Yes | string | Meeting ID. |
| inviterUserID | Yes | string | User initiating the invitation. |
| inviteeUserIDs | Yes | string[] | Users to invite. |
Response
| Property | Type | Description |
|---|---|---|
| data.successUserIDList | string[] | Users successfully added to the invitation state. |
| data.failedUserIDList | string[] | Users whose invitations failed. |
| data.meetingDetail | MeetingInfoSetting | Updated meeting details. |
An overall errCode: 0 does not imply that every invitee succeeded; inspect both user-ID lists.
Errors
See Error codes.
Permissions and limits
- Available only in OpenIM Enterprise.
- Validate that
inviterUserIDhas permission to invite participants.
Related pages
Was this page helpful?