API 概览

更新时间: 2023/08/14 08:53:51

除客户端 API 外,网易会议还提供 RESTful 形式的服务端 API,通过发送 HTTPS 请求就可以创建(POST)会议账号、查询(GET)会议信息等相关数据或执行相关操作。

会议账号管理

API
方法
请求 URL
创建会议账号 PUT https://roomkit.netease.im/scene/meeting/api/{appId}/v1/account/create
查询会议账号 GET https://roomkit.netease.im/scene/meeting/api/{appId}/v1/account/userUuid/{userUuid}
更新会议账号 POST https://roomkit.netease.im/scene/meeting/api/{appId}/v1/account/userUuid/{userUuid}

会议管理

API
方法
请求 URL
创建会议 POST https://roomkit.netease.im/scene/meeting/api/{appId}/v1/create/{type}
查询会议信息 GET https://roomkit.netease.im/scene/meeting/api/{appId}/v1/info/{meetingId}
修改会议信息 POST https://roomkit.netease.im/scene/meeting/api/{appId}/v1/edit/{meetingId}
取消会议 DELETE https://roomkit.netease.im/scene/meeting/api/{appId}/v1/cancel/{meetingId}
修改会议销毁时间 PUT https://roomkit.netease.im/scene/meeting/api/{appId}/v1/meeting/{meetingId}/destroyTime/{destroyTime}
结束会议 DELETE
  • https://roomkit.netease.im/scene/meeting/api/{appId}/v1/close/meetingId/{meetingId}/recycle/{recycle}
  • https://roomkit.netease.im/scene/meeting/api/{appId}/v1/close/meetingNum/{meetingNum}/recycle/{recycle}
  • https://roomkit.netease.im/scene/meeting/api/{appId}/v1/close/meetingShortNum/{meetingShortNum}/recycle/{recycle}
  • 巡检者角色管理

    API
    方法
    请求 URL
    增加巡检者 PUT https://roomkit.netease.im/apps/v2/room/bind/observer
    解绑巡检者角色 POST https://roomkit.netease.im/apps/v2/room/unbind/observer

    会议直播管理

    API
    方法
    请求 URL
    开始直播 POST https://{endpoint}/apps/v2/live-start
    修改直播 POST https://{endpoint}/apps/v2/live-update
    查询直播信息 GET https://{endpoint}/apps/v2/live-info/?roomArchiveId={roomArchiveId}
    结束直播 POST https://{endpoint}/apps/v2/live-end
    此文档是否对你有帮助?
    有帮助
    去反馈
    • 会议账号管理
    • 会议管理
    • 巡检者角色管理
    • 会议直播管理