淘宝开放平台 - 文档中心

请求地址：

环境	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。

名称	类型	是否必须	描述
kc_qa_query	KcQaQuery	可选	查询条件
└ tenant_id Number 可选 1 租户id └ context_list Number [] 可选 [1] context列表 └ status Number 可选 1 状态 └ question_types String [] 可选 [1] 问题类型列表 └ context Number 可选 1 context └ page_size Number 可选 20 页大小 └ status_list String [] 可选 [1] 状态列表 └ cat_id Number 必须 3 类目id └ current_page Number 可选 1 当前页 └ question_type Number 可选 1 问题类型 sorter_config SorterConfig 可选排序对象 └ order String 可选 DECREASE 顺序 └ field String 可选 SEVEN_DAY_PV 排序字段 └ views String [] 可选 [1] 视角过滤
auth	TenancyAuth	必须	鉴权
└ secret_key String 必须 d62ecfe5f779eac101832ee3bb491e4c 鉴权 └ name String 必须 test 鉴权

名称	类型	示例值	描述
result	Result		结果
└ message String 错误信息 data Paging 1234 返回数据 data_list KcQaReadDto [] 数据内容列表 └ cat_path String 类目路径 └ cat_id Number 类目id └ tenant_id Number 租户id └ status Number 状态 └ title String 知识标题 └ gmt_modified Date 编辑时间 └ gmt_create Date 创建时间 └ id Number 问题id child_qas KcQaReadDto [] 子知识 solutions KcQaSolutionDto [] 子知识答案 └ question_id Number 子知识问题id └ gmt_modified Date 子知识编辑时间 └ gmt_create Date 子知识创建时间 └ id Number 子知识答案id └ plain_text String 子知识答案纯文本 └ summary String 子知识答案摘要 └ type Number 子知识答案视角 └ extra_content String 子知识答案额外内容 └ content_view String 子知识答案内容视角 └ content_type Number 子知识答案内容类型 └ content String 子知识答案富文本内容 └ context Number 问题答案 └ question_type Number 问题类型 └ entity_code String 问题关联实体code └ parent_cats Number [] 父类目列表 └ cat_path String 类目路径 └ cat_id Number 类目id └ tenant_id Number 租户id └ status Number 状态 └ title String 问题标题 └ gmt_modified Date 问题编辑时间 └ gmt_create Date 问题创建时间 └ id Number 问题id solutions KcQaSolutionDto [] 问题答案 └ content String 答案内容 └ question_id Number 问题id └ gmt_modified Date 答案编辑时间 └ gmt_create Date 答案创建时间 └ id Number 答案id └ plain_text String 答案纯文本 └ summary String 答案摘要 └ type Number 答案视角 └ extra_content String 答案额外内容 └ content_view String 答案视角 └ content_type Number 答案类型 └ context Number 问题类型(原kbs context) └ question_type Number 问题类型 └ entity_code String 关联的实体code └ parent_cats Number [] 父类目id qa_pv QaPvDto qa的访问量 └ ten_day_pv Number 十天访问量 └ seven_day_pv Number 7天访问量 └ five_day_pv Number 5天访问量 └ three_day_pv Number 3天访问量 └ one_day_pv Number 1天访问量 └ row_count Number 记录数 └ page_size Number 页码大小 └ page_no Number 页号 └ code String 错误编码 └ success Boolean false 是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaKclubKcQueryknowledgeRequest req = new AlibabaKclubKcQueryknowledgeRequest();
AlibabaKclubKcQueryknowledgeRequest.KcQaQuery obj1 = new AlibabaKclubKcQueryknowledgeRequest.KcQaQuery();
obj1.setTenantId(1L);
obj1.setContextList(new Long[] { 1 };
);
obj1.setStatus(1L);
obj1.setQuestionTypes("1");
obj1.setContext(1L);
obj1.setPageSize(20L);
obj1.setStatusList("1");
obj1.setCatId(3L);
obj1.setCurrentPage(1L);
obj1.setQuestionType(1L);
AlibabaKclubKcQueryknowledgeRequest.SorterConfig obj2 = new AlibabaKclubKcQueryknowledgeRequest.SorterConfig();
obj2.setOrder("DECREASE");
obj2.setField("SEVEN_DAY_PV");
obj1.setSorterConfig(obj2);
obj1.setViews("1");
req.setKcQaQuery(obj1);
AlibabaKclubKcQueryknowledgeRequest.TenancyAuth obj3 = new AlibabaKclubKcQueryknowledgeRequest.TenancyAuth();
obj3.setSecretKey("d62ecfe5f779eac101832ee3bb491e4c");
obj3.setName("test");
req.setAuth(obj3);
AlibabaKclubKcQueryknowledgeResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaKclubKcQueryknowledgeRequest req = new AlibabaKclubKcQueryknowledgeRequest();
AlibabaKclubKcQueryknowledgeRequest.KcQaQueryDomain obj1 = new AlibabaKclubKcQueryknowledgeRequest.KcQaQueryDomain();
obj1.TenantId = 1L;
obj1.ContextList = new long[] { 1 };
;
obj1.Status = 1L;
obj1.QuestionTypes = "1";
obj1.Context = 1L;
obj1.PageSize = 20L;
obj1.StatusList = "1";
obj1.CatId = 3L;
obj1.CurrentPage = 1L;
obj1.QuestionType = 1L;
AlibabaKclubKcQueryknowledgeRequest.SorterConfigDomain obj2 = new AlibabaKclubKcQueryknowledgeRequest.SorterConfigDomain();
obj2.Order = "DECREASE";
obj2.Field = "SEVEN_DAY_PV";
obj1.SorterConfig= obj2;
obj1.Views = "1";
req.KcQaQuery_ = obj1;
AlibabaKclubKcQueryknowledgeRequest.TenancyAuthDomain obj3 = new AlibabaKclubKcQueryknowledgeRequest.TenancyAuthDomain();
obj3.SecretKey = "d62ecfe5f779eac101832ee3bb491e4c";
obj3.Name = "test";
req.Auth_ = obj3;
AlibabaKclubKcQueryknowledgeResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaKclubKcQueryknowledgeRequest;
$kc_qa_query = new KcQaQuery;
$kc_qa_query->tenant_id="1";
$kc_qa_query->context_list="[1]";
$kc_qa_query->status="1";
$kc_qa_query->question_types="[1]";
$kc_qa_query->context="1";
$kc_qa_query->page_size="20";
$kc_qa_query->status_list="[1]";
$kc_qa_query->cat_id="3";
$kc_qa_query->current_page="1";
$kc_qa_query->question_type="1";
$sorter_config = new SorterConfig;
$sorter_config->order="DECREASE";
$sorter_config->field="SEVEN_DAY_PV";
$kc_qa_query->sorter_config = $sorter_config;
$kc_qa_query->views="[1]";
$req->setKcQaQuery(json_encode($kc_qa_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.queryknowledge' \
-d 'partner_id=apidoc' \
-d 'sign=CC50D79047564814DD33DA7480A741CC' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-04-17+12%3A11%3A59' \
-d 'v=2.0' \
-d 'auth=null' \
-d 'kc_qa_query=null'

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

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

req.kc_qa_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.queryknowledge");
add_param(pRequest,"kc_qa_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.queryknowledge', {
	'kc_qa_query':'数据结构JSON示例',
	'auth':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_kclub_kc_queryknowledge_response>
    <result>
        <message></message>
        <data>
            <data_list>
                <kc_qa_read_dto>
                    <cat_path></cat_path>
                    <cat_id></cat_id>
                    <tenant_id></tenant_id>
                    <status></status>
                    <title></title>
                    <gmt_modified></gmt_modified>
                    <gmt_create></gmt_create>
                    <id></id>
                    <child_qas>
                        <kc_qa_read_dto>
                            <solutions>
                                <kc_qa_solution_dto>
                                    <question_id></question_id>
                                    <gmt_modified></gmt_modified>
                                    <gmt_create></gmt_create>
                                    <id></id>
                                    <plain_text></plain_text>
                                    <summary></summary>
                                    <type></type>
                                    <extra_content></extra_content>
                                    <content_view></content_view>
                                    <content_type></content_type>
                                    <content></content>
                                </kc_qa_solution_dto>
                            </solutions>
                            <context></context>
                            <question_type></question_type>
                            <entity_code></entity_code>
                            <parent_cats>
                                <number></number>
                            </parent_cats>
                            <cat_path></cat_path>
                            <cat_id></cat_id>
                            <tenant_id></tenant_id>
                            <status></status>
                            <title></title>
                            <gmt_modified></gmt_modified>
                            <gmt_create></gmt_create>
                            <id></id>
                        </kc_qa_read_dto>
                    </child_qas>
                    <solutions>
                        <kc_qa_solution_dto>
                            <content></content>
                            <question_id></question_id>
                            <gmt_modified></gmt_modified>
                            <gmt_create></gmt_create>
                            <id></id>
                            <plain_text></plain_text>
                            <summary></summary>
                            <type></type>
                            <extra_content></extra_content>
                            <content_view></content_view>
                            <content_type></content_type>
                        </kc_qa_solution_dto>
                    </solutions>
                    <context></context>
                    <question_type></question_type>
                    <entity_code></entity_code>
                    <parent_cats>
                        <number></number>
                    </parent_cats>
                    <qa_pv>
                        <ten_day_pv></ten_day_pv>
                        <seven_day_pv></seven_day_pv>
                        <five_day_pv></five_day_pv>
                        <three_day_pv></three_day_pv>
                        <one_day_pv></one_day_pv>
                    </qa_pv>
                </kc_qa_read_dto>
            </data_list>
            <row_count></row_count>
            <page_size></page_size>
            <page_no></page_no>
        </data>
        <code></code>
        <success>false</success>
    </result>
</alibaba_kclub_kc_queryknowledge_response>

{
    "alibaba_kclub_kc_queryknowledge_response":{
        "result":{
            "message":"",
            "data":{
                "data_list":{
                    "kc_qa_read_dto":[
                        {
                            "cat_path":"",
                            "cat_id":,
                            "tenant_id":,
                            "status":,
                            "title":"",
                            "gmt_modified":"",
                            "gmt_create":"",
                            "id":,
                            "child_qas":{
                                "kc_qa_read_dto":[
                                    {
                                        "solutions":{
                                            "kc_qa_solution_dto":[
                                                {
                                                    "question_id":,
                                                    "gmt_modified":"",
                                                    "gmt_create":"",
                                                    "id":,
                                                    "plain_text":"",
                                                    "summary":"",
                                                    "type":,
                                                    "extra_content":"",
                                                    "content_view":"",
                                                    "content_type":,
                                                    "content":""
                                                }
                                            ]
                                        },
                                        "context":,
                                        "question_type":,
                                        "entity_code":"",
                                        "parent_cats":{
                                            "number":[
                                                
                                            ]
                                        },
                                        "cat_path":"",
                                        "cat_id":,
                                        "tenant_id":,
                                        "status":,
                                        "title":"",
                                        "gmt_modified":"",
                                        "gmt_create":"",
                                        "id":
                                    }
                                ]
                            },
                            "solutions":{
                                "kc_qa_solution_dto":[
                                    {
                                        "content":"",
                                        "question_id":,
                                        "gmt_modified":"",
                                        "gmt_create":"",
                                        "id":,
                                        "plain_text":"",
                                        "summary":"",
                                        "type":,
                                        "extra_content":"",
                                        "content_view":"",
                                        "content_type":
                                    }
                                ]
                            },
                            "context":,
                            "question_type":,
                            "entity_code":"",
                            "parent_cats":{
                                "number":[
                                    
                                ]
                            },
                            "qa_pv":{
                                "ten_day_pv":,
                                "seven_day_pv":,
                                "five_day_pv":,
                                "three_day_pv":,
                                "one_day_pv":
                            }
                        }
                    ]
                },
                "row_count":,
                "page_size":,
                "page_no":
            },
            "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.queryknowledge (知识云-通用知识查询服务)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ