You need to enable JavaScript to run this app.
导航
GetVideoByVid - 单个获取视频播放链接
最近更新时间:2024.03.01 10:48:28首次发布时间:2024.03.01 10:48:28

通过内容推荐接口获取到火山来源的视频内容后,通过Vid和GroupId获取可播放的资源链接。

使用场景

  • 接口使用方式:
    • 视频播放时,调用接口获取播放链接,判断VideoStatus字段,active时为可播放,可避免下发后因内容状态变更导致的链接失效。
  • 视频url有效期:

请求说明

  • 请求方式:POST
  • 请求地址:https://cms.volcengineapi.com?Action=GetVideoByVid&Version=2021-08-18
  • 请求头:ServiceName: volc_content_api

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数
类型
是否必填
示例值
描述
Action
String

GetVideoByVid

要执行的操作,取值:GetVideoByVid

Version
String

2021-08-18

API的版本,取值:2021-08-18

Body

参数
类型
是否必填
示例值
描述
GroupId
Long

内容ID。

Vid
String

内容推荐接口中返回的视频id。

Ssl
Boolean

是否需要https链接,true:https链接,默认为 false。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
Data
VideoData

响应数据。

请求示例

{
    "GroupId":12304,
    "Vid":"shilivid"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202111021706140101941000965D007***",
        "Action": "GetVideoByVid",
        "Version": "2021-08-18",
        "Service": "volc_content_api",
        "Region": "cn-north-1"
    },
    "Data": {
        "PosterUrl": "https://....",
        "VideoDuration": 312.122,
        "VideoId": "...",
        "VideoList": [
            {
                "Definition": "360p",
                "MainUrl": "....",
                "Size": 6599735,
                "Height": 360,
                "Width": 360
            }
        ],
        "RequestId": "202111021706140101941000965D007***",
        "VideoStatus": "active"
    },
    "BaseResp": {
        "StatusMessage": "success",
        "StatusCode": 1000
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
200
1001
参数错误

返回具体的参数错误描述。

200
1002
服务未知错误

请联系火山引擎技术人员。

200
1020
审核中,视频暂时无法播放。

视频状态为审核中。

200
1021
未通过审核,视频无法播放

视频状态为未通过审核。

200
1022
vid不存在

查询vid不存在。

200
1025
文章不存在或文章状态不正确

文章被删除或者下线。