文档中心 > API类目 > 天猫互动接口

alibaba.interact.activity.register (ISV互动应用活动注册服务)

为支持卖家由ISV互动应用可以在手淘店铺首页透出,提供ISV互动应用创建的活动注册到手淘的服务

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
entry_url String 必须 http|https://appName.play.m.jaeapp.com/context/path?p1=x&p2=y 页面内容链接,仅允许ascii字符
biz_id String 必须 123 活动ID
description String 可选 hello world 活动描述文字
end_time Date 可选 2014-09-22 17:04:13 活动结束时间
name String 必须 hello world 活动名称
picture String 可选 hello world 活动封面图片(非必填)
start_time Date 可选 2014-09-22 17:04:13 活动开始时间
has_valid_time Boolean 必须 false 是否有有效时间,若为真开始时间和结束时间必填,默认为真

响应参数

名称 类型 示例值 描述
register_sucess_info AllsparkResult 活动注册成功,将活动注册后的ID和h5链接返回给调用方
  • └ err_msg
  • String
  • hello world
  • 出错提示
  • └ err_code
  • String
  • hello world
  • 出错代码
  • data
  • ActivityWriteResult
  • 服务结果对象
  • └ activity_id
  • Number
  • 123
  • 注册成功ID
  • └ h5_url
  • String
  • hello world
  • 活动页面h5链接
  • └ success
  • Boolean
  • false
  • 是否注册成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaInteractActivityRegisterRequest req = new AlibabaInteractActivityRegisterRequest();
req.setEntryUrl("http|https://appName.play.m.jaeapp.com/context/path?p1=x&p2=y");
req.setBizId("123");
req.setDescription("hello world");
req.setEndTime(StringUtils.parseDateTime("2014-09-22 17:04:13"));
req.setName("hello world");
req.setPicture("hello world");
req.setStartTime(StringUtils.parseDateTime("2014-09-22 17:04:13"));
req.setHasValidTime(false);
AlibabaInteractActivityRegisterResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_interact_activity_register_response>
    <register_sucess_info>
        <err_msg>hello world</err_msg>
        <err_code>hello world</err_code>
        <data>
            <activity_id>123</activity_id>
            <h5_url>hello world</h5_url>
        </data>
        <success>false</success>
    </register_sucess_info>
</alibaba_interact_activity_register_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

FAQ

返回
顶部