客户侧调用该接口获取个性化推荐的内容,目前支持的内容体裁有图文、横版短视频、竖版小视频。
每次请求,火山引擎侧默认返回的内容条数在6-15条不等,内容信息包括内容标题、封面图,作者名称、阅读数、播放量、发布时间、点赞数、分享数等,客户侧可使用这些数据,自定义实现UI效果。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 | ||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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位时间戳,单位:秒。 | ||||||||||||||||||||||||||||||||||||||||||||||
Category | String | 是 | demo_default_content_feed_1_1 | 频道ID。 | ||||||||||||||||||||||||||||||||||||||||||||||
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 | 是否为压测。
| ||||||||||||||||||||||||||||||||||||||||||||||
OffPersonalRec | Integer | 否 | 1 | 是否关闭个性化推荐。
| ||||||||||||||||||||||||||||||||||||||||||||||
Ip | String | 否 | 设备ip。客户侧服务端调用此接口,传递的是客户侧客户端的ip地址。 | |||||||||||||||||||||||||||||||||||||||||||||||
City | String | 否 | 北京 | 城市名称,比如:北京,编码为utf-8。
| ||||||||||||||||||||||||||||||||||||||||||||||
AllowForceInsert | Integer | 否 | 1 | 是否强插。
| ||||||||||||||||||||||||||||||||||||||||||||||
CustomVideoDefinition | String | 否 | 540p | 指定视频分辨率。
注意 分辨率的升档会增加cdn的播放成本,需客户侧谨慎评估,详细咨询火山引擎侧。 | ||||||||||||||||||||||||||||||||||||||||||||||
AllowStick | Integer | 否 | 1 | 是否输出置顶文章。
说明 当同时满足如下几个条件,才会返回置顶内容:
|
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
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 } ] } ] }
您可访问公共错误码,获取更多错误码信息。
图文 | 视频 |
---|---|