You need to enable JavaScript to run this app.
导航

MGetVideoByVids - 批量获取视频播放链接

最近更新时间2024.03.01 10:48:28

首次发布时间2024.03.01 10:48:28

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

使用场景

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

请求说明

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

调试

请求参数

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

Query

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

MGetVideoByVids

要执行的操作,取值:MGetVideoByVids

Version
String

2021-09-01

API的版本,取值:2021-09-01

Body

参数
类型
是否必填
示例值
描述
GroupVideos
Array of GroupVideo

内容ID与Vid列表。

Ssl
Boolean

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

返回参数

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

参数
类型
示例值
描述
Data
Array of VideoData

响应数据。

请求示例

{
    "GroupVideos": [
        {
            "GroupId": 170....,
            "Vid": "...."
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210903095110010225146063018E0***",
        "Action": "MGetVideoByVids",
        "Version": "2021-09-01",
        "Service": "volc_content_api",
        "Region": "cn-north-1"
    },
    "Data": [
        {
            "PosterUrl": "https://....",
            "VideoDuration": 15.318,
            "VideoId": "...",
            "RequestId": "20210903095110010225146063018E0***",
            "VideoStatus": "wait_audit"
        }
    ],
    "BaseResp": {
        "StatusMessage": "success",
        "StatusCode": 1000
    }
}

错误码

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

状态码
错误码
错误信息
说明
200
1002
服务未知错误

请联系火山引擎技术人员

200
1001
参数错误

返回具体的参数错误描述

200
1022
vid不存在

查询vid不存在

200
1023
批量vid请求参数为空

查询vid集合为空

200
1024
批量请求的vid列表超过限制

单次查询vid集合上限为20

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

文章被删除或者下线