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

C端内容搜索

最近更新时间2024.02.02 16:49:39

首次发布时间2022.04.11 18:06:52

概述

本文档提供内容管理平台增值功能-C端内容搜索接口的调用,适用于客户端的内容搜索场景。
如果开启了内容权限,那么将根据场景所属用户组所关联的权限标识对内容进行过滤,保留关联权限标识内容。

C端内容搜索

调前准备

  1. 联系火山侧相关人员,开通C端搜索功能
    搜索接口权限配置流程繁琐,1-2天,若需使用,需提前联系火山人员进行相关配置
  2. 接口鉴权
    详见:接口鉴权
  3. 接口配置
    详见:接口配置
  4. 调用接口
    注意参数 是否必填,使用正确的ServiceName、Action、Version 等url信息
    详见:下方接口信息

请求接口

请求方式

post

请求url:

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

请求header:

ServiceName: volc_content_api

url组成:

Host: https://cms.volcengineapi.com

Action: Search

Version: 2022-01-01

请求参数

字段名
字段类型
是否必填
说明
Keyword
string
搜索关键词
UniqUserId
string
用户唯一标识
Category
string
场景ID,取值路径:控制台 - 内容分发 - 场景管理 - 场景ID
GenerateTypeList
list<string>
查询特定来源的内容,取值路径:控制台 - 内容引入 - 内容源管理 - Api源标识
GroupTypeList
list<string>
内容体裁,详见:GroupType
PageSize
int
分页数量限制(默认20),不超过50
Offset
int
分页内容位置

说明

  • Offset取值:Offset = PageSize * (请求次数-1)
GroupType
描述
article
图文
video
视频
short_video
小视频

响应字段

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

说明

  • FixQuery:是对Keyword搜索词的扩展,根据Keyword和FixQuery进行综合查询,用于优化搜索结果相关性
    • 如:Keyword:oqAAPL;则FixQuery:苹果
  • 对于大部分文章都会出现的词,接口减少了搜索结果的参与,不进行高亮处理,比如 "我"

请求示例

{
    "UniqUserId": "123",
    "Category": "123",
    "Keyword": "示例",
    "Offset": 0,
    "PageSize": 1
}

响应示例

正常响应示例

{
	"ResponseMetadata": {
		"RequestId": "20220120205147010225110011040A1F5A",
		"Action": "Search",
		"Version": "2022-01-01",
		"Service": "volc_content_api",
		"Region": "cn-north-1"
	},
	"Data": {
		"ArticleList": [{
			"Article": {
				"GroupId": 1719832382917719,
				"Title": "示例title",
				"Author": {
					"AuthorName": "示例作者名",
					"AuthorAvatarUrl": ".....",
					"AuthorId": "1711943343958046",
					"Description": "...",
					"HomePage": "",
					"FollowerCount": 1000,
					"AuthorBizId": ""
				},
				"GroupType": "article",
				"GenerateType": "test_source",
				"PublishTime": 1640159969,
				"Abstract": "",
				"OpenId": "",
				"Tags": [
					"示例tag1",
					"示例tag2"
				],
				"CoverImages": [{
					"Url": ".....",
					"Height": 750,
					"Weight": 1201,
					"Width": 1201
				}],
				"Extra": "",
				"Link": "",
				"DiggCount": 0,
				"CommentCount": 0,
				"CommentUrl": ""
			},
			"DisplayTitle": "<em>示例</em>title",
			"DisplaySummary": ""
		}, ...],
		"Total": 1,
		"HasMore": false,
		"Offset": 0,
		"Keyword": "示例",
		"FixQuery": "示例"
	},
	"BaseResp": {
		"StatusMessage": "success",
		"StatusCode": 1000
	}
}
{
    "ResponseMetadata": {
        "RequestId": "20220908162610010208018152263630BE",
        "Action": "Search",
        "Version": "2022-01-01",
        "Service": "volc_content_api",
        "Region": "cn-north-1"
    },
    "Data": {
        "ArticleList": null,
        "Total": 0,
        "HasMore": false,
        "Offset": 0,
        "Keyword": "xxx",
        "FixQuery": ""
    },
    "BaseResp": {
        "StatusMessage": "success",
        "StatusCode": 1000
    }
}

异常响应示例

{
    "ResponseMetadata": {
        "RequestId": "202209131144050102121621570562B0BB",
        "Action": "Search",
        "Version": "2022-01-01",
        "Service": "volc_content_api",
        "Region": "cn-north-1",
        "Error": {
            "CodeN": 1001,
            "Code": "1001",
            "Message": "参数错误"
        }
    },
    "Data": null,
    "BaseResp": {
        "StatusMessage": "参数错误",
        "StatusCode": 1001
    }
}

错误代码

详见:错误代码表:volc_content_api

注意

若需排查日志,请提供 RequestId