API 概览

更新时间: 2024/08/12 11:25:35

网易云信的网易会议提供全套开放、简单、安全的视频会议服务,帮助您实现卓越的音视频性能、丰富的会议协作能力、坚实的会议安全保障,为您打造企业专属的会议能力,提升办公协作效率,满足大、中、小会议全场景需求。您可以使用服务端 API 实现远程音视频会议、在线协作、会管会控、会议录制、指定邀请、布局管理等会议功能。

使用说明

网易会议提供客户端和服务端 RESTful API 供您调用,服务端 API 使用 HTTPS 网络请求协议,允许 POST 方法。API 参考主要介绍接口的请求语法、相关参数含义以及请求和返回示例。如果要进行快速二次开发,建议您使用客户端 SDK 开发包。

部分功能可通过客户端和服务端 API 两种方式实现,请根据您的实际需求和场景选择合适的调用方式。

会议账号管理

API
方法
请求 URL
创建会议账号 POST https://meeting.yunxinroom.com/scene/meeting/api/v2/add-user
批量查询会议账号 GET https://meeting.yunxinroom.com/scene/meeting/api/v2/batch-get-user?userUuids=user_uuid_sample1,user_uuid_sample2
更新会议账号 POST https://meeting.yunxinroom.com/scene/meeting/api/v2/update-user
封禁会议账号 POST https://meeting.yunxinroom.com/scene/meeting/api/v2/ban-user
解禁会议账号 POST https://meeting.yunxinroom.com/scene/meeting/api/v2/unban-user
注销会议账号 POST https://meeting.yunxinroom.com/scene/meeting/v2/delete-user
重置用户令牌 POST https://meeting.yunxinroom.com/scene/meeting/api/v2/refresh-user-token

会议管理

API
方法
请求 URL
创建会议 PUT 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
    此文档是否对你有帮助?
    有帮助
    去反馈
    • 使用说明
    • 会议账号管理
    • 会议管理
    • 巡检者角色管理
    • 会议直播管理