You need to enable JavaScript to run this app.
导航
RelatedFeed - 相关推荐
最近更新时间:2024.03.12 15:04:16首次发布时间:2022.04.13 18:44:09

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

注意事项

  • 前提条件:
    • 请联系火山侧产品人员,开通相关推荐功能,接口权限配置流程繁琐,1-2天,若需使用,请提前联系火山人员进行相关配置。
    • 已完成相关推荐场景的创建,详见:2.2 创建相关推荐场景

请求说明

  • 请求方式:POST
  • 请求地址:https://cms.volcengineapi.com?Action=RelatedFeed&Version=2022-01-01
  • 请求头:ServiceName: volc_content_api

请求参数

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

Query

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

RelatedFeed

要执行的操作,取值:RelatedFeed

Version
String

2022-01-01

API的版本,取值:2022-01-01

Body

参数
类型
是否必填
示例值
描述
Context
RelatedContext

上下文信息

UniqUserId
String

用户唯一标识。

Category
String

场景id,取值路径:控制台 - 内容分发 - 场景管理 - 场景ID

RelatedBizId
String

GroupId,内容唯一标识。

返回参数

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

参数
类型
示例值
描述
Data
RelatedArticleList

响应数据

请求示例

{
    "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
	}
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
200
1001
参数错误

返回具体的参数错误描述

200
1002
服务未知错误

请联系火山引擎技术人员