淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
top_query_user_task_param	TopQueryUserTaskParam	可选			请求参数
└ mix_task_id String 必须 task_rzb496g528mgs7bk4gwujde5b4t05p5hqrarh 加密任务ID └ mix_user_id String 必须 Bp2SScWC4KSMOAEM6NwZCA== 加密用户ID └ user_agent String 可选 Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.5410.0 Safari/537.36 浏览器UA └ ip_address String 可选 127.0.0.1 用户Ip地址 └ domain_id Number 可选 1 账号所属域 └ business String 可选 TENCENT 请求业务方

名称	类型	示例值	描述
return_value	TaskDetailResult		返回值
└ real_user Boolean true 是否真实用户 └ risk_user Boolean true 是否风控用户 └ task_record_count Number 10 用户任务完成次数 └ task_start_time Date 2024-12-12 18:00:00 任务开始时间 └ task_end_time Date 2024-12-12 19:00:00 任务结束时间
return_error_stack_trace	String	系统异常	returnErrorStackTrace
return_message	String	解密任务ID失败	错误描述
return_error_oper	String	taobao	returnErrorOper
return_error_solution	String	请重试	returnErrorSolution
retuen_code	String	DECRYPT_TASK_ID_FAILED	错误码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaDamaiPerformTfinteractionTaskQueryRequest req = new AlibabaDamaiPerformTfinteractionTaskQueryRequest();
AlibabaDamaiPerformTfinteractionTaskQueryRequest.TopQueryUserTaskParam obj1 = new AlibabaDamaiPerformTfinteractionTaskQueryRequest.TopQueryUserTaskParam();
obj1.setMixTaskId("task_rzb496g528mgs7bk4gwujde5b4t05p5hqrarh");
obj1.setMixUserId("Bp2SScWC4KSMOAEM6NwZCA==");
obj1.setUserAgent("Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.5410.0 Safari/537.36");
obj1.setIpAddress("127.0.0.1");
obj1.setDomainId(1L);
obj1.setBusiness("TENCENT");
req.setTopQueryUserTaskParam(obj1);
AlibabaDamaiPerformTfinteractionTaskQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaDamaiPerformTfinteractionTaskQueryRequest req = new AlibabaDamaiPerformTfinteractionTaskQueryRequest();
AlibabaDamaiPerformTfinteractionTaskQueryRequest.TopQueryUserTaskParamDomain obj1 = new AlibabaDamaiPerformTfinteractionTaskQueryRequest.TopQueryUserTaskParamDomain();
obj1.MixTaskId = "task_rzb496g528mgs7bk4gwujde5b4t05p5hqrarh";
obj1.MixUserId = "Bp2SScWC4KSMOAEM6NwZCA==";
obj1.UserAgent = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.5410.0 Safari/537.36";
obj1.IpAddress = "127.0.0.1";
obj1.DomainId = 1L;
obj1.Business = "TENCENT";
req.TopQueryUserTaskParam_ = obj1;
AlibabaDamaiPerformTfinteractionTaskQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaDamaiPerformTfinteractionTaskQueryRequest;
$top_query_user_task_param = new TopQueryUserTaskParam;
$top_query_user_task_param->mix_task_id="task_rzb496g528mgs7bk4gwujde5b4t05p5hqrarh";
$top_query_user_task_param->mix_user_id="Bp2SScWC4KSMOAEM6NwZCA==";
$top_query_user_task_param->user_agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.5410.0 Safari/537.36";
$top_query_user_task_param->ip_address="127.0.0.1";
$top_query_user_task_param->domain_id="1";
$top_query_user_task_param->business="TENCENT";
$req->setTopQueryUserTaskParam(json_encode($top_query_user_task_param));
$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.damai.perform.tfinteraction.task.query' \
-d 'partner_id=apidoc' \
-d 'sign=35F4EF4415DC22865ECB8232A93B05E4' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-08+05%3A20%3A00' \
-d 'v=2.0' \
-d 'top_query_user_task_param=null'

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

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

req.top_query_user_task_param="数据结构示例JSON格式"
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.damai.perform.tfinteraction.task.query");
add_param(pRequest,"top_query_user_task_param","数据结构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',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.damai.perform.tfinteraction.task.query', {
	'top_query_user_task_param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_damai_perform_tfinteraction_task_query_response>
    <return_value>
        <real_user>true</real_user>
        <risk_user>true</risk_user>
        <task_record_count>10</task_record_count>
        <task_start_time>2024-12-12 18:00:00</task_start_time>
        <task_end_time>2024-12-12 19:00:00</task_end_time>
    </return_value>
    <return_error_stack_trace>系统异常</return_error_stack_trace>
    <return_message>解密任务ID失败</return_message>
    <return_error_oper>taobao</return_error_oper>
    <return_error_solution>请重试</return_error_solution>
    <retuen_code>DECRYPT_TASK_ID_FAILED</retuen_code>
</alibaba_damai_perform_tfinteraction_task_query_response>

{
    "alibaba_damai_perform_tfinteraction_task_query_response":{
        "return_value":{
            "real_user":true,
            "risk_user":true,
            "task_record_count":10,
            "task_start_time":"2024-12-12 18:00:00",
            "task_end_time":"2024-12-12 19:00:00"
        },
        "return_error_stack_trace":"系统异常",
        "return_message":"解密任务ID失败",
        "return_error_oper":"taobao",
        "return_error_solution":"请重试",
        "retuen_code":"DECRYPT_TASK_ID_FAILED"
    }
}

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.damai.perform.tfinteraction.task.query (任务完成进度查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ