该接口主要用于客户侧通过内容管理平台获取相关推荐内容,构建C端内容相关推荐模块。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | RelatedFeed | 要执行的操作,取值:RelatedFeed |
Version | String | 是 | 2022-01-01 | API的版本,取值:2022-01-01 |
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
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 | 服务未知错误 | 请联系火山引擎技术人员 |