通过该接口修改某一会议的信息。

推荐您使用新版接口 修改会议信息 /scene/meeting/api/{appId}/v2/edit/{meetingId}。

请求信息

• 请求方法：POST
• URL：https://roomkit.yunxinapi.com/scene/meeting/api/{appId}/v1/edit/{meetingId}
• Content-Type：application/json;charset=utf-8

请求 URL

参数名称	类型	是否必选	示例	说明
appId	String	是	abcdefg****	应用的 App Key。
meetingId	Long	是	110120119	会议唯一 ID。

请求头参数

请求中 Header 的设置请参考 请求结构 描述。

请求体参数

请求中 Body 须为 JSON 格式，参数说明如下：

参数名称	类型	是否必选	示例	描述
password	String	否	123456	会议密码。 只能填入数字串，长度限制为 4 ~ 6 位。
subject	String	是	随机会议	会议主题。 长度限制为 30 字符以内。
startTime	Long	type = 3：必选。 type = 1：可选。	1616738307000	预约开始时间。单位为毫秒。
endTime	Long	type = 3：必选。 type = 1：可选。	1616738347000	预约结束时间。单位为毫秒。
roomConfigId	Long	是	40	固定值为 40。NERoom 应用的房间模板 ID。
- roomConfig	JsonObject	是	-	NERoom 应用的房间配置。
- resource	JsonObject	是	-	NERoom 应用的房间配置。
whiteboard	Boolean	否	true	是否创建白板。 true（默认）：是。 false：否。
chatroom	Boolean	否	true	是否创建聊天室。 true（默认）：是。 false：否。
live	Boolean	否	true	是否创建主播间。 true：是。 false（默认）：否。
rtc	Boolean	否	true	是否创建音视频房间。 true（默认）：是。 false：否。
sip	Boolean	否	true	是否开启 sip。 true：是。 false（默认）：否。
record	Boolean	否	true	是否录制。 true：是。 false（默认）：否。
- roomProperties	JsonObject	否	-	会议扩展字段。
- extraData	JsonObject	否	-	会议扩展字段。
value	String	否	-	会议扩展字段。
roleBinds	JsonObject	否	"abcdefg": "host"	给对应的成员绑定角色，格式为 "userUuid": "角色名称"。角色名称包括： host：主持人 cohost：联席主持人 member：成员
- scheduledMembers	List	否	-	预约会议成员列表，用于指定参会者及其角色。 列表中的成员将以指定角色加入会议。 预约成员总数不得超过 300 人。 若不指定，则默认所有参会者以普通成员身份加入。 会议拥有人 owner 需指定为预约成员。
userUuid	Object	是	abcg****	会议账号。
role	Object	是	host	会议角色。成员角色包含以下三种： host：主持人 cohost：联席主持人 member：普通成员
timezoneId	String	否	America/Cayman	国际时区 ID。取值可参考 时区列表。
coHostLimit	Integer	否	2	会议的联席主持人上限。

请求体示例

JSON{
  "owner": "abcdefghijk",
  "subject": "随机会议",
  "password": "112233",
  "roleBinds": {
    "yourUserUuid": "host"
  },
  "roomConfigId": "40",
  "roomConfig": {
    "resource": {
      "whiteboard": true,
      "chatroom": true,
      "live": true,
      "rtc": true,
      "sip": true,//true 表示开启，false 表示关闭，默认 false，开启前请确认是否使用了 sip 服务
      "record": true
    }
  }
  "roomProperties": {
    "extraData":{
      "value": "meeting extra data"
      }
    }
}

响应信息

响应参数

以下是返回结果中 data 属性内包含的参数。其他统一返回参数的相关说明请参考 返回结果。

参数名称	类型	示例	说明
meetingId	Long	123456****	会议唯一 ID。
meetingNum	String	123456789	随机会议码（长度为 9 位数字）或个人会议码（长度为 10 位数字）。
subject	String	随机会议。	预约会议主题
startTime	Long	1616738307000	预约开始时间。单位为毫秒。
endTime	Long	1616738307000	预约结束时间。单位为毫秒，返回值为 -1 表示会议无限期。
password	String	123456	会议密码。无密码则置空。
state	int	1	会议状态。 1：未开始 2：进行中 3：已终止 4：已取消 5：已回收
meetingShortNum	String	1234	会议短号。 只有当您创建会议账号时设置了会议短号，且修改的会议是使用个人会议号创建的时，才会返回此参数。

响应体示例

JSON{
  "meetingId": "123456****",
  "meetingNum": "123456789",
  "subject": "随机会议",
  "startTime": "1616738307000"，
  "endTime": "1618844844651"，
  "password": "123456",
  "state": "1",
  "meetingShortNum": "1234"
}

错误码

详情请参考 错误码。