You need to enable JavaScript to run this app.
导航
ContentStreamV2 - 获取个性化内容
最近更新时间:2024.05.28 18:13:34首次发布时间:2021.10.18 11:12:18

客户侧调用该接口获取个性化推荐的内容,目前支持的内容体裁有图文、横版短视频、竖版小视频。
每次请求,火山引擎侧默认返回的内容条数在6-15条不等,内容信息包括内容标题、封面图,作者名称、阅读数、播放量、发布时间、点赞数、分享数等,客户侧可使用这些数据,自定义实现UI效果。

注意事项

  • 使用限制
    • 个性化推荐接口耗时正常情况不超过1s,为容忍网络抖动或突发流量,超时时间建议设置为3s。
    • 尽量不要预加载,否则会造成内容浪费,影响推荐效果。如果您为了提升客户端体验流畅度进行了预加载,建议您将内容放到首页进行展现,可以更好的保障推荐效果。
    • 同一个用户需要对应唯一的用户标识,也就是在调用wap注册接口时,该用户的Uuid需要保持不变。否则将会被火山引擎侧推荐系统识别为新用户,进而影响推荐效果。涉及更改用户标识,请提前与火山引擎侧沟通,以免造成指标骤降。

请求说明

  • 请求方式:GET/POST(Content-Type: application/x-www-form-urlencoded)
  • 请求地址:https://mercury.volcengineapi.com/?Action=ContentStreamV2&Version=2021-01-01
  • 请求头:ServiceName:content

调试

请求参数

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

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

ContentStreamV2

要执行的操作,取值:ContentStreamV2。

Version
String

2021-01-01

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

ApiVersion
Integer

4

接口版本,固定传4。

Partner
String

demo_default_content

渠道号。

AccessToken
String

AT6zTZuXzffKpQamer***v8mp94LR2ARdNJBp2BT86GrLpa3brqLmscGCUipuJNh2piKTT12

用户身份标识,需要通过用户注册接口获取。

Timestamp
Long

1701426600

10位时间戳,单位:秒。
为保证安全,Timestamp与当前时间戳相关绝对值不能超过3600 秒。

Category
String

demo_default_content_feed_1_1

频道ID。
登陆火山引擎内容定制控制台,创建应用-场景-频道后,生成的频道ID就是这里的category。
创建频道步骤请参见:信息流运营操作手册

Os
String

Android

操作系统,如 Android、IOS。主要用于推荐分析,提升推荐效果。

注意

IOS系统如果没有正确传入此参数,返回的封面图可能为webp格式,导致图片解析失败。

ClientVersion
String

1.0.1

应用的版本号,比如1.0.1。主要用于数据排查,提升业务指标。

Dt
String

iphone15

设备型号,如iphone15、Galaxy。主要用于推荐分析,提升推荐效果。

DeviceBrand
String

Apple

设备厂商,如Apple、Samsung。主要用于推荐分析,提升推荐效果。

OsVersion
String

4.0.4

操作系统版本,如4.0.4。主要用于推荐分析,提升推荐效果。火山引擎侧内容详情页会根据此参数进行适配。

StressTest
Integer

1

是否为压测。

  • 1:是,0:否,默认为0。
  • 当您需要进行压力测试时,必须填入此参数,否则会因命中火山引擎侧的限流机制,而被拦截。
OffPersonalRec
Integer

1

是否关闭个性化推荐。

  • 1:是,随机推荐内容;
  • 0:否,个性化推荐内容;
  • 默认为0。
Ip
String

设备ip。客户侧服务端调用此接口,传递的是客户侧客户端的ip地址。

City
String

北京

城市名称,比如:北京,编码为utf-8。
当请求本地频道时,必须填入此参数,否则无法返回本地内容。目前本地频道支持的城市见下文说明。

序号城市名
A安阳, 鞍山, 安庆, 安康, 阿坝, 阿拉善, 阿克苏, 阿勒泰, 阿里, 安顺, 澳门
B北京, 蚌埠, 保定, 本溪, 包头, 亳州, 滨州, 白城, 百色, 白山, 白银, 宝鸡, 保山, 巴彦淖尔, 巴中, 北海, 毕节, 博尔塔拉, 巴音郭楞
C重庆, 成都, 长春, 长沙, 承德, 常州, 滁州, 巢湖, 沧州, 常德, 昌都, 昌吉, 长治, 朝阳, 潮州, 郴州, 楚雄, 赤峰, 池州, 崇左
D大连, 东莞, 德州, 丹东, 大理, 大庆, 大同, 大兴安岭, 达州, 德宏, 德阳, 定西, 迪庆, 东营
E鄂州, 鄂尔多斯, 恩施
F福州, 阜阳, 佛山, 抚州, 防城港, 抚顺, 阜新
G广州, 贵阳, 桂林, 赣州, 广元, 甘南, 甘孜, 广安, 贵港, 果洛, 固原
H杭州, 合肥, 哈尔滨, 海口, 衡阳, 邯郸, 呼和浩特, 黄冈, 黄石, 湖州, 衡水, 呼伦贝尔, 黄山, 海北, 海东, 海南, 海西, 哈密, 汉中, 鹤壁, 河池,鹤岗, 黑河, 和田, 河源, 菏泽, 贺州, 红河, 淮安, 淮北, 怀化, 淮南, 黄南, 惠州, 葫芦岛
J吉林, 济南, 九江, 揭阳, 酒泉, 嘉兴, 荆州, 锦州, 佳木斯, 吉安, 江门, 焦作, 嘉峪关, 金昌, 晋城, 景德镇, 荆门, 金华, 济宁, 晋中,鸡西, 济源
K昆明, 开封, 喀什, 克拉玛依, 克孜勒苏
L兰州, 廊坊, 六安, 乐山, 来宾, 柳州, 聊城, 莱芜, 拉萨, 洛阳, 凉山, 连云港, 辽阳, 辽源, 丽江, 临沧, 临汾, 临夏, 临沂, 林芝, 丽水,六盘水, 陇南, 龙岩, 娄底, 漯河, 泸州, 吕梁
M绵阳, 马鞍山, 茂名, 眉山, 梅州, 牡丹江
N南京, 南昌, 南宁, 宁波, 南通, 南充, 南平, 南阳, 那曲, 内江, 怒江, 宁德
P莆田, 濮阳, 盘锦, 攀枝花, 平顶山, 平凉, 萍乡, 普洱
Q青岛, 秦皇岛, 泉州, 衢州, 曲靖, 黔东南, 黔南, 黔西南, 庆阳, 清远, 钦州, 齐齐哈尔, 七台河
R日照, 日喀则
S上海, 深圳, 沈阳, 石家庄, 三门峡, 三明, 三亚, 商洛, 商丘, 苏州, 汕头, 汕尾, 十堰, 遂宁, 上饶, 山南, 绍兴, 邵阳, 双鸭山, 朔州, 四平, 松原, 绥化, 随州, 宿迁, 宿州, 石嘴山, 韶关
T天津, 太原, 唐山, 台州, 塔城, 泰安, 铁岭, 台湾, 泰州, 天水, 铜川, 通化, 通辽, 铜陵, 铜仁, 吐鲁番
W武汉, 温州, 无锡, 乌鲁木齐, 芜湖, 潍坊, 威海, 渭南, 文山, 乌海, 乌兰察布, 武威, 吴忠, 梧州
X西安, 厦门, 湘潭, 徐州, 许昌, 信阳, 西宁, 咸阳, 宣城, 新乡, 湘西, 襄阳, 咸宁, 孝感, 锡林郭勒, 兴安, 邢台, 新余, 忻州, 西双版纳, 香港
Y扬州, 银川, 宜昌, 岳阳, 榆林, 烟台, 雅安, 延安, 延边, 盐城, 阳江, 阳泉, 宜宾, 伊春, 宜春, 伊犁, 营口, 鹰潭, 益阳, 永州, 玉林, 运城, 云浮, 玉树, 玉溪
Z珠海, 肇庆, 张家口, 中山, 淄博, 驻马店, 枣庄, 张家界, 张掖, 漳州, 湛江, 昭通, 郑州, 镇江, 中卫, 周口, 舟山, 株洲, 自贡, 资阳, 遵义
AllowForceInsert
Integer

1

是否强插。

  • 1:开启强插;
  • 0:关闭强插。
  • 默认为0。
    建议:频道首刷时传递为1,非首刷场景为0。
CustomVideoDefinition
String

540p

指定视频分辨率。
枚举值:360p、480p、540p、720p、1080p、all(全部)。

  • 横版短视频支持:360p(默认)、480p、540p、720p、1080p;
  • 竖版小视频支持:540p(默认);
  • 默认不传时,短视频下发360p,小视频下发540p,传all时下发视频所有的分辨率。
  • 如果请求的分辨率对于该视频不存在,则会自动降级一档返回内容作为兜底。

注意

分辨率的升档会增加cdn的播放成本,需客户侧谨慎评估,详细咨询火山引擎侧。

AllowStick
Integer

1

是否输出置顶文章。

  • 1:是,0:否,默认是0。
  • 您需要结合自身场景控制该参数的传递,比如C端非首刷或者下拉刷新不需要置顶时,控制不传此参数即可。

说明

当同时满足如下几个条件,才会返回置顶内容:

  • 在火山引擎内容定制控制台添加并发布了置顶内容;
  • AllowStick值为1;
  • 传入的Category和火山引擎内容定制控制台的频道ID正确匹配。

返回参数

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

参数
类型
示例值
描述
Result
Array of Article

内容列表。默认随机返回6-15条内容数据。

请求示例

GET /?Action=ContentStreamV2&Version=2021-01-01&ApiVersion=4&Partner=demo_default_content&AccessToken=AT6zTZuXzffKpQamer***v8mp94LR2ARdNJBp2BT86GrLpa3brqLmscGCUipuJNh2piKTT12&Timestamp=1701426600&Category=demo_default_content_feed_1_1&Os=NtjujpKNq&ClientVersion=1.0.1 HTTP/1.1
Host: https://mercury.volcengineapi.com/?Action=ContentStreamV2&Version=2021-01-01
X-Date: 20240521T093019Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240521/cn-north-1/content/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f


返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240521173035136141087197E3196B",
    "Action": "ContentStreamV2",
    "Version": "2021-01-01",
    "Service": "content",
    "Region": "cn-north-1"
  },
  "Result": [
    {
      "GroupId": "7304704552752808499",
      "Title": "标题",
      "ArticleUrl": "https://open.toutiao.com/a7304704552752808499/?a_t=AT6zTZuXzffKpQamerBxxx8mp94LR2ARdNJBp2BT86GrLpa3brqLmscGCUipuJNh2piKTT12&biz_log=BEdLU3JjyWmswjVzaF8hvsxLgnjbEP6zLUsiJHfs6w5z6Wk6ir6UZxxxN2wV9jhZwh9Qu7dWyP2UDG7JhkwBKoMRgPcHwKEhcUe6NHvktJMbjf52v7V9jPg1x6uwW55zLNbARdKGZNMDkKVkKFq9MjD8WbJZLh4KD7Px74WTCMVag8&category=xxx_default_content_feed_2_1&device_brand=&dt=&form_scen=FROM_CONTENT&group_id=7304704552752808499&item_id=7304704552752808499&label=xxx_default_content_feed_1_59&req_id=20240521xxx349B9F94600BD12654C6EB4&utm_campaign=open&utm_medium=webview&utm_source=xxx_default_content",
      "ArticleType": "短视频",
      "PublishTime": 1700759062,
      "Abstract": "-",
      "ShareUrl": "https://open.toutiao.com/a7304704552752808499/?a_t=AT6zTZuXzffKpQamerBKVv8mxxxLR2ARdNJBp2BT86GrLpa3brqLmscGCUipuJNh2piKTT12&biz_log=BEdLU3JjyWmswjVzaF8hvsxLgnjbEP6zLUsiJHfs6w5z6Wk6ir6UZDeSN2wV9jhZwh9Qu7dWyP2UDG7JhkwBKoMRgPcHwKEhcUe6NHvktJMbjf52v7V9jPg1x6uwW55zLNbARdKGZNMDkKVkKFq9MjD8WbJZLh4KD7Px74WTCMVag8&category=xxx_default_content_feed_2_1&device_brand=&dt=&form_scen=FROM_CONTENT&group_id=7304704552752808499&label=share&req_id=20240xxx162349B9F94600BD12654C6EB4&utm_campaign=open&utm_medium=webview&utm_source=xxx_default_content",
      "ShareCount": 10000,
      "HasVideo": true,
      "VideoWatchCount": 2000,
      "ArticleReadCount": 500,
      "DiggCount": 10000,
      "CommentCount": 500,
      "CommentUrl": "https://open.toutiao.com/a7304704552752808499/comment/?a_t=AT6zTZuXzffKpQamerBKVxxxp94LR2ARdNJBp2BT86GrLpa3brqLmscGCUipuJNh2piKTT12&biz_log=BEdLU3JjyWmswjVzaF8hvsxLgnjbEP6zLUsiJHfs6w5z6Wk6ir6UZDeSN2wV9jhZwh9Qu7dWyP2UDG7JhkwBKoMRgPcHwKEhcUe6NHvktJMbjf52v7V9jPg1x6uwW55zLNbARdKGZNMDkKVkKFq9MjD8WbJZLh4KD7Px74WTCMVag8&category=xxx_default_content_feed_2_1&device_brand=&dt=&form_scen=FROM_CONTENT&group_id=7304704552752808499&label=xxx_default_content_feed_1_59&req_id=20240521162349B9xxx600BD12654C6EB4&utm_source=xxx_default_content",
      "IsStick": true,
      "CoverMode": 1,
      "CoverImages": [
        {
          "Url": "https://p6-open-sign.byteimg.com/tos-cn-i-pk90l89vgd/1c6a1776374c4486a46a5a5cbb145ffa~tplv-tt-cut:3216:1810.jpeg?scene=content&x-expires=1747815830&x-signature=ElLytAjeIfSe2O2WkFMqOBY2VUw%3D",
          "Width": 3216,
          "Height": 1810
        }
      ],
      "FilterWords": [
        {
          "Id": "-",
          "Name": "-"
        }
      ],
      "UserInfo": {
        "AvatarUrl": "-",
        "Description": "-",
        "HomePage": "-",
        "Name": "-",
        "Follow": true,
        "FollowerCount": 0,
        "UserId": "-",
        "UserVerified": true,
        "VerifiedContent": "-"
      },
      "ArticleClassification": [
        [
          "科学科技",
          "科技",
          "互联网"
        ],
        [
          "科学科技",
          "科学"
        ]
      ],
      "VideoDetail": {
        "VideoDuration": 2230.115,
        "VideoList": [
          {
            "Definition": "360p",
            "Height": 360,
            "Width": 640,
            "Url": "http://mercury.snssdk.com/video/url/?param=ZvBxCXQxxxA6yK2je&partner=xxx_default_content&version=2&trans_vdata_to_content=1"
          }
        ]
      },
      "ProductUnion": [
        {
          "ProductId": "product1",
          "UnionReason": "-",
          "ProductExtra": "-",
          "ProductType": "general"
        }
      ],
      "ContentImageList": [
        {
          "Url": "https://p6-open-sign.byteimg.com/tos-cn-i-pk90l89vgd/1c6a1776374c4486a46a5a5cbb145ffa~tplv-tt-cut:3216:1810.jpeg?scene=content&x-expires=1747815830&x-signature=ElLytAjeIfSe2O2WkFMqOBY2VUw%3D",
          "Width": 3216,
          "Height": 1810
        }
      ]
    }
  ]
}

错误码

您可访问公共错误码,获取更多错误码信息。

示例效果

图文视频