淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
free_mobile_query	FreeMobileQuery	可选			查询入参
└ app_name String 必须 youku 应用名 └ isp_code String 必须 unicom 运营商编码 └ phone_number String 必须 18668209772 手机号 └ from_user_code String 必须 YKFreeFlowSDK 业务方code └ user_nick String 可选张三淘宝会员名 └ user_id String 可选 123123 淘宝会员id └ imsi String 可选 86212312312921 卡号

名称	类型	示例值	描述
result	CommonResult	result	result
model FreeFlowStatusDto model model └ ext_data String {"a":"12312"} extData └ can_receive_rights_list String [] 1,2 canReceiveRightsList └ rights_list String [] 1,2 rightsList └ date Date null Date └ cached Boolean true cached └ effective_time Date null effectiveTime └ card_type String aliBaoCard cardType └ isp_code String unicom ispCode └ phone_number String 1818668209772 phoneNumber └ desc String 成功 desc └ code String IE001 code └ success Boolean true success

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaWttAlicardYoukuFreeflowGetRequest req = new AlibabaWttAlicardYoukuFreeflowGetRequest();
AlibabaWttAlicardYoukuFreeflowGetRequest.FreeMobileQuery obj1 = new AlibabaWttAlicardYoukuFreeflowGetRequest.FreeMobileQuery();
obj1.setAppName("youku");
obj1.setIspCode("unicom");
obj1.setPhoneNumber("18668209772");
obj1.setFromUserCode("YKFreeFlowSDK");
obj1.setUserNick("张三");
obj1.setUserId("123123");
obj1.setImsi("86212312312921");
req.setFreeMobileQuery(obj1);
AlibabaWttAlicardYoukuFreeflowGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaWttAlicardYoukuFreeflowGetRequest req = new AlibabaWttAlicardYoukuFreeflowGetRequest();
AlibabaWttAlicardYoukuFreeflowGetRequest.FreeMobileQueryDomain obj1 = new AlibabaWttAlicardYoukuFreeflowGetRequest.FreeMobileQueryDomain();
obj1.AppName = "youku";
obj1.IspCode = "unicom";
obj1.PhoneNumber = "18668209772";
obj1.FromUserCode = "YKFreeFlowSDK";
obj1.UserNick = "张三";
obj1.UserId = "123123";
obj1.Imsi = "86212312312921";
req.FreeMobileQuery_ = obj1;
AlibabaWttAlicardYoukuFreeflowGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaWttAlicardYoukuFreeflowGetRequest;
$free_mobile_query = new FreeMobileQuery;
$free_mobile_query->app_name="youku";
$free_mobile_query->isp_code="unicom";
$free_mobile_query->phone_number="18668209772";
$free_mobile_query->from_user_code="YKFreeFlowSDK";
$free_mobile_query->user_nick="张三";
$free_mobile_query->user_id="123123";
$free_mobile_query->imsi="86212312312921";
$req->setFreeMobileQuery(json_encode($free_mobile_query));
$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.wtt.alicard.youku.freeflow.get' \
-d 'partner_id=apidoc' \
-d 'sign=364D453D368A3FD75BA76D7D5BF412C4' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-06+12%3A35%3A22' \
-d 'v=2.0' \
-d 'free_mobile_query=null'

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

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

req.free_mobile_query=""
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.wtt.alicard.youku.freeflow.get");
add_param(pRequest,"free_mobile_query","数据结构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.wtt.alicard.youku.freeflow.get', {
	'free_mobile_query':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_wtt_alicard_youku_freeflow_get_response>
    <result>
        <model>
            <ext_data>{&quot;a&quot;:&quot;12312&quot;}</ext_data>
            <can_receive_rights_list>
                <string>1</string>
                <string>2</string>
            </can_receive_rights_list>
            <rights_list>
                <string>1</string>
                <string>2</string>
            </rights_list>
            <date>null</date>
            <cached>true</cached>
            <effective_time>null</effective_time>
            <card_type>aliBaoCard</card_type>
            <isp_code>unicom</isp_code>
            <phone_number>1818668209772</phone_number>
        </model>
        <desc>成功</desc>
        <code>IE001</code>
        <success>true</success>
    </result>
</alibaba_wtt_alicard_youku_freeflow_get_response>

{
    "alibaba_wtt_alicard_youku_freeflow_get_response":{
        "result":{
            "model":{
                "ext_data":"{\"a\":\"12312\"}",
                "can_receive_rights_list":{
                    "string":[
                        "1",
                        "2"
                    ]
                },
                "rights_list":{
                    "string":[
                        "1",
                        "2"
                    ]
                },
                "date":"null",
                "cached":true,
                "effective_time":"null",
                "card_type":"aliBaoCard",
                "isp_code":"unicom",
                "phone_number":"1818668209772"
            },
            "desc":"成功",
            "code":"IE001",
            "success":true
        }
    }
}

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.wtt.alicard.youku.freeflow.get (优酷免流查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ