Docs Overview/
Live/
Server APIs/
REST API/
Room Related/
Retrieve the Live Streaming List/

Retrieve the Live Streaming List

功能说明

App 管理员可以通过该接口获取直播列表。

接口调用说明

请求 URL 示例

https://xxxxxx/v4/live_engine_http_srv/get_room_list?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参见 REST API 简介。
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名：
中国：console.tim.qq.com
新加坡：adminapisgp.im.qcloud.com
v4/live_engine_http_srv/get_room_list
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

10次/秒。

请求包示例

基础形式
{
    "Next":"", 
    "Count":20
}
注意: 列表是按照ViewCount字段降序排序, 分页拉取

请求包字段说明

字段
类型
属性
说明
Next
String
必填
分页请求的分页参数，第一次为空字符串，后续使用响应包体的 Next，当响应包体的 Next 为空字符串时候，表示拉取完毕
Count
Integer
必填
单次拉取的房间数量，默认为20，上限为20

应答包体示例

基础形式
{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 0,
  "RequestId": "Id-8c9858f01e954611ae2d4c1b1ed7d583-O-Seq-52720",
  "Response" : {
    "Next":"1693271355-123123123123",
    "RoomList":[
      {
        "RoomName":"name",
        "RoomId":"room_id0",
        "Owner_Account":"bren",
        "CoverURL":"cover_url",
        "Category":[1,2,3],
        "CreateTime":1693271354,
        "ActivityStatus":1,
        "ViewCount":1000
      },
      ...
      {
        "RoomName":"name",
        "RoomId":"room_id19",
        "Owner_Account":"bren",
        "CoverURL":"cover_url",
        "Category":[1,2,3],
        "CreateTime":1693271354,
        "ActivityStatus":1,
        "ViewCount":900
      }
    ] 
  }
}


应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果，OK 表示处理成功，FAIL 表示失败
ErrorCode
Integer
错误码，0表示成功，非0表示失败
ErrorInfo
String
错误信息
RequestId
String
唯一请求 ID，每次请求都会返回, 定位问题时需要提供该次请求的 RequestId
RoomList
Array
房间 ID 列表，默认按照 view count 降序排序
RoomName
String
房间名字
RoomId
String
房间 ID
Owner_Account
String
房间群主 ID
CoverURL
String
房间封面
Category
Array
直播间分类标签，数组大小上限为3
CreateTime
Integer
房间创建时间
ActivityStatus
Integer
直播间活跃状态：用户自定义标记
ViewCount
Integer
用户进房总次数
Next
String
当房间列表拉完后，返回空字符串，否则返回下次请求的 Next

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。 公共错误码（60000到79999）参见 错误码 文档。 本 API 私有错误码如下：
错误码
含义说明
100001
服务器内部错误，请重试
100002
请参数非法，请根据错误描述检查请求是否正确