淘宝开放平台 - 文档中心

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	描述
query	KcSearchQuestionQuery	必须	查询参数
└ tenant_id Number 可选 3 租户id └ tenant_id_list Number [] 可选 [3] 租户列表 └ search_string String 必须测试搜索字段 └ knowledge_id Number 可选 1 问题id └ highlight Boolean 可选 false 高亮显示 └ editor_id Number 可选 111 编辑人 └ question_type Number 可选 1 问题类型 └ need_content Boolean 可选 true 是否需要返回内容 └ context_list Number [] 可选 [1] context列表 └ status Number 可选 3 状态 └ page_size Number 可选 20 分页大小 └ creator_id Number 可选 111 创建者id └ include_sub_categorys Boolean 可选 true 是否包含子类目 └ views String [] 可选 [1] 视角列表 └ category_id_list Number [] 可选 [1] 类目id列表 └ current_page Number 可选 1 当前页 └ display_ext_title Boolean 可选 true 是否默认展示扩展标题
auth	TenancyAuth	必须	鉴权
└ secret_key String 必须 d62ecfe5f779eac101832ee3bb491e4c 鉴权 └ name String 必须 test 鉴权

名称	类型	示例值	描述
result	Result		搜索结果
└ message String 错误信息 data_list KcSearchQuestion [] 返回数据列表 └ entity_code String 问题关联的实体code └ question_type Number 问题类型 └ modified_user_name String 编辑人名称 └ create_user_name String 创建人名称 └ tenant_id Number 租户id └ status Number 状态 └ title_segment String 标题分词 └ title String 标题 └ gmt_modified Date 编辑时间 └ gmt_create Date 创建时间 └ id Number 问题id └ type Number 问题类型：0-普通/1-引用 └ question_id Number 问题id └ is_similar_title Number 是否相似标题 └ source Number 来源：草稿表-0/正式表-1 └ version Number 版本号 └ end_date Date qa 失效时间 └ start_date Date qa 生效时间 └ cat_id Number 类目id └ ext String 额外字段 └ cat_name String 类目名称 └ cat_path_name String 类目路径 └ similar_id Number 相似问题主键id └ cat_id_path_list Number [] catId 路径 └ uuid String 记录唯一编码 └ score String 得分 └ similar_title String 相似标题 └ code String 错误编码 └ success Boolean false 是否成功

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaKclubKcQaSearchRequest req = new AlibabaKclubKcQaSearchRequest();
AlibabaKclubKcQaSearchRequest.KcSearchQuestionQuery obj1 = new AlibabaKclubKcQaSearchRequest.KcSearchQuestionQuery();
obj1.setTenantId(3L);
obj1.setTenantIdList(new Long[] { 3 };
);
obj1.setSearchString("测试");
obj1.setKnowledgeId(1L);
obj1.setHighlight(false);
obj1.setEditorId(111L);
obj1.setQuestionType(1L);
obj1.setNeedContent(true);
obj1.setContextList(new Long[] { 1 };
);
obj1.setStatus(3L);
obj1.setPageSize(20L);
obj1.setCreatorId(111L);
obj1.setIncludeSubCategorys(true);
obj1.setViews("1");
obj1.setCategoryIdList(new Long[] { 1 };
);
obj1.setCurrentPage(1L);
obj1.setDisplayExtTitle(true);
req.setQuery(obj1);
AlibabaKclubKcQaSearchRequest.TenancyAuth obj2 = new AlibabaKclubKcQaSearchRequest.TenancyAuth();
obj2.setSecretKey("d62ecfe5f779eac101832ee3bb491e4c");
obj2.setName("test");
req.setAuth(obj2);
AlibabaKclubKcQaSearchResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaKclubKcQaSearchRequest req = new AlibabaKclubKcQaSearchRequest();
AlibabaKclubKcQaSearchRequest.KcSearchQuestionQueryDomain obj1 = new AlibabaKclubKcQaSearchRequest.KcSearchQuestionQueryDomain();
obj1.TenantId = 3L;
obj1.TenantIdList = new long[] { 3 };
;
obj1.SearchString = "测试";
obj1.KnowledgeId = 1L;
obj1.Highlight = false;
obj1.EditorId = 111L;
obj1.QuestionType = 1L;
obj1.NeedContent = true;
obj1.ContextList = new long[] { 1 };
;
obj1.Status = 3L;
obj1.PageSize = 20L;
obj1.CreatorId = 111L;
obj1.IncludeSubCategorys = true;
obj1.Views = "1";
obj1.CategoryIdList = new long[] { 1 };
;
obj1.CurrentPage = 1L;
obj1.DisplayExtTitle = true;
req.Query_ = obj1;
AlibabaKclubKcQaSearchRequest.TenancyAuthDomain obj2 = new AlibabaKclubKcQaSearchRequest.TenancyAuthDomain();
obj2.SecretKey = "d62ecfe5f779eac101832ee3bb491e4c";
obj2.Name = "test";
req.Auth_ = obj2;
AlibabaKclubKcQaSearchResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaKclubKcQaSearchRequest;
$query = new KcSearchQuestionQuery;
$query->tenant_id="3";
$query->tenant_id_list="[3]";
$query->search_string="测试";
$query->knowledge_id="1";
$query->highlight="false";
$query->editor_id="111";
$query->question_type="1";
$query->need_content="true";
$query->context_list="[1]";
$query->status="3";
$query->page_size="20";
$query->creator_id="111";
$query->include_sub_categorys="true";
$query->views="[1]";
$query->category_id_list="[1]";
$query->current_page="1";
$query->display_ext_title="true";
$req->setQuery(json_encode($query));
$auth = new TenancyAuth;
$auth->secret_key="d62ecfe5f779eac101832ee3bb491e4c";
$auth->name="test";
$req->setAuth(json_encode($auth));
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=alibaba.kclub.kc.qa.search' \
-d 'partner_id=apidoc' \
-d 'sign=6DB502571CF5D0CE26008D61D4AB6CDF' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-04-17+12%3A12%3A45' \
-d 'v=2.0' \
-d 'auth=null' \
-d 'query=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.AlibabaKclubKcQaSearchRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.query=""
req.auth=""
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"alibaba.kclub.kc.qa.search");
add_param(pRequest,"query","数据结构JSON示例");
add_param(pRequest,"auth","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'url': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.kclub.kc.qa.search', {
	'query':'数据结构JSON示例',
	'auth':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_kclub_kc_qa_search_response>
    <result>
        <message></message>
        <data_list>
            <kc_search_question>
                <entity_code></entity_code>
                <question_type></question_type>
                <modified_user_name></modified_user_name>
                <create_user_name></create_user_name>
                <tenant_id></tenant_id>
                <status></status>
                <title_segment></title_segment>
                <title></title>
                <gmt_modified></gmt_modified>
                <gmt_create></gmt_create>
                <id></id>
                <type></type>
                <question_id></question_id>
                <is_similar_title></is_similar_title>
                <source></source>
                <version></version>
                <end_date></end_date>
                <start_date></start_date>
                <cat_id></cat_id>
                <ext></ext>
                <cat_name></cat_name>
                <cat_path_name></cat_path_name>
                <similar_id></similar_id>
                <cat_id_path_list>
                    <number></number>
                </cat_id_path_list>
                <uuid></uuid>
                <score></score>
                <similar_title></similar_title>
            </kc_search_question>
        </data_list>
        <code></code>
        <success>false</success>
    </result>
</alibaba_kclub_kc_qa_search_response>

{
    "alibaba_kclub_kc_qa_search_response":{
        "result":{
            "message":"",
            "data_list":{
                "kc_search_question":[
                    {
                        "entity_code":"",
                        "question_type":,
                        "modified_user_name":"",
                        "create_user_name":"",
                        "tenant_id":,
                        "status":,
                        "title_segment":"",
                        "title":"",
                        "gmt_modified":"",
                        "gmt_create":"",
                        "id":,
                        "type":,
                        "question_id":,
                        "is_similar_title":,
                        "source":,
                        "version":,
                        "end_date":"",
                        "start_date":"",
                        "cat_id":,
                        "ext":"",
                        "cat_name":"",
                        "cat_path_name":"",
                        "similar_id":,
                        "cat_id_path_list":{
                            "number":[
                                
                            ]
                        },
                        "uuid":"",
                        "score":"",
                        "similar_title":""
                    }
                ]
            },
            "code":"",
            "success":false
        }
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

开放平台

知识库API

alibaba.kclub.kc.qa.search (知识云-知识检索)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ