查询项目的频道列表
更新时间不可用
按页查询指定项目下的频道列表。
GET
https://api.sd-rtn.com/dev/v1/channel/{appid}你可以在请求路径中指定要查询的页面和每页显示的频道数量。请求成功后,会根据你指定的 page_size 返回指定页面的频道列表。
注意
如果频道内的人数频繁变化,查询结果可能不准确,可能会出现同一频道重复出现在不同分页中,或者某一频道未出现在任何分页中的情况。
鉴权
appidunknown必填
项目的 App ID。可通过以下方式获取:
- 从声网控制台获取。
- 调用获取所有项目信息 API,并读取响应包体中
vendor_key字段的值。
page_nonumber你想要查询的页面,默认值为 0,即第一页。
page_sizenumber个页面显示的频道数量,取值范围为 [1,500],默认值为 100。
响应
如果状态码为 200,则请求成功。
响应 Body
successboolean本次请求的状态:
true:请求成功false:预留
频道数据。
频道列表。由多个 object 组成,每个 object 表示一个频道的信息。
注意:指定的页面不包含频道列表时,该字段返回值为空。
channel_namestring频道名。
user_countnumber频道内的用户人数。
total_sizenumber频道总数。
请求示例
curl --request GET \
--url "https://api.sd-rtn.com/dev/v1/channel/:appid" \
--header 'Authorization: Basic <credentials>'响应示例
{
"success": true,
"data": {
"channels": [
{
"channel_name": "频道名。",
"user_count": 0
}
],
"total_size": 0
}
}