淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
template_id	Number	必须	123456	卡片短信模板id
start_date	String	必须	2022-02-28 12:00:00	起始时间，不能早于当前时间90天 yyyy-MM-dd HH:mm:ss格式
end_date	String	必须	2022-02-29 12:00:00	结束时间，不能早于当前时间90天，且起始于结束与起始之间的间隔不能超过90天 yyyy-MM-dd HH:mm:ss格式

名称	类型	示例值	描述
result	Result	统一返回对象	统一返回对象
data CardEffectDataDTO [] 返回数据 └ date Number 20220228 数据日期，格式为：yyyyMMdd └ rpt_success_count Number 123 智能短信解析回执成功数 └ expose_uv Number 123 消息曝光数 └ expose_pv Number 123 消息曝光次数 └ click_uv Number 123 消息点击数 └ click_pv Number 123 消息点击次数 └ code String 1001 错误码 └ msg String 未知错误错误描述

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OpencrmCardEffectDataYtxRequest req = new OpencrmCardEffectDataYtxRequest();
req.setTemplateId(123456L);
req.setStartDate("2022-02-28 12:00:00");
req.setEndDate("2022-02-29 12:00:00");
OpencrmCardEffectDataYtxResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
OpencrmCardEffectDataYtxRequest req = new OpencrmCardEffectDataYtxRequest();
req.TemplateId = 123456L;
req.StartDate = "2022-02-28 12:00:00";
req.EndDate = "2022-02-29 12:00:00";
OpencrmCardEffectDataYtxResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new OpencrmCardEffectDataYtxRequest;
$req->setTemplateId("123456");
$req->setStartDate("2022-02-28 12:00:00");
$req->setEndDate("2022-02-29 12:00:00");
$resp = $c->execute($req, $sessionKey);

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=taobao.opencrm.card.effect.data.ytx' \
-d 'partner_id=apidoc' \
-d 'session=30461ab3-4f85-4705-ab25-615d700b4e57' \
-d 'sign=E4ABFDC504D64A49084A96C26446DC50' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-18+16%3A10%3A18' \
-d 'v=2.0' \
-d 'end_date=2022-02-29+12%3A00%3A00' \
-d 'start_date=2022-02-28+12%3A00%3A00' \
-d 'template_id=123456'

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

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

req.template_id=123456
req.start_date="2022-02-28 12:00:00"
req.end_date="2022-02-29 12:00:00"
try:
	resp= req.getResponse(sessionkey)
	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,"taobao.opencrm.card.effect.data.ytx");
add_param(pRequest,"template_id","123456");
add_param(pRequest,"start_date","2022-02-28 12:00:00");
add_param(pRequest,"end_date","2022-02-29 12:00:00");
pResponse = top_execute(pClient,pRequest,sessionKey);
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('taobao.opencrm.card.effect.data.ytx', {
	'template_id':'123456',
	'start_date':'2022-02-28 12:00:00',
	'end_date':'2022-02-29 12:00:00'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<opencrm_card_effect_data_ytx_response>
    <result>
        <data>
            <card_effect_data_d_t_o>
                <date>20220228</date>
                <rpt_success_count>123</rpt_success_count>
                <expose_uv>123</expose_uv>
                <expose_pv>123</expose_pv>
                <click_uv>123</click_uv>
                <click_pv>123</click_pv>
            </card_effect_data_d_t_o>
        </data>
        <code>1001</code>
        <msg>未知错误</msg>
    </result>
</opencrm_card_effect_data_ytx_response>

{
    "opencrm_card_effect_data_ytx_response":{
        "result":{
            "data":{
                "card_effect_data_d_t_o":[
                    {
                        "date":20220228,
                        "rpt_success_count":123,
                        "expose_uv":123,
                        "expose_pv":123,
                        "click_uv":123,
                        "click_pv":123
                    }
                ]
            },
            "code":"1001",
            "msg":"未知错误"
        }
    }
}

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

taobao.opencrm.card.effect.data.ytx (卡片消息会话窗口中效果数据)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ