Browse SDKs · WASM
SDKsWASMEnterprise

Get a group call room

Query an active call room by group ID with the WASM SDK.

Copy

The parameter of signalingGetRoomByGroupID() is a group ID, not a custom roomID:

const { data: room } = await openimsdk.signalingGetRoomByGroupID(groupID);

if (room.roomID) {
  renderParticipants(room.participant ?? []);
}

Return result

When the Promise resolves, data is a CallingRoomData snapshot:

FieldTypeDescription
roomIDstringRoom ID of the current group call.
invitationRtcInvite (optional)Original invitation associated with the current room.
participantParticipantInfo[] (optional)Snapshot of participants currently in the room.

Each ParticipantInfo contains userInfo: PublicUserItem and may also contain groupMemberInfo: GroupMemberItem and groupInfo: GroupItem for the current group context. Account profile data, group nicknames, and group profile data come from different sources; do not overwrite one with another.

When no group call is active, treat an error or empty data as “no recoverable call” and do not continue using old credentials.

Even when your application uses a custom room ID for group calls, call this method with groupID, then merge call state by the returned or previously stored roomID.