服务端 API商业版

获取会议详情

获取指定会议的资料、设置和重复会议信息。此接口仅在 OpenIM 商业版中提供。请先在接入准备中配置 API 地址和有效 Token。

HTTP 请求

POST {API_ADDRESS}/rtc-meeting/get_meeting

请求示例

curl --request POST "${API_ADDRESS}/rtc-meeting/get_meeting" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" \
  --header "token: ${TOKEN}" \
  --data-raw '{
  "userID": "user_001",
  "meetingID": "meeting_001"
}'

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

请求体

{
  "userID": "user_001",
  "meetingID": "meeting_001"
}

参数名	是否必填	类型	说明
userID	是	string	OpenIM 用户 ID。
meetingID	是	string	会议 ID。

响应

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

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "meetingDetail": {
      "info": {
        "systemGenerated": {
          "creatorUserID": "user_001",
          "creatorNickname": "user_001",
          "status": "scheduled",
          "startTime": 1719800000000,
          "meetingID": "meeting_001"
        },
        "creatorDefinedMeeting": {
          "title": "示例名称",
          "scheduledTime": 1719800000000,
          "meetingDuration": 3600,
          "password": "123456",
          "timeZone": "example",
          "hostUserID": "user_001",
          "coHostUSerID": ["user_001"],
          "inviteeUserIDs": ["user_001"]
        }
      },
      "setting": {
        "canParticipantsEnableCamera": false,
        "canParticipantsUnmuteMicrophone": false,
        "canParticipantsShareScreen": false,
        "disableCameraOnJoin": false,
        "disableMicrophoneOnJoin": false,
        "canParticipantJoinMeetingEarly": false,
        "lockMeeting": false,
        "audioEncouragement": false,
        "videoMirroring": false,
        "recordOn": false
      },
      "repeatInfo": {
        "endDate": 1719800000000,
        "repeatTimes": 0,
        "repeatType": 1,
        "interval": 1,
        "repeatDaysOfWeek": [1],
        "repeatMeetingID": "repeat_meeting_001",
        "repeatSequence": 1
      }
    }
  }
}

响应参数

参数名	类型	说明
errCode	int	业务错误码，`0` 表示成功。
errMsg	string	错误简要信息，成功时通常为空。
errDlt	string	错误详细信息，成功时通常为空。
data.meetingDetail	MeetingInfoSetting	结构为会议模块的 `MeetingInfoSetting`。

错误

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

权限和限制

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

HTTP 请求

请求示例

请求体

响应

响应参数

错误

权限和限制

相关页面