服务端 API商业版

更新会议

按字段更新会议资料、设置和受邀用户。此接口仅在 OpenIM 商业版中提供。请先在接入准备中配置 API 地址和有效 Token。

HTTP 请求

POST {API_ADDRESS}/rtc-meeting/update_meeting

请求示例

curl --request POST "${API_ADDRESS}/rtc-meeting/update_meeting" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" \
  --header "token: ${TOKEN}" \
  --data-raw '{
  "meetingID": "meeting_001",
  "updatingUserID": "user_001",
  "title": "示例名称",
  "scheduledTime": 1,
  "meetingDuration": 1,
  "password": "123456",
  "timeZone": "example",
  "repeatInfo": {
    "endDate": 1719800000000,
    "repeatTimes": 0,
    "repeatType": 1,
    "interval": 1,
    "repeatDaysOfWeek": [
      1
    ],
    "repeatMeetingID": "repeat_meeting_001",
    "repeatSequence": 1
  },
  "canParticipantsEnableCamera": false,
  "canParticipantsUnmuteMicrophone": false,
  "canParticipantsShareScreen": false,
  "disableCameraOnJoin": false,
  "disableMicrophoneOnJoin": false,
  "canParticipantJoinMeetingEarly": false,
  "lockMeeting": false,
  "audioEncouragement": false,
  "videoMirroring": false,
  "inviteeInfo": {
    "inviteeUserIDs": [
      "user_001"
    ]
  }
}'

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

请求体

{
  "meetingID": "meeting_001",
  "updatingUserID": "user_001",
  "title": "示例名称",
  "scheduledTime": 1,
  "meetingDuration": 1,
  "password": "123456",
  "timeZone": "example",
  "repeatInfo": {
    "endDate": 1719800000000,
    "repeatTimes": 0,
    "repeatType": 1,
    "interval": 1,
    "repeatDaysOfWeek": [1],
    "repeatMeetingID": "repeat_meeting_001",
    "repeatSequence": 1
  },
  "canParticipantsEnableCamera": false,
  "canParticipantsUnmuteMicrophone": false,
  "canParticipantsShareScreen": false,
  "disableCameraOnJoin": false,
  "disableMicrophoneOnJoin": false,
  "canParticipantJoinMeetingEarly": false,
  "lockMeeting": false,
  "audioEncouragement": false,
  "videoMirroring": false,
  "inviteeInfo": {
    "inviteeUserIDs": ["user_001"]
  }
}

参数名	是否必填	类型	说明
meetingID	是	string	会议 ID。
updatingUserID	是	string	更新会议的用户 ID。
title	否	StringValue	会议或资源标题。
scheduledTime	否	Int64Value	计划开始时间，Unix 毫秒时间戳。
meetingDuration	否	Int64Value	会议持续时长，单位为秒。
password	否	StringValue	会议密码；无密码时可为空。
timeZone	否	StringValue	会议创建者指定的时区。
repeatInfo	是	MeetingRepeatInfo	结构为会议模块的 `MeetingRepeatInfo`。
canParticipantsEnableCamera	否	BoolValue	是否允许参会者启用摄像头。
canParticipantsUnmuteMicrophone	否	BoolValue	是否允许参会者取消麦克风静音。
canParticipantsShareScreen	否	BoolValue	是否允许参会者共享屏幕。
disableCameraOnJoin	否	BoolValue	加入会议时是否默认关闭摄像头。
disableMicrophoneOnJoin	否	BoolValue	加入会议时是否默认关闭麦克风。
canParticipantJoinMeetingEarly	否	BoolValue	是否允许参会者提前加入会议。
lockMeeting	否	BoolValue	是否锁定会议；锁定后新用户不能加入。
audioEncouragement	否	BoolValue	是否启用音频激励显示。
videoMirroring	否	BoolValue	是否启用视频镜像。
inviteeInfo	是	InviteeInfo	结构为会议模块的 `InviteeInfo`。

响应

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

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": ""
}

响应参数

参数名	类型	说明
errCode	int	业务错误码，`0` 表示成功。
errMsg	string	错误简要信息，成功时通常为空。
errDlt	string	错误详细信息，成功时通常为空。

错误

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

权限和限制

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

HTTP 请求

请求示例

请求体

响应

响应参数

错误

权限和限制

相关页面