anyRTC 提供 RESTful 形式的接口 API,通过请求相关接口获取项目用量,踢人,查询在线用户状态,以及输入在线媒体流等功能。
点击查看我们的服务端 RESTful API 文档。该文档包含方法和参数的详细解释,并提供在线请求功能,在文档页内就能进行 RESTful API 的调用。
所有请求都发送给 BaseUrl:https://api.agrtc.cn。
认证
RESTful API 仅支持 HTTPS 协议,且需要对接口进行认证。使用 RESTful API 前,你需要通过 HTTP 基本认证。
API 概览
IoT License 查询与激活
请求 URL | 方法 | 功能 |
---|---|---|
BaseUrl/dev/v1/license/apps/{appid}/licenses | GET | 获取License列表数据 |
BaseUrl/dev/v1/license/apps/{appid}/activation | POST | 激活License |
查询项目用量
请求 URL | 方法 | 功能 |
---|---|---|
BaseUrl/dev/v1/usage | GET | 获取单个项目的用量数据 |
踢人规则管理
请求 URL | 方法 | 功能 |
---|---|---|
BaseUrl/dev/v1/kicking-rule | POST | 创建踢人规则 |
BaseUrl/dev/v1/kicking-rule | GET | 获取踢人规则列表 |
BaseUrl/dev/v1/kicking-rule | PUT | 更新踢人规则的生效时间 |
BaseUrl/dev/v1/kicking-rule | DELETE | 删除踢人规则 |
查询在线频道信息
请求 URL | 方法 | 功能 |
---|---|---|
BaseUrl/dev/v1/channel/user/property/ {appid}/{uid}/{channelName} | GET | 查询用户状态 |
BaseUrl/dev/v1/channel/user/{appid}/ {channelName} | GET | 获取用户列表 |
BaseUrl/dev/v1/channel/{appid} | GET | 分页查询项目的频道列表 |
输入在线媒体流
请求 URL | 方法 | 功能 |
---|---|---|
{region}/v1/projects/{appId}/cloud-player/players | POST | Create:创建云端播放器 |
{region}/v1/projects/{appId}/cloud-player/players/{id} | DELETE | Delete:销毁一个云端播放器 |
v1/projects/{appId}/cloud-player/players} | GET | List:查询一个项目下所有云端播放器 |