服务端 API商业版

按群组获取通话房间

获取群组当前关联的实时通话房间和参与者。此接口仅在 OpenIM 商业版中提供。请先在接入准备中配置 API 地址和有效 Token。

HTTP 请求

POST {API_ADDRESS}/rtc-meeting/signal_get_room_by_group_id

请求示例

curl --request POST "${API_ADDRESS}/rtc-meeting/signal_get_room_by_group_id" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" \
  --header "token: ${TOKEN}" \
  --data-raw '{
  "groupID": "group_001"
}'

商业版：此接口需要部署对应的商业版服务。接口是否可用以及具体权限以客户交付版本为准。

请求体

{
  "groupID": "group_001"
}

参数名	是否必填	类型	说明
groupID	是	string	OpenIM 群组 ID。

响应

请求被 OpenIM 正常处理时通常返回 200 OK。业务是否成功以响应体中的 errCode 为准。

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "invitation": {
      "inviterUserID": "user_001",
      "inviteeUserIDList": ["user_001"],
      "customData": "{}",
      "groupID": "group_001",
      "roomID": "room_001",
      "timeout": 0,
      "mediaType": "example",
      "platformID": 0,
      "sessionType": 1,
      "initiateTime": 1719800000000,
      "busyLineUserIDList": ["user_001"]
    },
    "participant": [
      {
        "groupInfo": {
          "groupID": "group_001",
          "groupName": "示例名称",
          "notification": "example",
          "introduction": "example",
          "faceURL": "https://example.com/resource",
          "ownerUserID": "user_001",
          "createTime": 1719800000000,
          "memberCount": 1,
          "ex": "{}",
          "status": 1,
          "creatorUserID": "user_001",
          "groupType": 1,
          "needVerification": 0,
          "lookMemberInfo": 0,
          "applyMemberFriend": 0,
          "notificationUpdateTime": 1719800000000,
          "notificationUserID": "user_001",
          "displayIsRead": false,
          "muteBypassUserIDs": ["user_001"]
        },
        "groupMemberInfo": {
          "groupID": "group_001",
          "userID": "user_001",
          "roleLevel": 0,
          "joinTime": 1719800000000,
          "nickname": "示例名称",
          "faceURL": "https://example.com/resource",
          "appMangerLevel": 0,
          "joinSource": 0,
          "operatorUserID": "user_001",
          "ex": "{}",
          "muteEndTime": 1719800000000,
          "inviterUserID": "user_001"
        },
        "userInfo": {
          "userID": "user_001",
          "nickname": "示例名称",
          "faceURL": "https://example.com/resource",
          "ex": "{}"
        }
      }
    ],
    "roomID": "room_001"
  }
}

响应参数

参数名	类型	说明
errCode	int	业务错误码，`0` 表示成功。
errMsg	string	错误简要信息，成功时通常为空。
errDlt	string	错误详细信息，成功时通常为空。
data.invitation	InvitationInfo	结构为会议模块的 `InvitationInfo`。
data.participant	ParticipantMetaData[]	通话参与者资料。
data.roomID	string	会议或实时通话房间 ID。

错误

错误响应使用 Platform API 通用结构，处理方式见错误码。

权限和限制

仅在 OpenIM 商业版中提供。
调用方必须校验操作用户和目标资源的业务权限。
请求数组和分页大小应遵循客户交付版本的服务端限制。

HTTP 请求

请求示例

请求体

响应

响应参数

错误

权限和限制

相关页面