SDKsReact NativeEnterprise

Start a group call

Initiate a multi-party group audio or video call using the OpenIM React Native SDK.

Initiate a multi-party group audio or video call with selected group members. Supply the target groupID and specify inviteeUserIDList with the user IDs of the invited members; it does not automatically ring all members of the group.

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	Call invitation payload.
`invitation.inviterUserID`	`string`	Yes	User ID of the caller initiating the call.
`invitation.inviteeUserIDList`	`string[]`	Yes	List of user IDs of group members to invite.
`invitation.groupID`	`string`	Yes	Target group ID.
`invitation.roomID`	`string`	Yes	Unique room identifier for this group call session.
`invitation.timeout`	`number`	Yes	Invitation timeout duration in seconds.
`invitation.mediaType`	`string`	Yes	Call media type, typically `'audio'` or `'video'`.
`invitation.sessionType`	`SessionType`	Yes	Pass `SessionType.Group` for group calls.
`invitation.platformID`	`Platform`	Yes	Platform enum value representing the caller's operating platform.
`invitation.customData`	`string`	No	Optional business extension string attached to the invitation.
`invitation.initiateTime`	`number`	No	Initiation timestamp in Unix milliseconds. Automatically populated by the SDK if omitted.
`invitation.busyLineUserIDList`	`string[]`	No	List of users currently on a busy line. Leave empty when initiating.
`offlinePushInfo`	`OfflinePush`	No	Offline APNs/FCM push configuration for invitees.
`offlinePushInfo.title`	`string`	Conditional	Notification title when `offlinePushInfo` is provided.
`offlinePushInfo.desc`	`string`	Conditional	Notification body text when `offlinePushInfo` is provided.
`offlinePushInfo.ex`	`string`	Conditional	Custom extra payload string. Pass empty string `""` if not needed.
`offlinePushInfo.iOSPushSound`	`string`	Conditional	iOS push sound file identifier.
`offlinePushInfo.iOSBadgeCount`	`boolean`	Conditional	Whether to increment the iOS application badge count.

Return value

Resolves to an RtcInviteResults object containing roomID, token, liveURL, and an optional busyLineUserIDList. See Start a one-to-one call for complete field descriptions.

Invited group members receive the invitation via the OnReceiveNewInvitation event. Identify the call session using roomID and combine roomID:userID to manage member calling and connected states. For complete event listeners, see Handle call events.

Was this page helpful?