修改会议信息

更新时间: 2023/07/04 09:11:46

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

接口请求信息

  • 请求方法:POST
  • URL:https://roomkit.netease.im/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 应用的房间配置。
roomProperties JsonObject 可选 - 会议扩展字段。
roleBinds JsonObject 可选 "abcdefg": "host" 给对应的成员绑定角色,格式为 "userUuid": "角色名称"。角色名称包括:
  • host:主持人
  • cohost:联席主持人
  • member:成员
  • 返回参数

    以下是返回结果中 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 会议短号。
    只有当您创建会议账号时设置了会议短号,且修改的会议是使用个人会议号创建的时,才会返回此参数。

    示例

    请求 Body 示例

    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" 
          }
        }
    }
    

    返回示例

    {
      "meetingId": "123456****",
      "meetingNum": "123456789",
      "subject": "随机会议",
      "startTime": "1616738307000""endTime": "1618844844651""password": "123456",
      "state": "1",
      "meetingShortNum": "1234"
    }
    
    此文档是否对你有帮助?
    有帮助
    去反馈
    • 接口请求信息
    • 请求参数
    • 返回参数
    • 示例
    • 请求 Body 示例
    • 返回示例