文档中心 > API类目 > 天猫精灵开放API

alibaba.ai.content.business.send.plan.query (内容商业化发放权益查询)

天猫精灵内容生态的权益查询

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
param0	PurchaseForOuterDTO	必须			入参对象
└ isv_user_info_map String 必须 {} isv用户信息(userId和phone) circle_info PurchaseCircleInfoForOuterDTO 必须 {} 圈选对象 └ circle_content String 必须 ass 圈选内容 └ circle_id Number 必须 1 圈选标识id,由采销系统分配 └ isv_id Number 必须 1 isvId,由采销系统分配

响应参数

名称	类型	示例值	描述
ret_value	PurchaseSendPlanDTO []	{}	出参对象
└ name String 月卡发放活动名称 └ start_time Date 2021-09-03 00:00:00 活动开始时间 └ end_time Date 2021-09-05 00:00:00 活动结束时间 └ receive_rule String {"countLimit":1} 领取规则 └ purchase_item_info String [{"consumeInventory":1,"id":1,"itemConsumeInventory":8,"itemTotalInventory":10,"name":"爱奇艺月卡","weight":2},{"id":2,"name":"优酷月卡","weight":3}] 商品信息 └ id Number 1 活动id
ret_code	Number	1	错误码
ret_msg	String	系统错误	错误信息

请求示例

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAiContentBusinessSendPlanQueryRequest req = new AlibabaAiContentBusinessSendPlanQueryRequest();
AlibabaAiContentBusinessSendPlanQueryRequest.PurchaseForOuterDTO obj1 = new AlibabaAiContentBusinessSendPlanQueryRequest.PurchaseForOuterDTO();
obj1.setIsvUserInfoMap("{}");
AlibabaAiContentBusinessSendPlanQueryRequest.PurchaseCircleInfoForOuterDTO obj2 = new AlibabaAiContentBusinessSendPlanQueryRequest.PurchaseCircleInfoForOuterDTO();
obj2.setCircleContent("ass");
obj2.setCircleId(1L);
obj1.setCircleInfo(obj2);
obj1.setIsvId(1L);
req.setParam0(obj1);
AlibabaAiContentBusinessSendPlanQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

XML示例
JSON示例

<alibaba_ai_content_business_send_plan_query_response>
    <ret_value>
        <purchase_send_plan_d_t_o>
            <name>月卡</name>
            <start_time>2021-09-03 00:00:00</start_time>
            <end_time>2021-09-05 00:00:00</end_time>
            <receive_rule>{&quot;countLimit&quot;:1}</receive_rule>
            <purchase_item_info>[{&quot;consumeInventory&quot;:1,&quot;id&quot;:1,&quot;itemConsumeInventory&quot;:8,&quot;itemTotalInventory&quot;:10,&quot;name&quot;:&quot;爱奇艺月卡&quot;,&quot;weight&quot;:2},{&quot;id&quot;:2,&quot;name&quot;:&quot;优酷月卡&quot;,&quot;weight&quot;:3}]</purchase_item_info>
            <id>1</id>
        </purchase_send_plan_d_t_o>
    </ret_value>
    <ret_code>1</ret_code>
    <ret_msg>系统错误</ret_msg>
</alibaba_ai_content_business_send_plan_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工具

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

如何获得此API

FAQ

我要提问

返回
顶部