结束会议

更新时间: 2023/03/16 03:50:02

会议开始后,主持人使用会议唯一 ID、会议号或会议短号结束一个会议。

当会议内所有人退出会议后,会议会自动结束,无需调用此接口。

使用会议唯一 ID 结束会议

接口请求信息

  • 请求方法:DELETE
  • URL:https://roomkit.netease.im/scene/meeting/api/{appId}/v1/close/meetingId/{meetingId}/recycle/{recycle}

URL 中参数说明:

参数名称
类型
是否必选
示例
描述
meetingId Long 必选 11011**** 会议唯一 ID。
recycle Boolean 必选 true 是否回收。
  • true:回收。当会议在预约结束时间之前结束时,与会者不可以再进入该会议。
  • false:不回收。当会议在预约结束时间之前结束时,与会者还可以再进入该会议。
  • 请求参数

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

    返回参数

    此接口的返回结果中无 data 属性内包含的参数。具体返回参数请参考返回结果

    示例

    请求 Body 示例

    返回示例

    //正常返回示例
    "Content-Type": "application/json; charset=utf-8"
    {
      "code": 0
    }
    
    //异常返回示例
    {
        "code":501,
        "msg":"服务器内部错误"
    }
    

    使用会议号结束会议

    接口请求信息

    • 请求方法:DELETE
    • URL:https://roomkit.netease.im/scene/meeting/api/{appId}/v1/close/meetingNum/{meetingNum}/recycle/{recycle}

    URL 中参数说明:

    参数名称
    类型
    是否必选
    示例
    描述
    meetingNum String 必选 11011**** 会议号。
    recycle Boolean 必选 true 是否回收。
  • true:回收。当会议在预约结束时间之前结束时,与会者不可以再进入该会议。
  • false:不回收。当会议在预约结束时间之前结束时,与会者还可以再进入该会议。
  • 请求参数

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

    返回参数

    此接口的返回结果中无 data 属性内包含的参数。具体返回参数请参考返回结果

    示例

    请求 Body 示例

    返回示例

    //正常返回示例
    "Content-Type": "application/json; charset=utf-8"
    {
      "code": 0
    }
    
    //异常返回示例
    {
        "code":501,
        "msg":"服务器内部错误"
    }
    

    使用会议短号结束会议

    接口请求信息

    • 请求方法:DELETE
    • URL:https://roomkit.netease.im/scene/meeting/api/{appId}/v1/close/meetingShortNum/{meetingShortNum}/recycle/{recycle}

    URL 中参数说明:

    参数名称
    类型
    是否必选
    示例
    描述
    meetingShortNum String 必选 11011**** 会议短号。
    recycle Boolean 必选 true 是否回收。
  • true:回收。当会议在预约结束时间之前结束时,与会者不可以再进入该会议。
  • false:不回收。当会议在预约结束时间之前结束时,与会者还可以再进入该会议。
  • 请求参数

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

    返回参数

    此接口的返回结果中无 ret 属性内包含的参数。具体返回参数请参考返回结果

    示例

    请求 Body 示例

    返回示例

    //正常返回示例
    "Content-Type": "application/json; charset=utf-8"
    {
      "code": 0
    }
    
    //异常返回示例
    {
        "code":501,
        "msg":"服务器内部错误"
    }
    
    此文档是否对你有帮助?
    有帮助
    去反馈
    • 使用会议唯一 ID 结束会议
    • 接口请求信息
    • 请求参数
    • 返回参数
    • 示例
    • 请求 Body 示例
    • 返回示例
    • 使用会议号结束会议
    • 接口请求信息
    • 请求参数
    • 返回参数
    • 示例
    • 请求 Body 示例
    • 返回示例
    • 使用会议短号结束会议
    • 接口请求信息
    • 请求参数
    • 返回参数
    • 示例
    • 请求 Body 示例
    • 返回示例