淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
secret_signal_query	SecretSignalQuery	必须			请求信息
└ channel String 可选 msc 渠道名称，查搜索惊喜码可以不传

名称	类型	示例值	描述
result	SecretSignalDTO []		搜索惊喜码活动列表
└ id Number 123 活动Id └ name String 搜索惊喜码活动名称搜索惊喜码活动名称 └ key_word_list String [] single 搜索惊喜码词列表 └ status Number 1 活动状态：0为待运行，1为运行中 └ start_date Date 2023-01-01 00:00:00 开始时间 └ end_date Date 2023-02-01 00:00:00 结束时间 └ action_before_apply Number 1 领取钱要求：0无要求，1加关注 benefit BenefitDTO https://shop.m.taobao.com/shop/shopIndex.htm?shop_id=58498856 权益信息 └ title String 权益名称权益名称 └ start_price Number 1000 权益门槛，单位分 └ benefit_price Number 100 优惠金额，单位分 └ type_name String 惊喜码优惠券权益类型名称 └ start_time Date 2023-10-07 00:00:00 权益开始时间 └ end_time Date 2023-11-07 00:00:00 权益结束时间 └ item_list Number [] 商品列表 └ biz_id String 1234567 策略id
result_msg	String	参数异常	错误描述
result_code	String	1000	错误码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OpencrmMscQueryRequest req = new OpencrmMscQueryRequest();
OpencrmMscQueryRequest.SecretSignalQuery obj1 = new OpencrmMscQueryRequest.SecretSignalQuery();
obj1.setChannel("msc");
req.setSecretSignalQuery(obj1);
OpencrmMscQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
OpencrmMscQueryRequest req = new OpencrmMscQueryRequest();
OpencrmMscQueryRequest.SecretSignalQueryDomain obj1 = new OpencrmMscQueryRequest.SecretSignalQueryDomain();
obj1.Channel = "msc";
req.SecretSignalQuery_ = obj1;
OpencrmMscQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new OpencrmMscQueryRequest;
$secret_signal_query = new SecretSignalQuery;
$secret_signal_query->channel="msc";
$req->setSecretSignalQuery(json_encode($secret_signal_query));
$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.msc.query' \
-d 'partner_id=apidoc' \
-d 'session=9022bc23-2572-40d5-a8bd-bcc64f122e2d' \
-d 'sign=03DBC18EDC6203CC4CB55F333262690D' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-18+15%3A53%3A10' \
-d 'v=2.0' \
-d 'secret_signal_query=null'

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

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

req.secret_signal_query="数据结构示例JSON格式"
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.msc.query");
add_param(pRequest,"secret_signal_query","数据结构JSON示例");
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.msc.query', {
	'secret_signal_query':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<opencrm_msc_query_response>
    <result>
        <secret_signal_d_t_o>
            <id>123</id>
            <name>搜索惊喜码活动名称</name>
            <key_word_list>
                <string>single</string>
            </key_word_list>
            <status>1</status>
            <start_date>2023-01-01 00:00:00</start_date>
            <end_date>2023-02-01 00:00:00</end_date>
            <action_before_apply>1</action_before_apply>
            <benefit>
                <title>权益名称</title>
                <start_price>1000</start_price>
                <benefit_price>100</benefit_price>
                <type_name>惊喜码优惠券</type_name>
                <start_time>2023-10-07 00:00:00</start_time>
                <end_time>2023-11-07 00:00:00</end_time>
            </benefit>
            <biz_id>1234567</biz_id>
        </secret_signal_d_t_o>
    </result>
    <result_msg>参数异常</result_msg>
    <result_code>1000</result_code>
</opencrm_msc_query_response>

{
    "opencrm_msc_query_response":{
        "result":{
            "secret_signal_d_t_o":[
                {
                    "id":123,
                    "name":"搜索惊喜码活动名称",
                    "key_word_list":{
                        "string":[
                            "single"
                        ]
                    },
                    "status":1,
                    "start_date":"2023-01-01 00:00:00",
                    "end_date":"2023-02-01 00:00:00",
                    "action_before_apply":1,
                    "benefit":{
                        "title":"权益名称",
                        "start_price":1000,
                        "benefit_price":100,
                        "type_name":"惊喜码优惠券",
                        "start_time":"2023-10-07 00:00:00",
                        "end_time":"2023-11-07 00:00:00"
                    },
                    "biz_id":"1234567"
                }
            ]
        },
        "result_msg":"参数异常",
        "result_code":"1000"
    }
}

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.msc.query (搜索惊喜码查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ