淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
opt_name	String	可选	1	optName
page_size	Number	必须	20	pageSize
start_time	String	可选	1	startTime
end_time	String	可选	1	endTime
page	Number	必须	1	page
sort	String	可选	1	sort
action_name	String	可选	1	actionName
order	String	可选	1	actionName
is_export	Number	可选	1	isExport
emp_id	String	可选	WB873525	empId

名称	类型	示例值	描述
result	CommonResponse		result
data OgnvWorkResp data total TotalItem total └ user_chapter_pass Number 100 userChapterPass └ long_chapter_through Number 1873 longChapterThrough └ chen_gua_book_pass Number 26 chenGuaBookPass └ chen_gua_chapter_pass Number 9 chenGuaChapterPass └ chen_gua_author_through Number 73 chenGuaAuthorThrough └ user_chapter_through Number 19 userChapterThrough └ long_book_pass Number 364 longBookPass └ user_book_pass Number 19 userBookPass └ chen_gua_author_pass Number 9 chenGuaAuthorPass └ long_author_pass Number 241 longAuthorPass └ user_author_through Number 2 userAuthorThrough └ long_author_through Number 705 longAuthorThrough └ long_book_through Number 1118 longBookThrough └ chen_gua_chapter_through Number 87 longBookThrough └ chen_gua_book_through Number 160 chenGuaChapterThrough └ user_author_pass Number 2 userAuthorPass └ user_book_through Number 13 userBookThrough └ long_chapter_pass Number 399 longChapterPass └ short_item_pass Number 111 shortItemPass └ short_item_reject Number 1111 shortItemReject └ count Number 593 count └ page Number 593 page list Item [] list └ user_chapter_pass Number 0 userChapterPass └ cr_time String 2021-08-15 crTime └ long_chapter_through Number 0 longChapterThrough └ chen_gua_book_pass Number 0 chenGuaBookPass └ chen_gua_chapter_pass Number 0 chenGuaChapterPass └ chen_gua_author_through Number 0 chenGuaAuthorThrough └ user_chapter_through Number 0 userChapterThrough └ long_book_pass Number 3 longBookPass └ user_book_pass Number 0 userBookPass └ chen_gua_author_pass Number 0 chenGuaAuthorPass └ long_author_pass Number 2 longAuthorPass └ user_author_through Number 0 userAuthorThrough └ long_author_through Number 1 longAuthorThrough └ long_book_through Number 13 longBookThrough └ chen_gua_chapter_through Number 0 chenGuaChapterThrough └ chen_gua_book_through Number 0 chenGuaBookThrough └ user_author_pass Number 0 userAuthorPass └ user_book_through Number 0 userBookThrough └ long_chapter_pass Number 0 longChapterPass └ action_name String jason_zb actionName └ short_item_pass Number 1111 shortItemPass └ short_item_reject Number 111111 shortItemReject └ state Number 200 state └ message String ok message

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaShuqiOriginalBackendOgnvworkWorklistRequest req = new AlibabaShuqiOriginalBackendOgnvworkWorklistRequest();
req.setOptName("1");
req.setPageSize(20L);
req.setStartTime("1");
req.setEndTime("1");
req.setPage(1L);
req.setSort("1");
req.setActionName("1");
req.setOrder("1");
req.setIsExport(1L);
req.setEmpId("WB873525");
AlibabaShuqiOriginalBackendOgnvworkWorklistResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaShuqiOriginalBackendOgnvworkWorklistRequest req = new AlibabaShuqiOriginalBackendOgnvworkWorklistRequest();
req.OptName = "1";
req.PageSize = 20L;
req.StartTime = "1";
req.EndTime = "1";
req.Page = 1L;
req.Sort = "1";
req.ActionName = "1";
req.Order = "1";
req.IsExport = 1L;
req.EmpId = "WB873525";
AlibabaShuqiOriginalBackendOgnvworkWorklistResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaShuqiOriginalBackendOgnvworkWorklistRequest;
$req->setOptName("1");
$req->setPageSize("20");
$req->setStartTime("1");
$req->setEndTime("1");
$req->setPage("1");
$req->setSort("1");
$req->setActionName("1");
$req->setOrder("1");
$req->setIsExport("1");
$req->setEmpId("WB873525");
$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.ognvwork.worklist' \
-d 'partner_id=apidoc' \
-d 'sign=62DECA6F8EFD30DA30ECC40D3BFB81BE' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-08-28+23%3A10%3A20' \
-d 'v=2.0' \
-d 'action_name=1' \
-d 'emp_id=WB873525' \
-d 'end_time=1' \
-d 'is_export=1' \
-d 'opt_name=1' \
-d 'order=1' \
-d 'page=1' \
-d 'page_size=20' \
-d 'sort=1' \
-d 'start_time=1'

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

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

req.opt_name="1"
req.page_size=20
req.start_time="1"
req.end_time="1"
req.page=1
req.sort="1"
req.action_name="1"
req.order="1"
req.is_export=1
req.emp_id="WB873525"
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.ognvwork.worklist");
add_param(pRequest,"opt_name","1");
add_param(pRequest,"page_size","20");
add_param(pRequest,"start_time","1");
add_param(pRequest,"end_time","1");
add_param(pRequest,"page","1");
add_param(pRequest,"sort","1");
add_param(pRequest,"action_name","1");
add_param(pRequest,"order","1");
add_param(pRequest,"is_export","1");
add_param(pRequest,"emp_id","WB873525");
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.ognvwork.worklist', {
	'opt_name':'1',
	'page_size':'20',
	'start_time':'1',
	'end_time':'1',
	'page':'1',
	'sort':'1',
	'action_name':'1',
	'order':'1',
	'is_export':'1',
	'emp_id':'WB873525'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_shuqi_original_backend_ognvwork_worklist_response>
    <result>
        <data>
            <total>
                <user_chapter_pass>100</user_chapter_pass>
                <long_chapter_through>1873</long_chapter_through>
                <chen_gua_book_pass>26</chen_gua_book_pass>
                <chen_gua_chapter_pass>9</chen_gua_chapter_pass>
                <chen_gua_author_through>73</chen_gua_author_through>
                <user_chapter_through>19</user_chapter_through>
                <long_book_pass>364</long_book_pass>
                <user_book_pass>19</user_book_pass>
                <chen_gua_author_pass>9</chen_gua_author_pass>
                <long_author_pass>241</long_author_pass>
                <user_author_through>2</user_author_through>
                <long_author_through>705</long_author_through>
                <long_book_through>1118</long_book_through>
                <chen_gua_chapter_through>87</chen_gua_chapter_through>
                <chen_gua_book_through>160</chen_gua_book_through>
                <user_author_pass>2</user_author_pass>
                <user_book_through>13</user_book_through>
                <long_chapter_pass>399</long_chapter_pass>
                <short_item_pass>111</short_item_pass>
                <short_item_reject>1111</short_item_reject>
            </total>
            <count>593</count>
            <page>593</page>
            <list>
                <item>
                    <user_chapter_pass>0</user_chapter_pass>
                    <cr_time>2021-08-15</cr_time>
                    <long_chapter_through>0</long_chapter_through>
                    <chen_gua_book_pass>0</chen_gua_book_pass>
                    <chen_gua_chapter_pass>0</chen_gua_chapter_pass>
                    <chen_gua_author_through>0</chen_gua_author_through>
                    <user_chapter_through>0</user_chapter_through>
                    <long_book_pass>3</long_book_pass>
                    <user_book_pass>0</user_book_pass>
                    <chen_gua_author_pass>0</chen_gua_author_pass>
                    <long_author_pass>2</long_author_pass>
                    <user_author_through>0</user_author_through>
                    <long_author_through>1</long_author_through>
                    <long_book_through>13</long_book_through>
                    <chen_gua_chapter_through>0</chen_gua_chapter_through>
                    <chen_gua_book_through>0</chen_gua_book_through>
                    <user_author_pass>0</user_author_pass>
                    <user_book_through>0</user_book_through>
                    <long_chapter_pass>0</long_chapter_pass>
                    <action_name>jason_zb</action_name>
                    <short_item_pass>1111</short_item_pass>
                    <short_item_reject>111111</short_item_reject>
                </item>
            </list>
        </data>
        <state>200</state>
        <message>ok</message>
    </result>
</alibaba_shuqi_original_backend_ognvwork_worklist_response>

{
    "alibaba_shuqi_original_backend_ognvwork_worklist_response":{
        "result":{
            "data":{
                "total":{
                    "user_chapter_pass":100,
                    "long_chapter_through":1873,
                    "chen_gua_book_pass":26,
                    "chen_gua_chapter_pass":9,
                    "chen_gua_author_through":73,
                    "user_chapter_through":19,
                    "long_book_pass":364,
                    "user_book_pass":19,
                    "chen_gua_author_pass":9,
                    "long_author_pass":241,
                    "user_author_through":2,
                    "long_author_through":705,
                    "long_book_through":1118,
                    "chen_gua_chapter_through":87,
                    "chen_gua_book_through":160,
                    "user_author_pass":2,
                    "user_book_through":13,
                    "long_chapter_pass":399,
                    "short_item_pass":111,
                    "short_item_reject":1111
                },
                "count":593,
                "page":593,
                "list":{
                    "item":[
                        {
                            "user_chapter_pass":0,
                            "cr_time":"2021-08-15",
                            "long_chapter_through":0,
                            "chen_gua_book_pass":0,
                            "chen_gua_chapter_pass":0,
                            "chen_gua_author_through":0,
                            "user_chapter_through":0,
                            "long_book_pass":3,
                            "user_book_pass":0,
                            "chen_gua_author_pass":0,
                            "long_author_pass":2,
                            "user_author_through":0,
                            "long_author_through":1,
                            "long_book_through":13,
                            "chen_gua_chapter_through":0,
                            "chen_gua_book_through":0,
                            "user_author_pass":0,
                            "user_book_through":0,
                            "long_chapter_pass":0,
                            "action_name":"jason_zb",
                            "short_item_pass":1111,
                            "short_item_reject":111111
                        }
                    ]
                }
            },
            "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.ognvwork.worklist (工作量统计)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ