You need to enable JavaScript to run this app.
导航

相关推荐

最近更新时间2022.09.15 18:59:09

首次发布时间2022.04.13 18:44:09

概述

该接口主要用于客户侧通过内容管理平台获取个性化推荐内容,构建C端内容相关推荐模块。

相关推荐

调前准备

  1. 接口鉴权
    详见:接口鉴权
  2. 接口配置
    详见:推荐配置
  3. 调用接口
    注意参数 是否必填,使用正确的 ServiceName、Action、Version 等url信息
    详见:下方接口信息

请求接口

请求方式

post

请求url:

https://cms.volcengineapi.com?Action=RelatedFeed&Version=2022-01-01

请求header:

ServiceName: volc_content_api

url组成:

Host: https://cms.volcengineapi.com

Action: RelatedFeed

Version: 2022-01-01

请求参数

字段名
字段类型
是否必填
说明
Context
Context
上下文信息
UniqUserId
string
用户唯一标识
Category
string
场景id,取值路径:控制台 - 内容分发 - 场景管理 - 场景ID
RelatedBizId
string
GroupId,文章唯一标识

相关字段取值

Province
河北、山西、辽宁、吉林、黑龙江、江苏、浙江、安徽、福建、江西、山东、河南、湖北、湖南、广东、海南、四川、贵州、云南、陕西、甘肃、青海、台湾
内蒙古、广西、西藏、宁夏、新疆
北京、天津、上海、重庆
香港、澳门

响应字段

字段名
字段类型
是否必填
说明
ResponseMetadata
ResponseMetadata
Data
ArticleList
BaseResp
BaseResp

请求示例

{
    "Category": "xxx",
    "Context": {
        "Province":"北京"
    },
    "RelatedBizId":"173xxxxx59",
    "UniqUserId": "user_12345678"
}

响应示例

{
	"ResponseMetadata": {
		"RequestId": "",
		"Action": "",
		"Version": "",
		"Service": "",
		"Region": ""
	},
	"Data": {
		"ArticleList": [
			{
				"GroupId": 172xxxx43,
				"Title": "我是测试",
				"Author": {
					"AuthorName": "xxx",
					"AuthorAvatarUrl": "",
					"AuthorId": "171xxx34",
					"Description": "",
					"HomePage": "",
					"FollowerCount": 0,
					"AuthorBizId": ""
				},
				"GroupType": "short_content",
				"GenerateType": "_history_import",
				"PublishTime": 1627611735,
				"DisplayTag": {
					"category_tags": "author_id:1_1712228932015134",
					"tags": "related,short_content,no_image"
				},
				"Abstract": "",
				"OpenId": "",
				"Tags": [
					"<script>a"
				],
				"Extra": "",
				"Link": "",
				"DiggCount": 0,
				"CommentCount": 0,
				"CommentUrl": "",
				"GoodsIds": [
					"12121"
				],
				"GoodsList": [{
					"GoodsId": "12121",
					"GoodsName": "3",
					"Keywords": "2",
					"Description": "1",
					"GoodsSourceId": "17xxx342"
				}],
				"Content": ""
			}
		]
	},
	"BaseResp": {
		"StatusMessage": "success",
		"StatusCode": 1000
	}
}