Browse SDKs · iOS
Platform
SDKsiOSEnterprise

Retrieve a group call room

Retrieve an active call room by group ID with the OpenIM iOS SDK.

Copy

Query the active audio or video call room and connected participants for a specified group using signalingGetRoomByGroupID:onSuccess:onFailure:.

Parameters

ParameterTypeRequiredDescription
groupIDNSString *YesTarget group identifier. Pass the group ID, not an application-defined room ID.

Code example

[[OIMManager manager] signalingGetRoomByGroupID:groupID
                                      onSuccess:^(OIMParticipantConnectedInfo * _Nullable room) {
    if (room.roomID.length > 0) {
        [self renderParticipants:room.participant roomID:room.roomID];
    }
}
                                      onFailure:^(NSInteger code, NSString * _Nullable message) {
    [self handleMissingGroupCall:code message:message];
}];

Return value

The onSuccess callback delivers an OIMParticipantConnectedInfo object describing current room metadata, linked invitation details, and the list of active connected participants. If no call is currently active in the group, treat the result as having no ongoing call and refrain from using stale credentials.