SDKsFlutterEnterprise

Query group call room

Query active ongoing call rooms by group ID using the OpenIM Flutter SDK.

Query the active audio or video call room currently ongoing in a specified group:

Parameters

Parameter	Type	Required	Description
`groupID`	`String`	Yes	Target group ID.

Code example

final room = await OpenIM.iMManager.signalingManager
    .signalingGetRoomByGroupID(groupID: groupID);

if (room.roomID?.isNotEmpty == true) {
  renderParticipants(room.participant ?? const []);
}

Return value

A successful Future returns a RoomCallingInfo object containing room metadata, invitation details, and participant lists.

Field	Type	Description
`roomID`	`String?`	Active call room ID. Empty if no ongoing call exists in the group.
`invitation`	`InvitationInfo?`	Invitation details of the active call.
`participant`	`List<ParticipantInfo>?`	List of participants currently connected in the room.
`token`	`String?`	Room authentication token.

If roomID is non-empty, use Get call room token to obtain media streaming credentials to join. If no active call is returned, treat the result as having no recoverable call and discard stale credentials.

Was this page helpful?