RESTful API

最近更新时间:2022-09-20 05:17:40

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}/licensesGET获取License列表数据
BaseUrl/dev/v1/license/apps/{appid}/activationPOST激活License

查询项目用量

请求 URL方法功能
BaseUrl/dev/v1/usageGET获取单个项目的用量数据

踢人规则管理

请求 URL方法功能
BaseUrl/dev/v1/kicking-rulePOST创建踢人规则
BaseUrl/dev/v1/kicking-ruleGET获取踢人规则列表
BaseUrl/dev/v1/kicking-rulePUT更新踢人规则的生效时间
BaseUrl/dev/v1/kicking-ruleDELETE删除踢人规则

查询在线频道信息

请求 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分页查询项目的频道列表