- 开发者工具 IDE
- 沙盒环境
- 抖音云
- 产品介绍
- 快速开始
- 场景指南
- 操作指南
- 开发指南
- SDK参考
- 产品动态
- 产品计费
- 常见问题
- OpenAPI调试台
媒资管理OpenApi收藏我的收藏
收藏
我的收藏分页获取媒资列表
API 说明
小程序开通抖音云,且开通短剧解决方案,可通过该 OpenApi 分页获取 video 列表信息
使用限制
- •只有开通抖音云的短剧方案的小程序才能使用该接口。
接口说明
基本信息
基本信息 | ||||
HTTP URL | ||||
HTTP Method | POST | |||
Scope | cloud.playlet | |||
权限要求 | 默认授权 |
请求头
字段名 | 类型 | 位置 | 是否必填 | 字段说明 |
Content-Type | string | Header | 是 | 固定值:application/json |
access-token | string | Header | 是 |
请求参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
page_size | int | 是 | 每一页的条数(最多 20 条/页) | |
page_number | int | 是 | 当前的页码(从 0 开始) | |
business_status | int | 否 | 审核状态(98 审核中,99 未审核,,传为审核和未审核均查询) | |
video_name | string | 否 | 短剧的名称 | cat.mp4 |
请求示例
Bash复制curl --location 'https://open.douyin.com/api/dyc_voc/get_video_list' \
--header 'Content-Type: application/json' \
--header 'access-token: clt.xxxxxx' \
--data '{
"page_size":10,
"page_number":0,
"env_id":"1",
"business_status" : "99",
"video_name" : ""
}'
响应参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
err_no | string | 是 | 错误码 | |
err_msg | int | 是 | 错误详 情 | |
log_id | string | 否 | 日志 id,用户 oncall 排查问题 | |
total_num | string | 是 | 查询的总数 | |
data | list<OpenVideoModel> | 否 | 具体的每一页的数据 | |
名称 | 类型 | 是否必填 | 描述 | 示例值 |
video_name | string | 是 | 视频的名称 | |
vid | string | 是 | 视频的唯一 id | |
size | int | 是 | 视频大小单位为 b | |
upload_time | int | 是 | 上传的时间 | |
business_status | int | 是 | 审核状态 | |
trans_code_status | int | 否 | 转码的状态 | 1:未转码 2:转码中 3:转码失败 4:转码成功 |
source_type | int | 否 | 视频的来源 | 1:控制台上传 2:抖音云 openApi 上传 3:行业侧同步 |
video_open_id | string | 否 | 行业侧视频 id | |
响应示例
正常示例
JSON复制{
"data": [
{
"video_name": "xxxxx",
"business_status": 99,
"size": 16186186,
"upload_time": 1700299345,
"vid": "v02ecxxxxxxxx"
}
],
"err_msg": "success",
"err_no": 0,
"log_id": "xxxxxxxx",
"total_num": 60
}
异常示例
JSON复制{
"err_msg": "video not exist",
"err_no": 401003,
"log_id": "20230822193748224DE2120360F701CA0A",
"total_num": 0,
"data": null
}
错误码
HTTP 状态码 | 错误码 | 描述 | 排查建议 |
400 | 41050 | no user authority error | 操作的用户需在通讯录权限范围中。 |
400 | 40001 | param error | 参数错误。 |
删除媒资列表
API 说明
小程序开通抖音云,且开通短剧解决方案,可通过该 openApi 分页删除上传过的媒资信息。
使用限制
- •只有开通抖音云的短剧方案的小程序才能使用该接口。
接口说明
注意需要评估删除链接的影响。
基本信息 | ||||
HTTP URL | ||||
HTTP Method | POST | |||
Scope | cloud.playlet | |||
权限要求 | 默认授权 |
基本信息
基本信息 | ||||
HTTP URL | ||||
HTTP Method | POST | |||
Scope | cloud.playlet | |||
权限要求 | 默认授权 |
请求头
字段名 | 类型 | 位置 | 是否必填 | 字段说明 |
Content-Type | string | Header | 是 | 固定值:application/json |
access-token | string | Header | 是 |
请求参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
vid | string | 是 | 媒资的 id | |
env_id | string | 是 | 抖音云 prod 环境的 id,需要登录抖音云控制台,查看 | |
请求示例
Bash复制curl --location 'https://open.douyin.com/api/dyc_voc/delete_video' \
--header 'Content-Type: application/json' \
--header 'access-token: cltxxxx' \
--data '{
"env_id":"env-xxxx",
"vid":"v0dxxxx"
}'
响应参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
err_no | string | 是 | 错误码 | |
err_msg | int | 是 | 错误详情 | |
log_id | string | 是 | 日志 id,用户 oncall 排查问题 | |
响应示例
正常示例
JSON复制{
"err_msg": "success",
"err_no": 0,
"log_id": "202308221926108152CB83794BE101C43B"
}
异常示例
JSON复制{
"err_msg": "space not exist",
"err_no": 401002,
"log_id": "202308221926108152CB83794BE101C43B"
}
根据 Vid 获取可播放链接
API 说明
小程序开通抖音云,且开通短剧解决方案,可通过该 openApi 分页获取 video 的播放链接。
视频转码之后。
使用限制
- •只有开通抖音云的短剧方案的小程序才能使用该接口。
- •需要完成短剧域名绑定的小程序才能使用该接口。
接口说明
基本信息
基本信息 | ||||
HTTP URL | ||||
HTTP Method | POST | |||
Scope | cloud.playlet | |||
权限要求 | 默认授权 |
请求头
字段名 | 类型 | 位置 | 是否必填 | 字段说明 |
Content-Type | string | Header | 是 | 固定值:application/json |
access-token | string | Header | 是 |
请求参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
vid | string | 是 | 视频资源的唯一 id | |
domain | string | 否 | 可以指定媒资管理已有域名,生成播放链接,未指定如设置默认域名,则按指定域名生成 未设置默认域名,则随机选择域名生成。 | |
expire_time | int | 否 | 可以指定播放链接的过期时间(秒),取值范围[3600- 14*24*3600] 。默认是 3600 | |
请求示例
Bash复制curl --location 'https://open.douyin.com/api/dyc_voc/get_video_by_vid' \
--header 'Content-Type: application/json' \
--header 'access-token: clt.xxxx' \
--data '{
"vid":"v0dbxxxxxxx"
}'
响应参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
err_no | string | 是 | 错误码 | |
err_msg | int | 是 | 错误详情 | |
log_id | string | 否 | 日志 id,用户 oncall 排查问题 | |
data | list<OpenVideoModel> | 否 | 具体的每一页的数据 | |
名称 | 类型 | 是否必填 | 描述 | 示例值 |
format | string | 是 | 视频格式 | |
main_play_url | string | 是 | 主播放地址 | |
back_up_play_url | string | 是 | 备用播放地址 | |
main_url_expire | string | 是 | 主播放地址过期时间 | |
back_url_expire | string | 是 | 备用播放地址过期时间 | |
definition | string | 是 | 视频分辨率 | |
bitrate | int | 是 | 码率 | |
codec | string | 是 | 编码类型 | |
size | double | 是 | 文件大小 | |
is_demote | boolean | 否 | 是否降级返回 当该字段为 true 则只有 main_play_url 和 main_url_expire 字段可置信 | |
is_original | boolean | 否 | 是否上传的原片 | |
响应示例
正常示例
JSON复制{
"log_id": "20230822202428CF29B88B2521D206CB62",
"data": [
{
"format": "mp4",
"main_play_url": "http://ttbf51c9ec2037ea53xxxxx",
"size": 940666,
"back_up_play_url": "http://ttbfxxxxxxx",
"bitrate": 336462,
"codec": "h264",
"definition": "360p",
"back_url_expire": "1692710700",
"main_url_expire": "1692710700",
"is_demote":false
}
],
"err_msg": "success",
"err_no": 0
}
异常示例
JSON复制{
"err_msg": "video not exist",
"err_no": 401003,
"log_id": "20231118173045BB550CD590C4897C20D2",
"data": null
}
通过 Url 批量上传视频
API 说明
此接口用于通过源文件 URL,拉取媒体文件并上传到抖音云媒资管理,支持批量操作。
提交成功后,将会生成异步执行的任务,进行排队执行。您可以通过查询上传任务状态接口查询上传状态。
使用限制
一次最多上传 20 个视频链接的 Url。
URL 必须是源文件 URL,不是包含视频文件的页面 URL 等;支持 HTTP/HTTPS。
接口说明
基本信息
基本信息 | ||||
HTTP URL | ||||
HTTP Method | POST | |||
Scope | cloud.playlet | |||
权限要求 | 默认授权 |
请求头
字段名 | 类型 | 位置 | 是否必填 | 字段说明 |
Content-Type | string | Header | 是 | 固定值:application/json |
access-token | string | Header | 是 |
请求参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
url_sets | list<UrlSet> | 是 | 源视频的 urlSet 列表,一次最多传入 20 条 | |
UrlSet。
名称 | 类型 | 是否必填 | 描述 | 示例值 |
source_url | string | 是 | 原视频的 url 链接 | |
file_name | string | 是 | 视频名称(不包含扩展名) | |
请求示例
JavaScript复制curl --location 'https://open.douyin.com/api/dyc_voc/upload_video_by_urls' \
--header 'Content-Type: application/json' \
--header 'access-token: clt.7a440b1712f8276371c49578c9f48aab0ZXW09TMOr2NhkGBj1ydkmJeT1b0' \
--data '{
"url_sets":[
{
"source_url":"https://xxxxxxxx.mp4",
"file_name":"剧集名称"
}
]
}'
响应参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
err_no | string | 是 | 错误码 | |
err_msg | int | 是 | 错误详情 | |
log_id | bool | 否 | 日志 id | |
data | UploadVideoByUrlsData | 否 | 每个视频 url 的任务列表 | |
UploadVideoByUrlsData。
JavaScript复制{
"log_id": "2023082220011391316DF97979F404F7FB",
"data": {
"url_jobs": [
{
"job_id": "eeb5739b8876468e8156c0726d6bacd5",
"source_url": "https://xxxxxxxx.com/test/xxxxxxx.mp4"
}
]
},
"err_msg": "",
"err_no": 0
}
名称 | 类型 | 是否必填 | 描述 | 示例值 |
url_jobs | list<UrlJob> | 否 | 每个视频 url 的任务列表 | |
UrlJob
名称 | 类型 | 是否必填 | 描述 | 示例值 |
source_url | string | 是 | 源视频 url | |
job_id | string | 是 | 源视频上传的任务 id | |
响应示例
正常示例
JavaScript复制{
"log_id": "2023082220011391316DF97979F404F7FB",
"data": {
"url_jobs": [
{
"job_id": "eeb5739b8876468e8156c0726d6bacd5",
"source_url": "https://xxxxxxxx.com/test/xxxxxxx.mp4"
}
]
},
"err_msg": "",
"err_no": 0
}
异常示例
JavaScript复制{
"err_msg": "input params is invalid",
"err_no": 401001,
"log_id": "2023082220015780B7FC82554E6E055343"
}
查询 URL 批量上传任务状态
API 说明
此接口用于查询 URL 批量上传任务状态。您可以通过 URL 批量拉取上传接口返回的 JobId 查询对应 URL 上传状态,上传成功将返回 Vid,以及媒资基础信息。
使用限制
一次最多查询20 个任务的任务状态。
接口说明
基本信息
基本信息 | ||||
HTTP URL | ||||
HTTP Method | POST | |||
Scope | cloud.playlet | |||
权限要求 | 默认授权 |
请求头
字段名 | 类型 | 位置 | 是否必填 | 字段说明 |
Content-Type | string | Header | 是 | 固定值:application/json |
access-token | string | Header | 是 |
请求参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
job_ids | list<string> | 是 | 上传任务的 jobid 列表,一次最多传入 20 条 | |
请求示例
JavaScript复制curl --location 'https://open.douyin.com/api/dyc_voc/get_upload_job_info' \
--header 'Content-Type: application/json' \
--header 'access-token: clt.xxxx' \
--data '{
"job_ids":["xxxxxxxxxx"]
}'
响应参数
名称 | 类型 | 是否必填 |