RESTful API
更新时间 2023/01/12 04:53:25
声网提供 RESTful 形式的服务端 API，通过发送 HTTPS 请求就可以获取 （GET），更新（PUT）, 创建 （POST），和删除 （DELETE） 项目、用量等相关数据。
点击查看我们的服务端 RESTful API 文档。该文档包含方法和参数的详细解释，并提供 Try it out 功能，使你在文档页内就能进行 RESTful API 的调用。
所有请求都发送给 BaseUrl：https://api.agora.io。
API 概览
项目管理
| 请求 URL | 方法 | 功能 |
|---|---|---|
| BaseUrl/dev/v1/project | POST | 创建新项目 |
| BaseUrl/dev/v1/project | GET | 获取指定项目 |
| BaseUrl/dev/v1/project | DELETE | 删除指定项目 |
| BaseUrl/dev/v1/projects | GET | 获取所有项目 |
| BaseUrl/dev/v1/project_status | POST | 禁用或启用项目 |
| BaseUrl/dev/v1/recording_config | POST | 设置录制服务器 IP |
| BaseUrl/dev/v1/signkey | POST | 启用或禁用主要 App 证书 |
| BaseUrl/dev/v1/reset_signkey | POST | 重置主要 App 证书 |
查询项目用量
| 请求 URL | 方法 | 功能 |
|---|---|---|
| BaseUrl/dev/v3/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 | 分页查询项目的频道列表 |
这篇文章对你有帮助吗？
是
否
