淘宝开放平台 - 文档中心

请求地址：

环境	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	必须	搜索参数
sorter_config SorterConfig 可选排序配置 └ field String 可选 TEN_DAY_PV 字段 └ order String 可选 DECREASE 顺序 └ tenant_id Number 可选 1 租户 └ tenant_id_list Number [] 可选 [1] 租户列表 └ search_string String 可选 1 搜索条件 └ knowledge_id Number 可选 1 知识id └ highlight Boolean 可选 true 高亮 └ search_rule String 可选 1 排序规则 └ editor_id Number 可选 1 编辑人id └ question_type Number 可选 1 问题类型 └ need_content Boolean 可选 true 需要内容 └ context_list Number [] 可选 [1] 上下文 └ status Number 可选 1 状态 └ page_size Number 可选 20 页面大小 └ creator_id Number 可选 1 创建人id └ include_sub_categorys Boolean 可选 true 是否包含子类目 └ views String [] 可选 [1] 视角 └ category_id_list Number [] 可选 [1] 类目列表 └ current_page Number 可选 1 页码
auth	TenancyAuth	可选	授权对象
└ secret_key String 必须 key key └ name String 必须 name name

名称	类型	示例值	描述
result	Result		接口返回model
data Paging 1234 返回素材id data_list KcSearchQuestionDto [] 数据 └ one_day_pv Number 1天访问pv └ three_day_pv Number 3天访问pv └ five_day_pv Number 5天访问pv └ seven_day_pv Number 7天访问pv └ ten_day_pv Number 10天访问pv └ end_date Date 失效时间 └ version Number 版本 └ source Number 是否草稿版本 └ is_similar_title Number 是否相似标题 └ question_id Number 问题id └ type Number 索引类型 └ id Number 索引id └ similar_title String 相似问题 └ score String 得分 └ uuid String 唯一编码 └ cat_id_path_list Number [] 父类目列表 └ entity_code String 关联实体code └ gmt_create Date 创建时间 └ gmt_modified Date 修改时间 └ title String 标题 └ title_segment String 分词 └ status Number 状态 └ tenant_id Number 租户id └ create_user_id Number 创建人id └ modified_user_id Number 修改人id └ create_user_name String 创建人名称 └ modified_user_name String 修改人名称 └ question_type String 问题类型 └ similar_id Number 相似问题id └ cat_path_name String 类目路径名称 └ cat_name String 类目名称 └ ext String 额外字段 └ cat_id Number 类目id └ start_date Date 生效时间 └ page_no Number 页码 └ page_size Number 页面大小 └ row_count Number 总数 └ message String message └ code String code └ success Boolean false 是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaKclubKcQaSearchPageDingdingRequest req = new AlibabaKclubKcQaSearchPageDingdingRequest();
AlibabaKclubKcQaSearchPageDingdingRequest.KcSearchQuestionQuery obj1 = new AlibabaKclubKcQaSearchPageDingdingRequest.KcSearchQuestionQuery();
AlibabaKclubKcQaSearchPageDingdingRequest.SorterConfig obj2 = new AlibabaKclubKcQaSearchPageDingdingRequest.SorterConfig();
obj2.setField("TEN_DAY_PV");
obj2.setOrder("DECREASE");
obj1.setSorterConfig(obj2);
obj1.setTenantId(1L);
obj1.setTenantIdList(new Long[] { 1 };
);
obj1.setSearchString("1");
obj1.setKnowledgeId(1L);
obj1.setHighlight(true);
obj1.setSearchRule("1");
obj1.setEditorId(1L);
obj1.setQuestionType(1L);
obj1.setNeedContent(true);
obj1.setContextList(new Long[] { 1 };
);
obj1.setStatus(1L);
obj1.setPageSize(20L);
obj1.setCreatorId(1L);
obj1.setIncludeSubCategorys(true);
obj1.setViews("1");
obj1.setCategoryIdList(new Long[] { 1 };
);
obj1.setCurrentPage(1L);
req.setQuery(obj1);
AlibabaKclubKcQaSearchPageDingdingRequest.TenancyAuth obj3 = new AlibabaKclubKcQaSearchPageDingdingRequest.TenancyAuth();
obj3.setSecretKey("key");
obj3.setName("name");
req.setAuth(obj3);
AlibabaKclubKcQaSearchPageDingdingResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaKclubKcQaSearchPageDingdingRequest req = new AlibabaKclubKcQaSearchPageDingdingRequest();
AlibabaKclubKcQaSearchPageDingdingRequest.KcSearchQuestionQueryDomain obj1 = new AlibabaKclubKcQaSearchPageDingdingRequest.KcSearchQuestionQueryDomain();
AlibabaKclubKcQaSearchPageDingdingRequest.SorterConfigDomain obj2 = new AlibabaKclubKcQaSearchPageDingdingRequest.SorterConfigDomain();
obj2.Field = "TEN_DAY_PV";
obj2.Order = "DECREASE";
obj1.SorterConfig= obj2;
obj1.TenantId = 1L;
obj1.TenantIdList = new long[] { 1 };
;
obj1.SearchString = "1";
obj1.KnowledgeId = 1L;
obj1.Highlight = true;
obj1.SearchRule = "1";
obj1.EditorId = 1L;
obj1.QuestionType = 1L;
obj1.NeedContent = true;
obj1.ContextList = new long[] { 1 };
;
obj1.Status = 1L;
obj1.PageSize = 20L;
obj1.CreatorId = 1L;
obj1.IncludeSubCategorys = true;
obj1.Views = "1";
obj1.CategoryIdList = new long[] { 1 };
;
obj1.CurrentPage = 1L;
req.Query_ = obj1;
AlibabaKclubKcQaSearchPageDingdingRequest.TenancyAuthDomain obj3 = new AlibabaKclubKcQaSearchPageDingdingRequest.TenancyAuthDomain();
obj3.SecretKey = "key";
obj3.Name = "name";
req.Auth_ = obj3;
AlibabaKclubKcQaSearchPageDingdingResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaKclubKcQaSearchPageDingdingRequest;
$query = new KcSearchQuestionQuery;
$sorter_config = new SorterConfig;
$sorter_config->field="TEN_DAY_PV";
$sorter_config->order="DECREASE";
$query->sorter_config = $sorter_config;
$query->tenant_id="1";
$query->tenant_id_list="[1]";
$query->search_string="1";
$query->knowledge_id="1";
$query->highlight="true";
$query->search_rule="1";
$query->editor_id="1";
$query->question_type="1";
$query->need_content="true";
$query->context_list="[1]";
$query->status="1";
$query->page_size="20";
$query->creator_id="1";
$query->include_sub_categorys="true";
$query->views="[1]";
$query->category_id_list="[1]";
$query->current_page="1";
$req->setQuery(json_encode($query));
$auth = new TenancyAuth;
$auth->secret_key="key";
$auth->name="name";
$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.page.dingding' \
-d 'partner_id=apidoc' \
-d 'sign=9F5E1EE45AACA85869403D22664BB545' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-04-17+12%3A13%3A13' \
-d 'v=2.0' \
-d 'auth=null' \
-d 'query=null'

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

req=top.api.AlibabaKclubKcQaSearchPageDingdingRequest(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.page.dingding");
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.page.dingding', {
	'query':'数据结构JSON示例',
	'auth':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_kclub_kc_qa_search_page_dingding_response>
    <result>
        <data>
            <data_list>
                <kc_search_question_dto>
                    <one_day_pv></one_day_pv>
                    <three_day_pv></three_day_pv>
                    <five_day_pv></five_day_pv>
                    <seven_day_pv></seven_day_pv>
                    <ten_day_pv></ten_day_pv>
                    <end_date></end_date>
                    <version></version>
                    <source></source>
                    <is_similar_title></is_similar_title>
                    <question_id></question_id>
                    <type></type>
                    <id></id>
                    <similar_title></similar_title>
                    <score></score>
                    <uuid></uuid>
                    <cat_id_path_list>
                        <number></number>
                    </cat_id_path_list>
                    <entity_code></entity_code>
                    <gmt_create></gmt_create>
                    <gmt_modified></gmt_modified>
                    <title></title>
                    <title_segment></title_segment>
                    <status></status>
                    <tenant_id></tenant_id>
                    <create_user_id></create_user_id>
                    <modified_user_id></modified_user_id>
                    <create_user_name></create_user_name>
                    <modified_user_name></modified_user_name>
                    <question_type></question_type>
                    <similar_id></similar_id>
                    <cat_path_name></cat_path_name>
                    <cat_name></cat_name>
                    <ext></ext>
                    <cat_id></cat_id>
                    <start_date></start_date>
                </kc_search_question_dto>
            </data_list>
            <page_no></page_no>
            <page_size></page_size>
            <row_count></row_count>
        </data>
        <message></message>
        <code></code>
        <success>false</success>
    </result>
</alibaba_kclub_kc_qa_search_page_dingding_response>

{
    "alibaba_kclub_kc_qa_search_page_dingding_response":{
        "result":{
            "data":{
                "data_list":{
                    "kc_search_question_dto":[
                        {
                            "one_day_pv":,
                            "three_day_pv":,
                            "five_day_pv":,
                            "seven_day_pv":,
                            "ten_day_pv":,
                            "end_date":"",
                            "version":,
                            "source":,
                            "is_similar_title":,
                            "question_id":,
                            "type":,
                            "id":,
                            "similar_title":"",
                            "score":"",
                            "uuid":"",
                            "cat_id_path_list":{
                                "number":[
                                    
                                ]
                            },
                            "entity_code":"",
                            "gmt_create":"",
                            "gmt_modified":"",
                            "title":"",
                            "title_segment":"",
                            "status":,
                            "tenant_id":,
                            "create_user_id":,
                            "modified_user_id":,
                            "create_user_name":"",
                            "modified_user_name":"",
                            "question_type":"",
                            "similar_id":,
                            "cat_path_name":"",
                            "cat_name":"",
                            "ext":"",
                            "cat_id":,
                            "start_date":""
                        }
                    ]
                },
                "page_no":,
                "page_size":,
                "row_count":
            },
            "message":"",
            "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.page.dingding (钉钉客服小蜜知识库搜索接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ