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 the current SignalingRoomInfo:

FieldTypeDescription
roomIDstringRoom ID of the current group call.
invitationSignalingInvitation (optional)Complete invitation data associated with the current room.
participantSignalingParticipantInfo[] (optional)Information about participants currently in the room.

Each SignalingParticipantInfo 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.

If the Promise resolves but data does not contain a usable roomID, there is no group call to recover; do not continue using old credentials. If the Promise rejects, use errCode to distinguish parameter, authentication, network, and server errors. Do not interpret every error as “no active call” unless your deployment defines a specific no-room error code.

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