根据直播状态查询直播列表

功能说明

根据直播状态获取直播信息列表。

默认接口请求频率限制：20次/秒

实现方法

REST URL

GET https://sdk.xylink.com/api/rest/external/{version}/liveVideo3/enterprise/live/page?enterpriseId=&liveStatus=XXX&type=XXX&pageIndex=XXX&pageSize=XXX&needExtras=XXX&signature=XXX

请求参数说明:

参数	参数类型	参数位置	必须	默认值	说明	初始平台
version	String	Path	是	无	传v1即可
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得
signature	String	Query	签名鉴权1.0（旧）：是签名鉴权2.0：否	无	API签名，参考签名鉴权
type	String	Query	是	sdk	直播类型：sdk、all	5.2
needExtras	String	Query	否	false	是否需要直播附加配置（如果不需要，则返回的出参结构中无extras字段）	5.2
pageIndex	int	Query	否	0	页码：从0开始	3.9
pageSize	int	Query	否	10	每页查询数量：最大50	3.9
liveStatus	int	Query	否	0	直播状态( 0-未开始； 1-正在直播；2-已结束)	3.9

示例代码

结果示例

请求成功返回结果示例

{
    "page": 0,
    "pageTotal": 1,
    "rowsTotal": 1,
    "rows": 1,
    "list": [
        {
            "liveId": "96803178131313903hdl189awf699b",
            "enterpriseId": "1234243483fc26e44353cfe0bdf2272131",
            "confNo": "9000637011",
            "nemoNumber": "",
            "status": "PAUSE",
            "title": "研发部技术分享",
            "startTime": 1640847660000,
            "endTime": 1640856600000,
            "detail": "技术部分享",
            "autoRecording": true,
            "autoPublishRecording": true,
            "location": "null",
            "flv": "http://prdlive.ainemo.com/prdnemo/96803178131313903hdl189awf699b.flv?auth_key=1640943000-0-0-sdfsf2142f84c46242dads",
            "rtmp": "rtmp://prdlive.ainemo.com/prdnemo/96803178131313903hdl189awf699b?auth_key=1640943000-0-0-sdfsf2142f84c46242dads",
            "viewUrl": "http://cloud.xylink.com/live/v/96803178131313903hdl189awf699b",
            "defaultLiveResolutionType": "DEFAULT",
            "liveLayoutConfig": null,
            "liveViewerInvited": null
        }
    ]
}

返回参数说明:

Key	说明
page	当前页
pageTotal	总页数
rowsTotal	总条数
rows	当前页的条数
liveId	直播Id
enterpriseId	企业Id
confNo	云会议号
status	直播状态(WAIT，LIVING，PAUSE，END)
title	直播标题
startTime	直播开始时间，时间戳
endTime	直播结束时间，时间戳
detail	直播详情
autoRecording	是否自动录制（true/false）
autoPublishRecording	是否自动发布录制（true/false）
location	直播地点
flv	播流url
hls	播流url
rtmp	播流url
liveViewerInvited	邀请观看人
defaultLiveResolutionType	直播分辨率：DEFAULT、NORMAL
screen	横竖屏直播
maxCells	最大窗口数
view	直播布局类型
mode	直播布局模式
prefer	指示是否content（第一分屏）幕显示
nameplate>enabled	是否叠加终端名称

请求失败结果示例

{
    "developerMessage": "ErrorStatus: SDK_INVALID_APPKEY No app found for extId: ",
    "userMessage": "sdk.invalid.key",
    "errorCode": 60001,
    "moreInfo": "http://www.com.ainemo.com/errors/60001"
}

错误码

以下仅列出该接口业务逻辑错误码，其他错误码见小鱼RESTAPI错误码

错误码	描述
60025	直播id错误

2024-03-22 11:40:40

导出PDF文档