一、概述

长视频内容接口为全量和增量共用，采用合作方主动推送媒资信息的方式，需注意以下：

每次推送专辑数量不超过100条，请分页推送
单个专辑内子集数量不超过100条，请分页推送
子集不能单独推送，需和所属专辑一起推送

二、请求URL/Method

补充：将api_host替换成对应环境的域名

HTTP URL	https://api_host/long/v2/push/general
HTTP Method	POST

三、请求头

名称	类型	必填	描述
Authorization	string	是	示例值："c83a2e753d41494fbde7b4aa31f4fa66"
Content-Type	string	是	固定值："application/json; charset=utf-8"

四、请求体

	字段名	字段类型	最大长度限制	是否必填	说明
	partnerId	string	32	是	合作方id
	timestamp	long	-	是	当前请求时间戳，单位毫秒
	nonce	string	32	是	随机值，相邻两次请求的nonce不允许重复，如果重复认为重复提交，响应失败
	contents	数组	100	是	专辑&子集列表，元素为下面content
content元素内容	cover_id	string	32	是	专辑ID
	title	string	128	是	标题
	state	string	1	是	上下线状态 0：下线 1：上线
	alias	数组（元素是string）	128	否	别名,电影别名
	english_name	string	255	否	节目英文名
	focus	string	128	否	节目看点
	description	string	500	是	内容简介,电影简介,电视剧内容简介,栏目简介,简介
	category	int	-	是	节目分类,详细见补充说明
	main_actors	数组（元素是string）	500	否	主演
	actors	数组（元素是string）	500	是	演员
	directors	数组（元素是string）	500	是	导演
	publish_date	string	19	是	上映时间,播出日期,国内上映时间，格式：yyyy-MM-dd HH:mm:ss
	area_name	string	128	是	地区名称
	year	string	128	是	出品年份,年代,电视剧出品时间,外显年份
	is_finish	int	-	是	节目是否完结：0: 否; 1: 是
	tag	数组（元素是string）	255	是	节目标签
	pay_status	int	-	是	付费状态：0:免费,1:收费,2:单点
	language	string	128	是	语言,电视剧语言,影视语言中文、粤语、英语、日语、韩语、法语、德语、西班牙语
	copyright_authorize	json	500	否	版权授权信息
	licenses	数组（元素是string）	255	是	牌照方
	android_intent	string	500	-	APK模式跳转地址，apk播放时必填
	ios_intent	string	500	-	APK模式跳转地址，apk播放时必填
	content_type	int	-	是	0:正片，1:预告片，2:花絮，3片花，4:短片
	episode_count	int	-	是	集数,总集数,电视剧集数，综艺总期数
	episode_updated	int	-	是	更新集/期数（更新到哪一集）
	variety_episode	string	-		综艺期数，分类为综艺时必填，格式为yyyyMMdd
	h_poster	string	255	是	专辑横版海报
	v_poster	string	255	是	专辑竖版海报
	is_excl	int	-	是	是否独播：0: 否；1: 是
	cp_rate	int	-	否	节目评分,百分制
	source_cp	string	128	否	合作方上层来源CP
	update_time	string	19	是	专辑更新时间，格式 yyyy-MM-dd HH:mm:ss
	create_time	string	19	是	专辑创建时间，格式 yyyy-MM-dd HH:mm:ss
	media_ext	string	500	否	拓展json字段
	play_length	int	-	否	视频时长(秒)，电影必填，其它频道选填
	videos	数组	500	是	专辑下面的子集列表，元素为video
video元素内容	video_id	string	20	是	视频id
	cover_id	string	32	是	所属专辑ID
	title	string	128	是	标题
	state	string	1	是	上下线状态 0:下线 1:上线
	focus	string	128	否	分集看点
	description	string	500	是	内容简介,电影简介,电视剧内容简介,栏目简介,简介
	duration	int	-	是	视频时长(秒)
	urls	string	-	-	单视频播放页url（非SDK播放必填） [ { "definition": "720P", "url": "" }, { "definition": "1080P", "url": "" }, ... ]
	definitions	数组（元素是string）	255	-	清晰度列表（SDK方式必填）可选值： 480P （标清） 720P （准高清） 1080P (高清) 4K（4K超高清）
	android_intent	string	500	-	APK模式跳转地址，apk播放时必填
	ios_intent	string	500	-	APK模式跳转地址，apk播放时必填
	publish_date	string	19	是	播出时间/上映时间，格式 yyyy-MM-dd HH:mm:ss
	pay_status	int	-	是	付费状态：0:免费,1:收费,2:单点
	play_order	string	10	是	播放序号（第几集，综艺为播放日期如20211012）
	content_type	int	-	是	0:正片，1:预告片，2:花絮，3片花，4:短片
	tag	数组（元素是string）	255	是	视频标签
	h_poster	string	255	否	横版海报
	v_poster	string	255	否	竖版海报
	start_time	int	-	否	正片开始时间，单位秒，默认值0
	end_time	int	-	是	正片结束时间，单位秒，默认值0
	hdr	int	-	是	视觉增强，可选值：0:杜比视界，1:HDR，1000:未知
	sound_type	int	-	是	音效类型，可选值：0:普通，1:杜比音效，2:DTS音效，3:杜比ATMOS
	update_time	string	19	是	分集更新时间，格式 yyyy-MM-dd HH:mm:ss
	create_time	string	19	是	分集创建时间，格式 yyyy-MM-dd HH:mm:ss
	imax	int	-	是	imax支持，0:不支持，1:支持
	trial_status	int	-	是	试看状态，可选值：0:不可试看,1:试看若干时长,2:整集试看
	trial_length	int	-	否	试看时长，单位秒，默认值0 (可试看时必填)
	drm	string	64	否	加密，1:无drm，2:drm intertrust，3:drm china，有多个;号隔开
	media_ext	string	500	否	拓展字段

五、响应参数

字段名	类型	最大长度	是否必填	说明
code	String	-	是	返回码
msg	String	-	是	详见返回码说明

六、示例

请求体示例：

{ 
  "partnerId": "pi_xxx", 
  "timestamp": 1653281331000, 
  "nonce": "sfn1vjnjkmzedna", 
  "contents": [ 
    { 
      "state": 1, 
      "cover_id": "123", 
      "title": "开端", 
      "area_name": "中国", 
      "create_time": "2022-01-13 18:32:02", 
      "其他字段": "省略", 
      "videos": [ 
        { 
          "state": 1, 
          "video_id": "1231212", 
          "play_order": 1, 
          "title": "开端-第1集 ", 
          "description": "一部2022年的中国大陆都市悬疑题材电视剧", 
          "create_time": "2022-01-13 18:32:02", 
          "其他字段": "省略" 
        }, 
        { 
          "state": 1, 
          "video_id": "1231213", 
          "play_order": 2, 
          "title": "开端-第2集 ", 
          "description": "一部2022年的中国大陆都市悬疑题材电视剧", 
          "create_time": "2022-01-13 18:32:02", 
          "其他字段": "省略" 
        } 
      ] 
    } 
  ] 
}

响应体示例：

{ 
    "code": "0000", 
    "msg": "success" 
}

七、补充说明

节目分类(对应category字段)

类型值code	类型说明
0	电影
1	电视剧
2	综艺
3	动漫
4	纪录片
5	体育
6	电子竞技
7	教育
8	音乐
9	儿童
10	健康
11	军事
12	资讯
13	旅游
14	财经
15	汽车
16	娱乐
17	原创
18	生活
19	科技
20	在线教育
21	电视课堂
22	戏曲
1000	其他

上一篇:内容接入接口调用必读

下一篇:音频内容API接入规范

文档内容是否有帮助？

有帮助

无帮助