SDKsReact NativeEnterprise

Start a group call

Start a group audio or video call with OpenIM React Native SDK.

Call signalingInviteInGroup() to start a group audio or video call. groupID identifies the group where the call starts. inviteeUserIDList specifies the members to invite; it does not automatically invite every group member.

const roomCredentials = await OpenIMSDK.signalingInviteInGroup({
  invitation: {
    inviterUserID: currentUserID,
    inviteeUserIDList: memberUserIDs,
    groupID,
    roomID,
    timeout: 30,
    mediaType: 'video',
    sessionType: SessionType.Group,
    platformID: currentPlatform,
  },
});

Parameters

Parameter	Type	Required	Description
`invitation`	`RtcInvite`	Yes	The call invitation.
`invitation.inviterUserID`	`string`	Yes	User ID of the user starting the call.
`invitation.inviteeUserIDList`	`string[]`	Yes	User IDs of the group members to invite.
`invitation.groupID`	`string`	Yes	Target group ID.
`invitation.roomID`	`string`	Yes	Room ID for this group call.
`invitation.timeout`	`number`	Yes	Invitation timeout in seconds.
`invitation.mediaType`	`string`	Yes	Media type, such as `audio` or `video`.
`invitation.sessionType`	`SessionType`	Yes	Pass `SessionType.Group` for a group call.
`invitation.platformID`	`Platform`	Yes	Inviter platform. Pass the `Platform` enum value for the current client.
`invitation.customData`	`string`	No	Application-defined extension string sent with the invitation.
`invitation.initiateTime`	`number`	No	Invitation start time as a Unix timestamp in milliseconds. It is usually managed by the calling flow and does not need to be set manually.
`invitation.busyLineUserIDList`	`string[]`	No	Busy-user list. It is usually omitted when starting a new invitation.
`offlinePushInfo`	`OfflinePush`	No	Push content for invited users when they are offline.
`offlinePushInfo.title`	`string`	Conditional	Push title when `offlinePushInfo` is provided.
`offlinePushInfo.desc`	`string`	Conditional	Push body when `offlinePushInfo` is provided.
`offlinePushInfo.ex`	`string`	Conditional	Extension string when `offlinePushInfo` is provided. Pass an empty string when there is no content.
`offlinePushInfo.iOSPushSound`	`string`	Conditional	iOS push sound when `offlinePushInfo` is provided.
`offlinePushInfo.iOSBadgeCount`	`boolean`	Conditional	Whether to update the iOS badge when `offlinePushInfo` is provided.

The call returns RtcInviteResults, which includes roomID, token, liveURL, and an optional busyLineUserIDList. For field descriptions, see Start a one-to-one call.

Invited members receive OnReceiveNewInvitation with OnReceiveNewInvitationPayload. For member acceptance, rejection, and room-leave status, see Handle call events.

Was this page helpful?