最近更新时间:2023.09.08 14:06:12
首次发布时间:2021.04.09 18:31:35
客户侧调用该接口获取个性化推荐的内容,目前支持的内容体裁有图文、横版短视频、竖版小视频。
每次请求,火山引擎侧默认返回的内容条数在6-15条不等,内容信息包括内容标题、封面图,作者名称、阅读数、播放量、发布时间、点赞数、分享数等,客户侧可使用这些数据,自定义实现UI效果。
请求结构 | 说明 |
---|---|
请求域名 | stream-api.feedcoopapi.com【建议】 mercury.snssdk.com【废弃】 |
请求地址 | /content/stream |
请求协议 | HTTP/HTTPS |
请求方式 | GET/POST |
参数类型 | application/x-www-form-urlencoded |
注意
参数 | 描述 | 类型 | 是否必填 | 说明 |
---|---|---|---|---|
api_version | 接口版本 | int | 是 | 固定传3 |
category | 频道ID | String | 是 | 登陆火山引擎内容定制控制台,创建应用-场景-频道后,生成的频道ID就是这里的category。创建频道步骤请参见:信息流运营操作手册 |
dt | 设备型号 | String | 否 | 如iphone5s、Galaxy。建议上传,主要用于推荐分析,提升推荐效果 |
device_brand | 设备厂商 | String | 否 | 如Apple、Samsung。建议上传,主要用于推荐分析,提升推荐效果 |
os | 操作系统 | String | 是 | 如 Android、IOS。主要用于推荐分析,提升推荐效果。注意:IOS系统如果没有正确传入此参数,返回的封面图可能为webp格式,导致图片解析失败。 |
os_version | 操作系统版本 | String | 否 | 如4.0.4。建议上传,主要用于推荐分析,提升推荐效果。火山引擎侧内容详情页会根据此参数进行适配。 |
client_version | 应用的版本号 | String | 是 | 比如1.0.1。主要用于数据排查,提升业务指标 |
allow_stick | 是否输出置顶文章 | int | 否 | 1:是,0:否,默认是0。 注意 当同时满足如下几个条件,才会返回置顶内容: |
stress_test | 是否为压测 | int | 否 | 1:是,0:否,默认为0。 |
off_personal_rec | 是否关闭个性化推荐 | int | 否 | 1:是,随机推荐内容, |
ip | 设备ip | String | 否 | |
city | 城市名称 | String | 否 | 比如:北京,编码为utf-8。 |
custom_video_definition | 指定视频分辨率 | String | 否 | 枚举值:360p、480p、540p、720p、1080p、all(全部)。 横版短视频支持:360p(默认)、480p、540p、720p、1080p 竖版小视频支持:540p(默认) 默认不传时,短视频下发360p,小视频下发540p,传all时下发视频所有的分辨率。 如果请求的分辨率对于该视频不存在,则会自动降级一档返回内容作为兜底。 特别注意: 分辨率的升档会增加cdn的播放成本,需客户侧谨慎评估,详细咨询火山引擎侧。 |
allow_force_insert | 请求强插内容(取值0代表关闭,1代表开启) | int | 否 | 频道首刷时传递为1,非首刷场景为0 |
参数 | 描述 | 类型 | 说明 |
---|---|---|---|
ret | 响应结果 | long | 参见“错误码”说明 |
msg | 本次请求是否成功 | String | success:成功 |
req_id | 本次请求标识 | String | 火山引擎侧使用该字段进行具体问题追踪和排查 |
data | 内容数据 | List | 默认随机返回6-15条内容数据 |
extra | 附加信息 | JSONObject |
状态码 | 含义 | 说明 |
---|---|---|
3 | 等待上传 | 审核中,视频暂时无法播放 |
4 | 上传成功 | 审核中,视频暂时无法播放 |
10 | 转码成功(可播放) | success,视频可正常播放 |
20 | 转码失败 | 审核中,视频暂时无法播放 |
30 | 转码进行中 | 审核中,视频暂时无法播放 |
40 | 不存在 | 审核中,视频暂时无法播放 |
1000 | 转码成功,未审核或未生产文章 | 审核中,视频暂时无法播放 |
1002 | 转码成功,视频删除 | 未通过审核,视频无法播放 |
2002 | 未授权,禁止访问 | 未通过审核,视频无法播放 |
curl --location --request POST 'https://stream-api.feedcoopapi.com/content/stream?signature=da23e4f53548ecf01abbf17bd866fb9730a4181d×tamp=1656048140&nonce=894038&partner=server_sdk_demo_default_content&access_token=AGDp7e07nCdc4vmzfSVHkmcXYTkSB6rwjDV9Aq1anaPdxLz3UM16Pi8JWJxPh6ejxsoydiP62' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'category=server_sdk_demo_default_content_feed_2_1' \ --data-urlencode 'dt=iphone5s' \ --data-urlencode 'device_brand=Apple' \ --data-urlencode 'os=IOS' \ --data-urlencode 'clientVersion=1.0.1'
{ "ret": 0, "msg": "success", "data": [ { "abstract": "xxx", "article_url": "https://open-hl.toutiao.com/...", "behot_time": 1656074049, "comment_count": 562, "comment_url": "https://open.toutiao.com/a7096032576028344868/comment/?...", "cover_image_list": [ { "url_list": [ { "url": "http://p6-open-sign.byteimg.com/tos-cn-i-0004/193c551c985840a29737e3da007fc996~tplv-tt-cs0:960:540.jpeg?..." }, { "url": "..." }, { "url": "..." } ], "height": 540, "width": 960, "uri": "tos-cn-i-0004/193c551c985840a29737e3da007fc996", "url": "http://p3-open-sign.byteimg.com/tos-cn-i-0004/193c551c985840a29737e3da007fc996~tplv-tt-cs0:960:540.jpeg?..." } ], "cover_mode": 1, "digg_count": 15740, "filter_words": [ { "id": "8:0", "is_selected": false, "name": "看过了" }, { "id": "9:1", "is_selected": false, "name": "内容太水" }, { "id": "5:2735791242", "is_selected": false, "name": "拉黑作者:xxx" }, { "id": "6:2403059", "is_selected": false, "name": "不想看:西瓜" } ], "group_id": 7096032576028344868, "group_id_str": "7096032576028344868", "has_video": true, "is_stick": false, "publish_time": 1652179511, "share_count": 9195, "share_url": "https://partner-hl.365yg.com/a7096032576028344868/?...", "title": "西瓜甜不甜,瞧一眼这里就知道,一挑一个准,老瓜农的方法真管用", "user_info": { "avatar_url": "https://p1-open.byteimg.com/img/pgc-image/9302040dea294e10825d9d7a5ba3297e~300x300.image", "description": "热爱美食,每天分享不同的美食", "follow": false, "follower_count": 1034033, "home_page": "https://open.toutiao.com/u1310219604591485/?...", "name": "明玥美食", "user_id": 1310219604591485, }, "video_duration": 491, "video_id": "V2o5y7pgy79CydXM9gaCevzYz9akVfJVCbr67owzfoJNkDBFnsMgNcBHatD3r9y8PctcNGnzdnXWTfk3sYt", "video_watch_count": 632244, "article_class": "短视频", ... }, {...}, ... ], "req_id": "202206242034090102121721571986C5B9", ... }
图文 | 视频 |
---|---|
![]() | ![]() |
当请求“本地”频道时,需要同时传入city,目前支持的城市如下
序号 | 城市名 |
---|---|
A | 安阳, 鞍山, 安庆, 安康, 阿坝, 阿拉善, 阿克苏, 阿勒泰, 阿里, 安顺, 澳门 |
B | 北京, 蚌埠, 保定, 本溪, 包头, 亳州, 滨州, 白城, 百色, 白山, 白银, 宝鸡, 保山, 巴彦淖尔, 巴中, 北海, 毕节, 博尔塔拉, 巴音郭楞 |
C | 重庆, 成都, 长春, 长沙, 承德, 常州, 滁州, 巢湖, 沧州, 常德, 昌都, 昌吉, 长治, 朝阳, 潮州, 郴州, 楚雄, 赤峰, 池州, 崇左 |
D | 大连, 东莞, 德州, 丹东, 大理, 大庆, 大同, 大兴安岭, 达州, 德宏, 德阳, 定西, 迪庆, 东营 |
E | 鄂州, 鄂尔多斯, 恩施 |
F | 福州, 阜阳, 佛山, 抚州, 防城港, 抚顺, 阜新 |
G | 广州, 贵阳, 桂林, 赣州, 广元, 甘南, 甘孜, 广安, 贵港, 果洛, 固原 |
H | 杭州, 合肥, 哈尔滨, 海口, 衡阳, 邯郸, 呼和浩特, 黄冈, 黄石, 湖州, 衡水, 呼伦贝尔, 黄山, 海北, 海东, 海南, 海西, 哈密, 汉中, 鹤壁, 河池,鹤岗, 黑河, 和田, 河源, 菏泽, 贺州, 红河, 淮安, 淮北, 怀化, 淮南, 黄南, 惠州, 葫芦岛 |
J | 吉林, 济南, 九江, 揭阳, 酒泉, 嘉兴, 荆州, 锦州, 佳木斯, 吉安, 江门, 焦作, 嘉峪关, 金昌, 晋城, 景德镇, 荆门, 金华, 济宁, 晋中,鸡西, 济源 |
K | 昆明, 开封, 喀什, 克拉玛依, 克孜勒苏 |
L | 兰州, 廊坊, 六安, 乐山, 来宾, 柳州, 聊城, 莱芜, 拉萨, 洛阳, 凉山, 连云港, 辽阳, 辽源, 丽江, 临沧, 临汾, 临夏, 临沂, 林芝, 丽水,六盘水, 陇南, 龙岩, 娄底, 漯河, 泸州, 吕梁 |
M | 绵阳, 马鞍山, 茂名, 眉山, 梅州, 牡丹江 |
N | 南京, 南昌, 南宁, 宁波, 南通, 南充, 南平, 南阳, 那曲, 内江, 怒江, 宁德 |
P | 莆田, 濮阳, 盘锦, 攀枝花, 平顶山, 平凉, 萍乡, 普洱 |
Q | 青岛, 秦皇岛, 泉州, 衢州, 曲靖, 黔东南, 黔南, 黔西南, 庆阳, 清远, 钦州, 齐齐哈尔, 七台河 |
R | 日照, 日喀则 |
S | 上海, 深圳, 沈阳, 石家庄, 三门峡, 三明, 三亚, 商洛, 商丘, 苏州, 汕头, 汕尾, 十堰, 遂宁, 上饶, 山南, 绍兴, 邵阳, 双鸭山, 朔州, 四平, 松原, 绥化, 随州, 宿迁, 宿州, 石嘴山, 韶关 |
T | 天津, 太原, 唐山, 台州, 塔城, 泰安, 铁岭, 台湾, 泰州, 天水, 铜川, 通化, 通辽, 铜陵, 铜仁, 吐鲁番 |
W | 武汉, 温州, 无锡, 乌鲁木齐, 芜湖, 潍坊, 威海, 渭南, 文山, 乌海, 乌兰察布, 武威, 吴忠, 梧州 |
X | 西安, 厦门, 湘潭, 徐州, 许昌, 信阳, 西宁, 咸阳, 宣城, 新乡, 湘西, 襄阳, 咸宁, 孝感, 锡林郭勒, 兴安, 邢台, 新余, 忻州, 西双版纳, 香港 |
Y | 扬州, 银川, 宜昌, 岳阳, 榆林, 烟台, 雅安, 延安, 延边, 盐城, 阳江, 阳泉, 宜宾, 伊春, 宜春, 伊犁, 营口, 鹰潭, 益阳, 永州, 玉林, 运城, 云浮, 玉树, 玉溪 |
Z | 珠海, 肇庆, 张家口, 中山, 淄博, 驻马店, 枣庄, 张家界, 张掖, 漳州, 湛江, 昭通, 郑州, 镇江, 中卫, 周口, 舟山, 株洲, 自贡, 资阳, 遵义 |