Browse Platform API
Platform APIEnterprise

Get a call room by group ID

Copy

Get the active real-time call room associated with a group.

HTTP request

POST {API_ADDRESS}/rtc-meeting/signal_get_room_by_group_id

Request body

ParameterRequiredTypeDescription
groupIDYesstringOpenIM group ID.

Response

Returns data.invitation, participant metadata, and data.roomID. Participant metadata combines group, group-member, and user information for the active room.

Permissions and limits

  • Available only in OpenIM Enterprise.
  • Validate access to the group before returning live room state.