Browse SDKs · React Native
Platform
SDKsReact NativeEnterprise

Get a group call room

Query active audio or video call room information by group ID using the OpenIM React Native SDK.

Copy

Query active call room metadata and connected participants for a specific group using signalingGetRoomByGroupID():

const room = await OpenIMSDK.signalingGetRoomByGroupID(groupID);

Parameters

ParameterTypeRequiredDescription
groupIDstringYesTarget group ID.

Return value

Resolves to a CallingRoomData object:

FieldTypeDescription
roomIDstringCalling room identifier.
invitationRtcInvite (optional)Call invitation metadata corresponding to the room.
participantParticipantInfo[] (optional)Active participants currently in the room.

participant[].userInfo provides individual user profiles; group scenarios may also include groupMemberInfo and groupInfo. This query returns a current snapshot of the room and does not dispatch signaling events. For subsequent live state updates, reconcile incoming events using roomID and participant userID as detailed in Handle call events.