Browse SDKs · uni-app / uni-app x
SDKsuni-appEnterprise

Get a group call room

OpenIM uni-app / uni-app x SDK guide for Get a group call room.

Copy
import { signalingGetRoomByGroupID } from '@/uni_modules/unix-openim-sdk'

const room = await signalingGetRoomByGroupID({ groupID })

The Commercial signalingGetRoomByGroupID() operation takes a group ID, not a custom room ID.

Result

The Promise resolves to OpenIMSignalingGetRoomByGroupIDResult | null:

FieldTypeDescription
roomIDstring or nullRoom identifier for the current group call.
invitationOpenIMSignalingInvitationInfo or nullOriginal invitation associated with the room.

Unlike the Wasm result, the uni-app / uni-app x contract does not include participant records. Obtain participant state from the media engine or application state; do not invent a participant field.

A null result or empty roomID means there is no joinable call. Treat the snapshot as short-lived, continue handling signaling events, and obtain a valid token immediately before joining. Even when the application uses custom room IDs for group calls, query with groupID and merge the returned roomID into the active call state.