腾讯内容开放平台接口文档
服务说明
腾讯内容开放平台为媒体提供开发接入腾讯内容开放平台的解决方案。媒体可使用我们提供的接口服务,将内容接入腾讯内容开放平台。
授权流程说明
用户可以通过对应的腾讯内容开放平台应用,使用唯一的client_id和client_secret换取access_token,然后访问绑定的该 腾讯内容开放平台用户资料,进行发文等操作;
腾讯内容开放平台应用API调用所需的access_token的使用及生成方式说明:
1.为了保密client_secret,需要一个access_token获取和刷新的中控服务器。而其他业务逻辑服务器所使用的access_token均来自于该中控服务器,不应该各自去刷新,否则会造成access_token覆盖而影响业务。
2.目前access_token的有效期通过返回的expire_in来传达,目前是7200秒之内的值。中控服务器需要根据这个有效时间提前去刷新access_token。
获得腾讯内容开放平台应用授权access_token相关API
可以使用client_id和client_secret调用本接口来获取access_token。client_id和client_secret可在腾讯内容开放平台-内容同步-API中获得(需要已开通API服务)。
http请求方式: POST(请使用https协议)https://auth.om.qq.com/omoauth2/accesstoken
POST数据格式: JSON
调用示例:
lURI: POST https://auth.om.qq.com/omoauth2/accesstoken?grant_type=clientcredentials&client_id=CLIENT_ID&client_secret=CLIENT_SECRET
参数列表
参数 | 是否必须 | 参数含义描述 | 参数值 |
---|---|---|---|
grant_type | Y | 授权类型 | 腾讯内容开放平台应用授权模式(clientcredentials) |
client_id | Y | 腾讯内容开放平台应用client_id唯一标识 | |
client_secret | Y | 腾讯内容开放平台应用client_secret |
返回值 | 返回值描述 |
---|---|
access_token | 腾讯内容开放平台应用授权调用凭据 |
expires_in | 授权方接口调用凭据有效期,单位(秒) |
openid | 腾讯内容开放平台应用对应的媒体用户唯一标识 |
· 返回数据
{ "code":"0", "msg": "success", "data": { "access_token":"ACCESS_TOKEN", "expires_in":7200, "refresh_toekn":"REFRESH_TOKEN", "openid":OPENID, "scope":"SCOPE", } }
· 返回码说明
返回码 | 返回码说明 |
---|---|
-1 | 系统繁忙,此时请开发者稍候再试 |
0 | 接口请求成功 |
40000 | 不合法的请求 |
40010 | 不合法的client_id |
40013 | 不合法的grant_type |
40015 | 不合法的access_token |
40017 | 不合法的client_secret |
40018 | 不合法的client_status |
40020 | 不合法的请求范围 |
41002 | 缺失client_id参数 |
41005 | 缺失auth_code参数 |
41011 | 缺失grant_type参数 |
42001 | 需要使用GET方法请求 |
42002 | 需要使用POST方法请求 |
43001 | 过期的access_token |
43002 | 过期的refresh_token |
API接口
一、发表图文
http请求方式: POST(请使用https协议) https://api.om.qq.com/articlev2/clientpubpic?access_token=ACCESS_TOKEN
POST数据格式: JSON
调用示例:
curl -H 'Content-Type: application/json' "https://api.om.qq.com/articlev2/clientpubpic?access_token=ACCESS_TOKEN" -d '{"content": CONTENT, "title": TITLE, "cover_pic": COVER_PIC}'
参数列表
参数 | 是否必须 | 参数含义描述 | 参数值 |
---|---|---|---|
access_token | Y | 腾讯内容开放平台授权调用凭据 | |
title | Y | 文章标题 | 6-30个字,英文和字符算一个字 标题内特殊符号说明 |
content | Y | 文章内容 | 文本内容,utf-8编码 |
cover_pic | Y | 文章封面图 | 例如:http://puui.qpic.cn/tv/0/5856657_460358/0,多封面图用逗号分隔 |
cover_type | N | 文章封面类型 | 非必填参数,封面类型,1表示单图,3表示三图 |
tag | N | 文章标签 | 非必填参数,文章标签以逗号分隔,最长不能超过60个字 |
category | N | 文章分类编号 | 非必填参数,文章分类编号见下文 |
apply | N | 申请原创文章 | 非必填参数,申请原创文章填1(需要用户具有发表图文原创文章资格否则无效) |
original_platform | N | 原创首发平台 | 非必填参数,申请原创文章时为必填参数(平台编号见下文) |
original_url | N | 原创首发链接 | 非必填参数,申请原创文章时当选择平台不是腾讯内容开放平台时必填 |
original_author | N | 原创首发作者 | 非必填参数,申请原创文章时当选择平台不是腾讯内容开放平台时必填 |
ext_inf | N | 扩展字段 | 非必填参数,扩展字段均放在该字段中 |
原创首发平台original_platform取值,如下:
original_platform值 | 原创首发平台 |
---|---|
1 | 腾讯内容开放平台 |
2 | 微信公众账号 |
3 | 头条号 |
4 | 大鱼号 |
5 | 一点号 |
6 | 百家号 |
7 | 网易号 |
8 | 搜狐号 |
9 | 淘宝头条 |
10 | 其它平台 |
文章分类编号,如下:
文章分类编号 | 对应文章分类 |
---|---|
1 | 旅游 |
2 | 游戏 |
4 | 体育 |
128 | NBA |
141 | CBA |
9 | 美食 |
10 | 健康 |
13 | 财经 |
71 | 股票 |
14 | 汽车 |
15 | 房产 |
16 | 动漫 |
600 | 传媒 |
17 | 教育 |
18 | 科技 |
64 | 互联网 |
19 | 军事 |
20 | 天气 |
21 | 情感 |
28 | 招聘 |
40 | 鸡汤 |
41 | 社会 |
42 | 时政 |
306 | 新闻 |
352 | 婚庆 |
57 | 育儿 |
58 | 时尚 |
61 | 文化 |
63 | 宠物 |
65 | 数码 |
69 | 科学 |
182 | 户外运动 |
86 | 篮球 |
87 | 足球 |
136 | 中超 |
137 | 英超 |
138 | 意甲 |
95 | 历史 |
103 | 摄影 |
156 | 生活百科 |
158 | 法律 |
159 | 创意 |
160 | 农林牧副渔 |
62 | 环球 |
161 | 出国 |
163 | 减肥 |
60 | 宗教 |
187 | 佛教 |
188 | 搞笑 |
189 | GIF |
190 | 家居 |
192 | 美女 |
8 | 文学 |
99 | 艺术 |
5 | 音乐 |
82 | 电影 |
104 | 民俗 |
194 | 美图 |
199 | 星座 |
202 | 职场 |
249 | 命理 |
304 | 基督教 |
3 | 人物 |
329 | 娱乐 |
332 | 彩票 |
333 | 健身 |
334 | 跑步 |
返回数据
{
"code":"0",
"msg": "success",
"data": {
"transaction_id":TRANSACTION_ID,
"article_id":article_id //腾讯内容开放平台内容唯一id
}
}
二、发表组图文章
http请求方式: POST(请使用https协议) https://api.om.qq.com/articlev2/clientpubgrpic?access_token=ACCESS_TOKEN
POST数据格式: JSON
调用示例:
curl -H 'Content-Type: application/json' "https://api.om.qq.com/articlev2/clientpubgrpic?access_token=ACCESS_TOKEN" -d '{"content": CONTENT, "title": TITLE, "cover_pic": COVER_PIC}'
参数列表
参数 | 是否必须 | 参数含义描述 | 参数值 |
---|---|---|---|
access_token | Y | 腾讯内容开放平台授权调用凭据 | |
title | Y | 图文文章标题 | 6-30个字,英文和字符算一个字 标题内特殊符号说明 |
content | Y | [{"image":"http://inews.gtimg.com/newsapp_match/0/2230181181/0","desc":"讴歌"}] | json string,数组元素: image-图片url, desc-图片描述,其中描述5-200个字,最多不超过20张图片 |
cover_pic | Y | 图文文章封面图 | 例如:http://puui.qpic.cn/tv/0/5856657_460358/0,多封面图用逗号分隔,建议上传尺寸:3:4 |
cover_type | N | 图文文章封面类型 | 非必填参数,封面类型,1表示单图,3表示三图 |
tag | N | 图文文章标签 | 非必填参数,文章标签以逗号分隔,最长不能超过60个字 |
category | N | 图文文章分类编号 | 非必填参数,文章分类编号见下文 |
apply | N | 申请原创图文文章 | 非必填参数,申请原创文章填1(需要用户具有发表图文原创文章资格否则无效) |
original_platform | N | 原创首发平台 | 非必填参数,申请原创文章时为必填参数(平台编号见下文) |
original_url | N | 原创首发链接 | 非必填参数,申请原创文章时当选择平台不是腾讯内容开放平台时必填 |
original_author | N | 原创首发作者 | 非必填参数,申请原创文章时当选择平台不是腾讯内容开放平台时必填 |
原创首发平台original_platform取值,如下:
original_platform值 | 原创首发平台 |
---|---|
1 | 腾讯内容开放平台 |
2 | 微信公众账号 |
3 | 头条号 |
4 | 大鱼号 |
5 | 一点号 |
6 | 百家号 |
7 | 网易号 |
8 | 搜狐号 |
9 | 淘宝头条 |
10 | 其它平台 |
文章分类编号,如下:
文章分类编号 | 对应文章分类 |
---|---|
1 | 旅游 |
2 | 游戏 |
4 | 体育 |
128 | NBA |
141 | CBA |
9 | 美食 |
10 | 健康 |
13 | 财经 |
71 | 股票 |
14 | 汽车 |
15 | 房产 |
16 | 动漫 |
600 | 传媒 |
17 | 教育 |
18 | 科技 |
64 | 互联网 |
19 | 军事 |
20 | 天气 |
21 | 情感 |
28 | 招聘 |
40 | 鸡汤 |
41 | 社会 |
42 | 时政 |
306 | 新闻 |
352 | 婚庆 |
57 | 育儿 |
58 | 时尚 |
61 | 文化 |
63 | 宠物 |
65 | 数码 |
69 | 科学 |
182 | 户外运动 |
86 | 篮球 |
87 | 足球 |
136 | 中超 |
137 | 英超 |
138 | 意甲 |
95 | 历史 |
103 | 摄影 |
156 | 生活百科 |
158 | 法律 |
159 | 创意 |
160 | 农林牧副渔 |
62 | 环球 |
161 | 出国 |
163 | 减肥 |
60 | 宗教 |
187 | 佛教 |
188 | 搞笑 |
189 | GIF |
190 | 家居 |
192 | 美女 |
8 | 文学 |
99 | 艺术 |
5 | 音乐 |
82 | 电影 |
104 | 民俗 |
194 | 美图 |
199 | 星座 |
202 | 职场 |
249 | 命理 |
304 | 基督教 |
3 | 人物 |
329 | 娱乐 |
332 | 彩票 |
333 | 健身 |
334 | 跑步 |
返回数据
{
"code":"0",
"msg": "success",
"data": {
"transaction_id":TRANSACTION_ID,
"article_id":article_id //腾讯内容开放平台内容唯一id
}
}
三、发表视频
http请求方式: POST(请使用https协议) https://api.om.qq.com/articlev2/clientpubvid?access_token=ACCESS_TOKEN
POST数据格式: FORM
调用示例(使用curl命令,用FORM表单方式上传一个多媒体文件)
curl -F "media=@test.wmv" "https://api.om.qq.com/articlev2/clientpubvid?access_token=ACCESS_TOKEN&title=TITLE&tags=TAGS&cat=CAT&md5=MD5&desc=DESC"
参数列表
参数 | 是否必须 | 参数含义描述 | 参数值 | ||
---|---|---|---|---|---|
access_token | Y | 腾讯内容开放平台授权调用凭据 | |||
title | Y | 视频文章标题 | 6-30个字,英文和字符算一个字 标题内特殊符号说明 | ||
tags | Y | 视频文章标签 | 视频标签,以空格分开,最多5个,每个标签最多8个字 | ||
cat | Y | 视频分类 | 分类数字,参考附录分类 | ||
desc | Y | 视频描述 | 最长不超过200字 | ||
md5 | Y | 视频文件MD5值 | 字符串 | ||
media | Y | 视频文件 | form-data中媒体文件标识 | ||
apply | N | 申请视频原创文章 | 非必填参数,申请视频原创文章时填1(需要用户具备发表视频原创文章权益,否则无效) | ||
cover_pic | N | 视频封面 | 非必填参数,用于设置视频的封面图 (如为空会自动视频中抽帧选一张) |
返回数据
{
"code":"0",
"msg": "success",
"data": {
"transaction_id":TRANSACTION_ID,
"article_id":article_id //腾讯内容开放平台内容唯一id
}
}
注意事项
上传的视频文件有格式和大小限制,如下:
大小:300KB ~ 1GB,视频文件最大1GB
格式:
常见在线流媒体格式:mp4、flv、f4v、webm
移动设备格式:m4v、mov、3gp、3g2
RealPlayer :rm、rmvb
微软格式 :wmv、avi、asf
MPEG 视频 :mpg、mpeg、mpe、ts
DV格式 :div、dv、divx
其他格式 :vob、dat、mkv、swf、lavf、cpk、dirac、ram、qt、fli、flc、mod
主流音频格式:mp3、aac、ac3、wav、m4a、ogg
上传cat视频分类
cat值 | 视频分类 |
---|---|
100 | 篮球 |
101 | 体育趣闻 |
102 | 体育教学 |
103 | 足球 |
104 | 综合体育 |
106 | 功夫搏击 |
107 | 极限运动 |
200 | 广告 |
201 | 创意 |
202 | 自拍 |
203 | 公益短片 |
204 | 青春 |
205 | 绝活 |
300 | 军情解读 |
301 | 军事节目 |
302 | 武器装备 |
303 | 战争历史 |
400 | 原创动画 |
401 | 动漫周边 |
402 | 连载动画 |
403 | 宅文化 |
500 | 明星资讯 |
501 | 饭拍饭制 |
600 | 儿歌 |
601 | 益智 |
602 | 少儿节目 |
603 | 少儿动画 |
700 | 爆笑原创 |
701 | 段子剧 |
702 | 糗事 |
703 | 爆笑动物 |
704 | 相声小品 |
705 | 奇趣 |
706 | 熊孩子 |
707 | 爆笑恶搞 |
708 | 鬼畜 |
709 | 神回复 |
800 | 公开课 |
801 | 校园内外 |
802 | 语言学习 |
803 | 考试 |
804 | 职场教育 |
805 | 演讲 |
806 | 人生课堂 |
807 | 技能教学 |
808 | 知识百科 |
900 | 产品资讯 |
901 | 数码其他 |
902 | 评测 |
903 | 智能生活 |
1000 | 宗教 |
1001 | 读书 |
1002 | 艺术 |
1003 | 历史 |
1004 | 文化 |
1100 | 正能量 |
1101 | 奇闻趣事 |
1102 | 社会百态 |
1103 | 人物访谈 |
1104 | 法制 |
1105 | 国内时政 |
1106 | 国际时政 |
1107 | 国际社会 |
1108 | 交通 |
1200 | 旅行趣闻 |
1201 | 旅行攻略 |
1202 | 旅途风光 |
1300 | 时尚资讯 |
1301 | 时尚大片 |
1302 | 男士时尚 |
1303 | 美妆 |
1304 | 潮流奢品 |
1305 | 穿搭 |
1306 | T台秀场 |
1400 | 喂养 |
1401 | 保健护理 |
1402 | 萌宝 |
1403 | 孕产 |
1404 | 早教 |
1500 | 新车速递 |
1501 | 试驾评测 |
1502 | 玩车 |
1503 | 车模 |
1504 | 用车 |
1505 | 汽车资讯 |
1506 | 汽车其他 |
1507 | 摩托车 |
1600 | 手机游戏 |
1601 | 游戏周边 |
1602 | 达人解说 |
1603 | 游戏节目 |
1604 | 网络游戏 |
1605 | 电竞赛事 |
1606 | 单机游戏 |
1607 | 游戏展会 |
1700 | 宠物 |
1701 | 两性 |
1702 | 星座 |
1703 | 风水命理 |
1704 | 情感 |
1705 | 健康 |
1706 | 休闲 |
1707 | 生活窍门 |
1708 | 健身 |
1709 | 家居 |
1710 | 心灵 |
1711 | 彩票 |
1712 | 摄影 |
1800 | 电影资讯 |
1801 | 微电影 |
1802 | 电影周边 |
1803 | 影评 |
1804 | 电影剪辑 |
1900 | 电视剧剪辑 |
1901 | 网络剧 |
1902 | 电视剧片花 |
1903 | 剧集周边 |
2000 | 科学其他 |
2001 | 科学实验 |
2002 | 太空探索 |
2003 | 科普 |
2100 | 科技前沿 |
2101 | 互联网 |
2102 | 机械 |
2103 | 航空航天 |
2104 | 科技奇趣 |
2200 | 美食纪录片 |
2201 | 自然纪录片 |
2202 | 历史纪录片 |
2203 | 社会纪录片 |
2204 | 旅游纪录片 |
2205 | 军事纪录片 |
2206 | 人文纪录片 |
2300 | 舞蹈教学 |
2301 | 舞蹈工作室 |
2302 | 舞蹈达人 |
2303 | 明星热舞 |
2400 | 公司 |
2401 | 创业 |
2402 | 经济 |
2403 | 消费 |
2404 | 房地产 |
2405 | 投资 |
2406 | 理财 |
2407 | 财经人物 |
2408 | 产经 |
2409 | 股市 |
2410 | 金融 |
2411 | 收藏 |
2500 | 恶搞音乐 |
2501 | 演奏 |
2502 | 翻唱 |
2503 | 音乐节目 |
2504 | 演唱会 |
2505 | 影视音乐 |
2506 | 明星MV |
2507 | 达人MV |
2508 | 喊麦 |
2509 | 音乐牛人 |
2600 | 广场舞教学 |
2601 | 广场舞欣赏 |
2700 | 美味食谱 |
2701 | 烘焙 |
2702 | 吃播大胃王 |
2703 | 美食猎奇 |
2800 | 音乐真人秀 |
2801 | 喜剧节目 |
2802 | 脱口秀 |
2803 | 真人秀 |
2804 | 情感节目 |
2805 | 魔术 |
2806 | 戏曲 |
2807 | 舞台剧 |
2808 | 其他综艺 |
四、上传视频封面
· http请求方式: POST(请使用https协议) https://api.om.qq.com/video/clientvideopic?access_token=ACCESS_TOKEN
· POST数据格式: FORM
· 调用示例(使用curl命令,用FORM表单方式上传一个多媒体文件)
curl -F “media=@test.jpg” 'https://api.om.qq.com/video/clientvideopic?access_token=ACCESS_TOKEN&md5=MD5&vid=VID'
· 参数列表
参数 | 是否必须 | 参数含义描述 | 参数值 |
---|---|---|---|
access_token | Y | 腾讯内容开放平台授权调用凭据 | |
md5 | Y | 图片文件MD5值 | 字符串 |
vid | Y | 视频唯一id | 字符串,可以通过拉取事务信息获得 |
media | Y | 封面图文件 | (multipart/form-data)中媒体文件标识 |
注意事项
上传的视频文件有格式和大小限制,如下:
大小:建议尺寸3:4,文件最大20MB
格式:jpg,jpeg和png
返回数据
{
"code":"0",
"msg": "success",
"data": {
"transaction_id":TRANSACTION_ID,
"article_id":article_id //腾讯内容开放平台内容唯一id
}
}
五、 发布短剧/修改短剧
http请求方式: URI: POST(请使用https协议)https://api.om.qq.com/articlev2/clientpubvideocollect?access_token=ACCESS_TOKEN
调用示例:
curl -H 'Content-Type: application/json' "https://api.om.qq.com/articlev2/clientpubvideocollect?access_token=ACCESS_TOKEN" -d '{"title": TITLE, "cover_pic": COVER_PIC, "ext_info": EXTINFO, "content": CONTENT, "desc": DESC'
参数列表:
参数 | 是否必须 | 参数含义描述 | 参数类型 | 参数值 |
---|---|---|---|---|
access_token | Y | 腾讯内容开放平台授权调用凭据 | string | |
article_id | N | article_id为空时,为首次发布合辑 article_id有内容时,为修改合辑修改 | string | |
content | Y | 视频文章id | string | 已发布的视频文章id,按顺序代入以逗号分隔,数量限制在2-500个 例如:20230727V060MK,20230727V05SYH |
title | Y | 合辑标题 | string | |
cover_pic | Y | 合辑封面 | string | |
desc | Y | 合辑简介 | string | |
format_video_title | N | 是否联动修改短剧内视频标题:默认0否,1是 | int | 修改短剧主标题时使用,示例: 原剧名为:狂撩千亿总裁爆锤渣男, 修改剧名为:爆锤渣男,真千金她杀疯了 若使用此参数,将联动修改短剧内单集视频标题为: 爆锤渣男,真千金她杀疯了 第1集 ... 爆锤渣男,真千金她杀疯了 第XX集 |
接口返参
{
"code":"0",
"msg": "success",
"data": {
"transaction_id":TRANSACTION_ID,
"article_id":article_id //腾讯内容开放平台内容唯一id
}
}
ext_info 字段内容
参数 | 类型 | 是否必须 | 参数含义描述 | 格式示例 |
---|---|---|---|---|
sub_title | string | Y | 副标题 | 字数限制1-8个字 |
subject | string | Y | 短剧题材 | 多个用英文逗号隔开,可选值参考短剧题材 subject 取值表 |
period | string | Y | 年代 | 单选,可选值参考短剧年代 period 取值表 |
production_time | string | Y | 出品时间 | 格式2025-01-01 |
production_cost | integer | Y | 制作成本 | 整数格式,单位:元,如成本为30.52万元,需传格式:305200 |
filing_info | object | Y | 备案信息 | { // 是否重点备案 "is_important":1, // 备案号 "id":"备案号", // 备案文件地址 "file_url":"https://...", // 成本配置的文件地址 "cost_url":"成本配置文件地址", // 发行方信息 "issuer_info":[ { "issuer":"发行方名称", // 版权证明材料的文件地址 "copyright_url":"https://...", // 权利申明及侵权的文件地址 "declaration_url":"https://..." } ] } |
is_important | integer | Y | 是否有重点备案 | 1 是,0 否 |
id | string | N | 备案号 | 如果是重点备案,必填 |
file_url | string | N | 备案文件地址 | 如果是重点备案,必填 可访问的文件URL |
cost_url | string | Y | 短剧成本配置比例报告 | 可访问的文件URL |
issuer_info | object | Y | 发行方 | 参考filing_info示例 |
issuer | string | Y | 发行方名称 | |
copyright_url | string | Y | 版权证明材料的文件地址 | 可访问的文件URL |
declaration_url | string | Y | 权利申明及侵权的文件地址 | 可访问的文件URL |
cast_info | object | Y | 演员信息 | 导演、编剧、演员必须至少填一项。 { "directors":"导演", "writers":"编剧", "actor_info":[ { "actor":"演员名称", "character":"演员角色", } ] } |
directors | string | N | 导演 | 有多个“导演”时以英文逗号分割 |
writers | string | N | 编剧 | 有多个“编剧”时以英文逗号分割 |
actor_info | object | N | 演员&饰演 | 参考cast_info示例 |
actor | string | N | 演员名称 | 如果有演员信息,那么演员名称不能为空 |
character | string | N | 演员角色 | 如果有演员信息,那么演员角色不能为空 |
短剧年代 period 取值如下:
period 值 | 短剧年代 |
---|---|
92630 | 古代 |
92631 | 近代 |
92632 | 现代 |
92633 | 当代 |
短剧题材 subject 取值如下:
subject 值 | 短剧题材 |
---|---|
10001 | 男频 |
10002 | 女频 |
10003 | 古装 |
10004 | 玄幻 |
10005 | 仙侠 |
10006 | 职场 |
10007 | 爱情 |
10008 | 悬疑 |
10009 | 科幻 |
10010 | 都市 |
10011 | 乡村 |
10012 | 虐恋 |
10013 | 甜宠 |
10014 | 复仇 |
10015 | 重生 |
10016 | 神豪 |
10017 | 逆袭 |
10018 | 萌宝 |
10019 | 赘婿 |
10020 | 穿越 |
10021 | 战神 |
10022 | 霸总 |
10023 | 追妻 |
10024 | 医神 |
10025 | 家庭情感 |
10026 | 豪门恩怨 |
10027 | 其他 |
六、 删除文章
· http请求方式: POST(请使用https协议) https://api.om.qq.com/article/deleteclient?access_token=ACCESS_TOKEN
· POST数据格式: JSON
· 调用示例:
curl -H 'Content-Type: application/json' "https://api.om.qq.com/article/deleteclient?access_token=ACCESS_TOKEN" -d '{"article_id": ARTICLE_ID}'
· 参数列表
参数 | 是否必须 | 参数含义描述 | 参数值 |
---|---|---|---|
access_token | Y | 腾讯内容开放平台授权调用凭据 | |
article_id | Y | 文章id | 腾讯内容开放平台唯一内容id |
· 返回数据
{
"code":"0",
"msg": "success",
"data": {
}
}
· 返回字段说明
返回值字段 | 字段说明 |
---|---|
article_id | 腾讯内容开放平台内容唯一id |
article_info | 文章信息字段,当事务类型为文章时候有此内容/td> |
article_abstract | 文章摘要 |
article_type | 文章类型,取值:普通文章,图文文章,视频文章,直播文章,RTMP直播文章 |
article_url | 文章快报链接 |
article_imgurl | 文章封面图 |
article_title | 文章标题 |
article_pub_flag | 文章发布状态,取值:未发布,发布成功,审核中 |
article_pub_time | 文章发布时间 |
article_video_info | 视频文章信息字段,有此 |
desc | 视频描述 |
title | 视频标题 |
type | 类型,视频 |
vid | 视频唯一id |
七、 获取文章信息
· http请求方式: GET(请使用https协议) https://api.om.qq.com/article/deleteclient?access_token=ACCESS_TOKEN
· 调用示例:
curl 'https://api.om.qq.com/article/infoclient?access_token=ACCESS_TOKEN&article_id=ARTICLE_ID'
· 参数列表
参数 | 是否必须 | 参数含义描述 | 参数值 |
---|---|---|---|
access_token | Y | 腾讯内容开放平台授权调用凭据 | |
article_id | Y | 文章id | 腾讯内容开放平台唯一内容id |
· 返回数据
{
"code":"0",
"msg": "success",
"data": {
"article_info": {
"article_abstract": "海南琼海加详文艺队广场舞 《故乡是北京》 表演",
"article_imgurl": "http://inews.gtimg.com/newsapp_ls/0/1179086390_196130/0",
"article_pub_flag": "发布成功",
"article_pub_time": "2017-03-04 13:40:01",
"article_title": "海南琼海加详文艺队广场舞 《故乡是北京》 表演",
"article_type": "视频文章",
"article_id": "20170314A06ARB",
"article_url": "http://kuaibao.qq.com/s/20170314A06ARB00",
"article_video_info": {
"desc": "DESC",
"title": "海南琼海加详文艺队广场舞 《故乡是北京》 表演",
"type": "video",
"vid": "p0380p4aku7"
}
}
}
}
· 返回字段说明
返回值字段 | 字段说明 |
---|---|
article_id | 腾讯内容开放平台内容唯一id |
article_info | 文章信息字段,当事务类型为文章时候有此内容/td> |
article_abstract | 文章摘要 |
article_type | 文章类型,取值:普通文章,图文文章,视频文章,直播文章,RTMP直播文章 |
article_url | 文章快报链接 |
article_imgurl | 文章封面图 |
article_title | 文章标题 |
article_pub_flag | 文章发布状态,取值:未发布,发布成功,审核中 |
article_del_flag | 文章删除状态,取值:未删除,已删除 |
article_pub_time | 文章发布时间 |
article_video_info | 视频文章信息字段,有此 |
desc | 视频描述 |
title | 视频标题 |
type | 类型,视频 |
vid | 视频唯一id |
八、获取媒体信息
· http请求方式: GET(请使用https协议) https://api.om.qq.com/media/basicinfoclient?access_token=ACCESS_TOKEN
· 调用示例:
curl 'https://api.om.qq.com/media/basicinfoclient?access_token=ACCESS_TOKEN'
· 参数列表
参数 | 是否必须 | 参数含义描述 | 参数值 |
---|---|---|---|
access_token | Y | 腾讯内容开放平台授权调用凭据 |
· 返回数据
{
"code":"0",
"msg": "success",
"data": {
"header": "http://inews.gtimg.com/newsapp_ls/0/183849551_100100/0",
"nick": "测试"
}
}
· 返回字段说明
返回值字段 | 字段说明 |
---|---|
nick | 腾讯内容开放平台头像 |
header | 腾讯内容开放平台名称 |
九、 获取事务信息
· http请求方式: GET(请使用https协议) https://api.om.qq.com/transaction/infoclient?access_token=ACCESS_TOKEN
· 调用示例:
curl 'https://api.om.qq.com/transaction/infoclient?access_token=ACCESS_TOKEN&transaction_id=TRANSACTION_ID'
· 参数列表
参数 | 是否必须 | 参数含义描述 | 参数值 |
---|---|---|---|
access_token | Y | 腾讯内容开放平台授权调用凭据 | |
transaction_id | Y | 事务id | 发表文章返回的唯一事务id |
· 返回数据
{
"code":"0",
"msg": "success",
"data": {
"article_info": {
"article_abstract": "海南琼海加详文艺队广场舞 《故乡是北京》 表演",
"article_imgurl": "http://inews.gtimg.com/newsapp_ls/0/1179086390_196130/0",
"article_pub_flag": "发布成功",
"article_pub_time": "2017-03-04 13:40:01",
"article_title": "海南琼海加详文艺队广场舞 《故乡是北京》 表演",
"article_type": "视频文章",
"article_url": "http://kuaibao.qq.com/s/20170314A06ARB00",
"article_video_info": {
"desc": "DESC",
"title": "海南琼海加详文艺队广场舞 《故乡是北京》 表演",
"type": "video",
"vid": "p0380p4aku7"
}
},
"transaction_ctime": "2017-03-04 13:40:00",
"transaction_id": "8130591057953547123",
"transaction_status": "成功",
"transaction_type": "文章"
}
}
· 返回字段说明
返回值字段 | 字段说明 |
---|---|
transaction_id | 唯一事务id |
transaction_status | 事务处理状态,取值:成功,失败,处理中 |
transaction_type | 事务类型,取值:文章 |
transaction_ctime | 事务创建时间 |
article_info | 文章信息字段,当事务类型为文章时候有此内容/td> |
article_abstract | 文章摘要 |
article_type | 文章类型,取值:普通文章,图文文章,视频文章,直播文章,RTMP直播文章 |
article_url | 文章快报链接 |
article_imgurl | 文章封面图 |
article_title | 文章标题 |
article_pub_flag | 文章发布状态,取值:未发布,发布成功,审核中 |
article_del_flag | 文章删除状态,取值:未删除、已删除 |
article_pub_time | 文章发布时间 |
article_video_info | 视频文章信息字段,有此 |
desc | 视频描述 |
title | 视频标题 |
type | 类型,视频 |
vid | 视频唯一id |
十、 获取媒体信息
· http请求方式: GET(请使用https协议) https://api.om.qq.com/media/basicinfoclient?access_token=ACCESS_TOKEN
· 调用示例:
curl 'https://api.om.qq.com/media/basicinfoclient?access_token=ACCESS_TOKEN'
· 参数列表
参数 | 是否必须 | 参数含义描述 | 参数值 |
---|---|---|---|
access_token | Y | 腾讯内容开放平台授权调用凭据 |
· 返回数据
{
"code":"0",
"msg": "success",
"data": {
"header": "http://inews.gtimg.com/newsapp_ls/0/183849551_100100/0",
"nick": "测试"
}
}
· 返回字段说明
返回值字段 | 字段说明 |
---|---|
nick | 腾讯内容开放平台头像 |
header | 腾讯内容开放平台名称 |
十一、 获取授权用户文章列表
· http请求方式: GET(请使用https协议) https://api.om.qq.com/article/clientlist?access_token=ACCESS_TOKEN
· 调用示例:
curl 'https://api.om.qq.com/article/clientlist?access_token=ACCESS_TOKEN&page=PAGE&limit=LIMIT'
· 参数列表
参数 | 是否必须 | 参数含义描述 | 参数值 |
---|---|---|---|
access_token | Y | 第三方平台授权调用凭据 | |
page | Y | 文章列表第几页 | 数字,不能超过最大文章数/limit |
limit | Y | 每页文章数 | 数字,1-10直接的数字 |
· 返回数据
{
"code":"0",
"msg": "success",
"data": {
"articles": [
{
"article_abstract": "海南琼海加详文艺队广场舞 《故乡是北京》 表演",
"article_imgurl": "http://inews.gtimg.com/newsapp_ls/0/1179086390_196130/0",
"article_pub_flag": "发布成功",
"article_pub_time": "2017-03-04 13:40:01",
"article_title": "海南琼海加详文艺队广场舞 《故乡是北京》 表演",
"article_type": "视频文章",
"article_url": "http://kuaibao.qq.com/s/20170314A06ARB00",
"article_video_info": {
"desc": "DESC",
"title": "海南琼海加详文艺队广场舞 《故乡是北京》 表演",
"type": "video",
"vid": "p0380p4aku7"
}
},
{
"article_abstract": "视频发布开放平台测试"
"article_imgurl": "",
"article_pub_flag": "发布成功",
"article_pub_time": "2017-03-04 18:40:01",
"article_title": "视频发布开放平台测试",
"article_type": "视频文章",
"article_url": "http://kuaibao.qq.com/s/20170314A06ARB00",
"article_video_info": {
"desc": "DESC",
"title": "视频发布开放平台测试",
"type": "video",
"vid": "p0380p4aku7"
}
},
],
"limit": "2",
"page": "1",
"total": "28"
}
}
· 返回字段说明
返回值字段 | 字段说明 |
transaction_id | 唯一事务id |
page | 文章列表第几页 |
limit | 每页文章数 |
total | 用户文章总数 |
article_info | 文章信息字段,当事务类型为文章时候有此内容/td> |
article_abstract | 文章摘要 |
article_type | 文章类型,取值:普通文章,图文文章,视频文章,直播文章,RTMP直播文章 |
article_url | 文章快报链接 |
article_imgurl | 文章封面图 |
article_title | 文章标题 |
article_pub_flag | 文章发布状态,取值:未发布,发布成功,审核中 |
article_pub_time | 文章发布时间 |
article_video_info | 视频文章信息字段,有此 |
desc | 视频描述 |
title | 视频标题 |
type | 类型,视频 |
vid | 视频唯一id |
腾讯内容开放平台应用支持视频分片上传
视频分片上传发文主要包含三个步骤
1.申请视频上传,开放平台返回上传的唯一事务transaction_id
2.分片视频上传,根据transaction_id,将需要的视频文件分片上传到开放平台,后台会以第一次上传的分片为依据给出后续需要的数据库起始和结束地址,单个分片最大不超过(100MB)
3.上传完成后,使用视频vid发布视频文章
十二、 申请视频上传接口
· http请求方式: POST(请使用https协议) https://api.om.qq.com/video/clientuploadready?access_token=ACCESS_TOKEN
· POST数据格式: JSON
· 调用示例:
curl -H 'Content-Type: application/json' "https://api.om.qq.com/article/deleteclient?access_token=ACCESS_TOKEN" -d '{"size": SIZE, "sha": SHA, "md5": MD5}'
· 参数列表
参数 | 是否必须 | 参数含义描述 | 参数值 |
---|---|---|---|
access_token | Y | 腾讯内容开放平台授权调用凭据 | |
size | Y | 分片视频文件大小(字节为单位) | 不能超过最大4G的字节数 |
md5 | Y | 视频文件MD5值 | 字符串 |
sha | Y | 视频文件SHA-1值 | 字符串 |
· 返回数据
返回用于视频分片上传的唯一事务id
{
"code":"0",
"msg": "success",
"data": {
"transaction_id":TRANSACTION_ID
}
}
十三、 视频文件分片上传接口
· http请求方式: POST(请使用https协议) https://api.om.qq.com/video/clientuploadtrunk?access_token=ACCESS_TOKEN
· POST数据格式: FORM
· 调用示例:
curl -F "mediatrunk=@test.wmv" "https://api.om.qq.com/video/clientuploadtrunk?access_token=ACCESS_TOKEN&transaction_id=TRANSACTION_ID"
· 参数列表
参数 | 是否必须 | 参数含义描述 | 参数值 |
---|---|---|---|
access_token | Y | 腾讯内容开放平台授权调用凭据 | |
transaction_id | Y | 第一步申请上传是返回的唯一视频上传事务id | |
mediatrunk | Y | 视频mediatrunk文件 | (multipart/form-data)中媒体文件标识 |
start_offset | Y | 当次上传时候的分片起始位置相对于整体文件的位置,(从0开始计数) |
· 返回数据
{
"code":"0",
"msg": "success",
"data": {
"end_offset":366141305,
"start_offset":314572800,
"transaction_id":TRANSACTION_ID
}
}
· 返回字段说明
返回值字段 | 字段说明 |
transaction_id | 该视频的唯一事务id |
start_offset | 服务器期望的下一个分片的起始位置 |
end_offset | 服务器期望的下一个分片的结束位置 |
· 注意事项
关于分片的其实和结束位置,特举例说明:
例如,视频第一次上传的时候start_offset设置为0,此处需要上传的视频文件大小为366141306,
curl
-X POST
"https://api.om.qq.com/video/clientuploadtrunk"
-F "access_token=XXXXXXX"
-F "transaction_id=TRANSACTION_ID"
-F "start_offset=0"
-F "mediatrunk=@test1.wmv"
后台会以第一次上传的视频分片大小默认为该视频上传分片大小,后续都需要遵守该分片大小,除去最后一块分片不满足大小例外,例如实例处上传了100MB,即[0,104857599]此时后台会返回:
{
"code":"0",
"msg": "success",
"data": {
"end_offset":209715199,
"start_offset":104857600,
"transaction_id":TRANSACTION_ID
}
}
此处希望用户下一次分片上传文件区间为[104857600, 209715199],此时需要上传请求为
curl
-X POST
"https://api.om.qq.com/video/clientuploadtrunk"
-F "access_token=XXXXXXX"
-F "transaction_id=TRANSACTION_ID"
-F "start_offset=104857600"
-F "mediatrunk=@test1.wmv"
依次类推,用户一共需要分片四次,最后一次服务器上传时会返回:
{
"code":"0",
"msg": "success",
"data": {
"end_offset":366141306,
"start_offset":366141306,
"transaction_id":TRANSACTION_ID
}
}
如果返回的起始和结束地址是一样的,并且等于文件大小,表示文件已经上传完成,此时可以调用第三布的视频id发表视频文章的逻辑发文
上传的视频文件有格式和大小限制,如下:
分片:单次分片最大500MB,视频文件最大4G
格式:
常见在线流媒体格式:mp4、flv、f4v、webm
移动设备格式:m4v、mov、3gp、3g2
RealPlayer :rm、rmvb
微软格式 :wmv、avi、asf
MPEG 视频 :mpg、mpeg、mpe、ts
DV格式 :div、dv、divx
其他格式 :vob、dat、mkv、swf、lavf、cpk、dirac、ram、qt、fli、flc、mod
主流音频格式:mp3、aac、ac3、wav、m4a、ogg
十四、 根据vid发布视频文章
分片上传完成后,可以根据事务id(transaction_id)拉取信息,如果成功会有返回视频vid
· http请求方式: POST(请使用https协议) https://api.om.qq.com/articlev2/clientpubvideo?access_token=ACCESS_TOKEN
· POST数据格式: JSON
· 调用示例:
curl -H 'Content-Type: application/json' "https://api.om.qq.com/articlev2/clientpubvideo?access_token=ACCESS_TOKEN" -d '{"title": TITLE, "tags": TAGS, "vid": VID, "cat": CAT, "desc": DESC}'
· 参数列表
参数 | 是否必须 | 参数含义描述 | 参数值 |
---|---|---|---|
access_token | Y | 腾讯内容开放平台授权调用凭据 | |
title | Y | 视频文章标题 | 最长不超过30个字,最短不少于6个字 |
tags | Y | 视频文章标签 | 视频标签,以空格分开,最多5个,每个标签最多8个字 |
cat | Y | 视频分类 | 分类数字,参考附录分类 |
vid | Y | 视频文件唯一标示id | 字符串,可以通过上传成功的事务id查询获得 |
apply | N | 申请原创文章 | 非必填参数,申请原创文章填1(需要用户具有发表视频原创文章资格否则无效) |
desc | Y | 视频描述 | 最长不超过200字 |
· 返回数据
{
"code":"0",
"msg": "success",
"data": {
"transaction_id":TRANSACTION_ID,
"article_id":article_id //腾讯内容开放平台内容唯一id
}
}
数据统计
十五、 获取媒体最新统计总数据
· http请求方式: GET(请使用https协议) https://api.om.qq.com/media/statsclient?access_token=ACCESS_TOKEN
· 调用示例:
curl 'https://api.om.qq.com/media/statsclient?access_token=ACCESS_TOKEN'
· 参数列表
参数 | 是否必须 | 参数含义描述 | 参数值 |
---|---|---|---|
access_token | Y | 腾讯内容开放平台授权调用凭据 |
· 返回数据
{
"code": 0,
"data": {
"read": 1, //阅读量
"play_total": 0 //视频总播放量
},
"msg": "SUCCESS"
}
十六、按日期获取媒体统计数据
· http请求方式: GET(请使用https协议) https://api.om.qq.com/media/statsdailyclient?access_token=ACCESS_TOKEN
· 调用示例:
curl 'https://api.om.qq.com/media/statsdailyclient?access_token=ACCESS_TOKEN&begin_date=BEGIN_DATE&end_date=END_DATE'
· 参数列表
参数 | 是否必须 | 参数含义描述 | 参数值 |
---|---|---|---|
access_token | Y | 腾讯内容开放平台授权调用凭据 | |
BEGIN_DATE | N | 统计数据开始日期,不传默认返回昨日,最早返回30天前数据 | 格式为YYYY-MM-DD,例如:2017-12-14 |
END_DATE | N | 统计数据结束日期,不传默认返回昨日 | 格式为YYYY-MM-DD,例如:2017-12-16 |
· 返回数据
{
"code": 0,
"data": [
{
"statistic_date":"2017-12-06", //统计日期
"read": 1, //阅读量
"play_total": 0 //视频总播放量
},
{
"statistic_date":"2017-12-15",
"read":0,
"play_total":0
},
{
"statistic_date":"2017-12-14",
"read":0,
"play_total":0
}
],
"msg": "SUCCESS"
}
十七、 获取文章最新总数据
· http请求方式: GET(请使用https协议) https://api.om.qq.com/article/statsclient?access_token=ACCESS_TOKEN
· 调用示例:
curl 'https://api.om.qq.com/article/statsclient?access_token=ACCESS_TOKEN&article_id=ARTICLE_ID'
· 参数列表
参数 | 是否必须 | 参数含义描述 | 参数值 |
---|---|---|---|
access_token | Y | 腾讯内容开放平台授权调用凭据 | |
article_id | Y | 文章id | 例如:20171205V0WEET |
· 返回数据
{
"code": 0,
"data": {
"read": 0, //阅读量
"play_total": 0, //播放次数,如果视频文章会有数值
},
"msg": "SUCCESS"
}
十八、 获取文章按日期统计数据
· http请求方式: GET(请使用https协议) https://api.om.qq.com/article/statsdailyclient?access_token=ACCESS_TOKEN
· 调用示例:
curl 'https://api.om.qq.com/article/statsdailyclient?access_token=ACCESS_TOKEN&article_id=ARTICLE_ID&begin_date=BEGIN_DATE&end_date=END_DATE'
· 参数列表
参数 | 是否必须 | 参数含义描述 | 参数值 |
---|---|---|---|
access_token | Y | 腾讯内容开放平台授权调用凭据 | |
article_id | Y | 文章id | 例如:20171205V0WEET |
BEGIN_DATE | N | 统计数据开始日期,不传默认返回昨日,最早返回30天前数据 | 格式为YYYY-MM-DD,例如:2017-12-14 |
END_DATE | N | 统计数据结束日期,不传默认返回昨日 | 格式为YYYY-MM-DD,例如:2017-12-16 |
· 返回数据
{
"code": 0,
"data": [
{
"statistic_date": "2017-12-16",
"read": 0, //阅读量
"play_total": 0 //播放次数,如果视频文章会有数值
},
{
"statistic_date": "2017-12-15",
"read": 0,
"play_total": 0
},
{
"statistic_date": "2017-12-14",
"read": 0,
"play_total": 0
}
],
"msg": "SUCCESS"
}
接口访问频次
腾讯内容开放平台接口限制每段时间只能请求一定的次数。限制的单位时间是每天;限制的维度有但授权腾讯内容开放平台用户;部分特殊接口有单独的请求次数限制。 例如: 单腾讯内容开放平台授权用户RTMP直播发文每天只能请求5次。
当调用接口不能满足开发需求,欢迎申请合作伙伴洽谈。在保证用户隐私及信息安全的前提下,本着合作、合法、互利的原则,进行深度合作。
接口返回码说明
返回码 | 返回码说明 |
---|---|
-1 | 系统繁忙,此时请开发者稍候再试 |
0 | 接口请求成功 |
40000 | 不合法的请求 |
40002 | 参数错误(具体原因过长或者缺失参看msg) |
40015 | 不合法的access_token |
40019 | 不合法的openid |
40021 | 不合法的文件大小 |
40022 | 不合法的文件 |
40023 | 文件上传失败 |
40024 | 不合法的视频vid |
40025 | 不支持的分片大小 |
40026 | 不合法的文件格式 |
40027 | 不合法的事务id |
40028 | 不合法的分片开始偏移start_set |
40029 | 视频分片上传没有完成 |
41009 | 缺失access_token参数 |
41011 | 缺失openid参数 |
41012 | 媒体没有绑定qq号 |
42001 | 需要使用GET方法请求 |
42002 | 需要使用POST方法请求 |
46001 | 接口调用频率超过限制 |
46002 | 无接口调用权限 |
15301 | 视频已下架,不允许修改 |
15302 | 视频审核未通过,不允许修改 |
15303 | 没有修改视频的权限 |
15304 | 视频描述包含敏感内容 |
15305 | 视频审核中,不允许修改 |
15306 | 视频上传请求包头错误 |
15307 | 获取视频vid错误 |
15308 | 视频md5不正确 |
15309 | 视频上传到服务器发送错误 |
15310 | 视频切片文件大小非法 |
15311 | 视频在服务器已经存在 |
15312 | 分片start_offset不正确 |
15313 | 视频封面图分辨率太小 |
15314 | 视频封面图文件大小不合法 |
15315 | 视频封面图md5不正确 |
15316 | 视频服务不可用,请稍候再试 |
16001 | 没有访问改api的权限 |
16002 | 没有发文权限 |
16003 | 没有申请原创的权限 |