淘宝开放平台

请求地址：

环境	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());

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>

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>

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

客户运营平台API

taobao.opencrm.msc.query (搜索惊喜码查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ