淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
qq	String	可选	127438	qq
code	String	可选	127438	code
name	String	可选	127438	name
mobile	String	可选	127438	mobile
page_size	Number	可选	20	pageSize
page	Number	可选	1	page
user_id	Number	可选	268565149	userId

名称	类型	示例值	描述
result	CommonResponse		系统自动生成
└ data Json data └ state Number 200 state └ message String ok message

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaShuqiOriginalBackendOnlineeditorSearchRequest req = new AlibabaShuqiOriginalBackendOnlineeditorSearchRequest();
req.setQq("127438");
req.setCode("127438");
req.setName("127438");
req.setMobile("127438");
req.setPageSize(20L);
req.setPage(1L);
req.setUserId(268565149L);
AlibabaShuqiOriginalBackendOnlineeditorSearchResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaShuqiOriginalBackendOnlineeditorSearchRequest req = new AlibabaShuqiOriginalBackendOnlineeditorSearchRequest();
req.Qq = "127438";
req.Code = "127438";
req.Name = "127438";
req.Mobile = "127438";
req.PageSize = 20L;
req.Page = 1L;
req.UserId = 268565149L;
AlibabaShuqiOriginalBackendOnlineeditorSearchResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaShuqiOriginalBackendOnlineeditorSearchRequest;
$req->setQq("127438");
$req->setCode("127438");
$req->setName("127438");
$req->setMobile("127438");
$req->setPageSize("20");
$req->setPage("1");
$req->setUserId("268565149");
$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.shuqi.original.backend.onlineeditor.search' \
-d 'partner_id=apidoc' \
-d 'sign=0CD26538049F5E7019EEB03277F8F3CE' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-07-18+03%3A14%3A47' \
-d 'v=2.0' \
-d 'code=127438' \
-d 'mobile=127438' \
-d 'name=127438' \
-d 'page=1' \
-d 'page_size=20' \
-d 'qq=127438' \
-d 'user_id=268565149'

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

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

req.qq="127438"
req.code="127438"
req.name="127438"
req.mobile="127438"
req.page_size=20
req.page=1
req.user_id=268565149
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.shuqi.original.backend.onlineeditor.search");
add_param(pRequest,"qq","127438");
add_param(pRequest,"code","127438");
add_param(pRequest,"name","127438");
add_param(pRequest,"mobile","127438");
add_param(pRequest,"page_size","20");
add_param(pRequest,"page","1");
add_param(pRequest,"user_id","268565149");
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',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.shuqi.original.backend.onlineeditor.search', {
	'qq':'127438',
	'code':'127438',
	'name':'127438',
	'mobile':'127438',
	'page_size':'20',
	'page':'1',
	'user_id':'268565149'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_shuqi_original_backend_onlineeditor_search_response>
    <result>
        <data></data>
        <state>200</state>
        <message>ok</message>
    </result>
</alibaba_shuqi_original_backend_onlineeditor_search_response>

{
    "alibaba_shuqi_original_backend_onlineeditor_search_response":{
        "result":{
            "data":"",
            "state":200,
            "message":"ok"
        }
    }
}

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下载

开放平台

书旗内容文巢

alibaba.shuqi.original.backend.onlineeditor.search (网编列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ