根据直播 id 获取某个直播（新）

功能说明

根据直播 id 获取一个直播的详细信息，支持多分辨率(清晰度)直播。

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

实现方法

REST URL

GET https://sdk.xylink.com/api/rest/external/{version}/liveVideo5/query?enterpriseId=XXX&liveId=xxx&meetingRoomNumber=XXX&password=xxx&signature=XXX

请求参数说明:

参数	参数类型	参数位置	必须	默认值	说明	初始平台
version	String	Path	是	无	传v1即可	6.0不支持该接口
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得
signature	String	Query	签名鉴权1.0（旧）：是签名鉴权2.0：否	无	API签名，参考签名鉴权
liveId	String	Query	是	无	直播id	3.9(2022-1121版本)
meetingRoomNum	String	Query	是	无	云会议室号	3.9(2022-1121版本)
password	String	Query	是	无	会议室入会密码	3.9(2022-1121版本)

示例代码

结果示例

请求成功返回结果示例

{
    "liveId": "xxxxxx",
    "enterpriseId": "xxxxxx",
    "meetingRoomNumber": "xxxxxx",
    "nemoNumber": "",
    "status": "WAIT",
    "title": "研发测试",
    "startTime": xxxxxx,
    "endTime": xxxxxx,
    "detail": "研发测试",
    "autoRecording": true,
    "autoPublishRecording": true,
    "location": "null",
    "viewUrl": "https://sdk.xylink.com/xxxxxx/xxx/xxxxxx",
    "thirdpartyPushURL": "null",
    "defaultLiveResolutionType": "DEFAULT",
    "liveLayoutConfig": null,
    "liveViewerInvited": null,
    "extras": "{\"layout\":{\"screen\":\"landscape\",\"people\":{\"view\":\"symTiling\",\"mode\":\"auto\"},\"content\":{\"view\":\"symTiling\",\"mode\":\"auto\",\"prefer\":false}},\"OSD\":{\"nameplate\":{\"enabled\":true}}}",
    "pullUrls": [                               
        {   
            "resolutionType":"SUPER_HIGH_DEFINATION",   
            "videoRtmp":"xxxxxx",               
            "videoFlv":"xxxxxx",                
            "videoM3u8":"xxxxxx",                
            "defaultResolution": true           
        }   
    ],
    "pushUrl": "xxxxxx"
}

返回参数说明:

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

请求失败结果示例

{
    "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错误码

错误码	描述
60051	无效的直播id
60053	无效的云会议室号
80003	无效的云会议室密码

2024-04-02 15:10:14

导出PDF文档