根据录制文件的id查询录制文件的下载链接,用来下载录制文件
默认接口请求频率限制:20次/秒
链接有效期: 4h
REST URL
GET https://sdk.xylink.com/api/rest/external/{version}/vods/{vodId}/getdownloadurl?enterpriseId=XXX&signature=XXX
请求参数说明:
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 | 初始平台 |
version | String | Path | 是 | 无 | 传v1即可 | |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 | |
signature | String | Query | 签名鉴权1.0(旧):是 签名鉴权2.0:否 | 无 | API签名,参考 签名鉴权 | |
vodId | long | Path | 是 | 无 | 录制文件id | 3.9 |
请求成功返回结果示例1
{
"downloadUrl": "xxxxxx",
"status": 777001,
"ready": false
}
请求成功返回结果示例2
{
"downloadUrl": "xxxxxx",
"innerDownloadUrl": "xxxxxx",
"status": 777000,
"ready": true,
"signatureType": 1,
"signatureValue": "demoData",
"fileSize": xxxxxx,
"vodUrlItems": [
{
"favoriteId": 1,
"downloadUrl": "xxxxxx",
"innerDownloadUrl": "xxxxxx",
"ready": true,
"signatureType": 1,
"signatureValue": "xxxxxx"
}
]
}
返回数据分三种情况:
1、若该vod文件已经生成,但是从未被解密过,则会返回的消息体中status为777001,ready为false
2、若视频文件尚未生成,则会返回的消息体中status为777002,ready为false
3、视频文件已经生成,并且已经被解密,则返回成功777000,ready为true
返回参数说明:
参数名称 | 说明 |
downloadUrl | 视频下载链接(首次调用会得到该值,但是是否可用需要根据ready来判断) |
innerDownloadUrl | 内网视频下载链接(同视频下载链接,适用于混合云部署模式) |
status | 适配下载状态 |
ready | 视频是否准备完成 |
signatureType | 摘要加密类型 0:不加密,1:MD5,2:SM3(default:0,int类型) |
signatureValue | 摘要加密值 |
fileSize | 录制文件大小 ( kb ) |
vodUrlItems | 视频列表 |
请求失败结果示例
{
"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错误码
触发事件回调:首次调用获取视频下载链接或获取视频播放链接,会触发DecryptStatus事件回调。