淘宝开放平台

登录
文档中心 > API类目 > 驿马前台api

驿马前台api

cainiao.yima.dispatch.notification.gettip (派件通知活动提示)

获取派件通知活动

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
user_id Number 必须 40921 小件员ID
session_code String 必须 123wq 小件员sessionID

响应参数

名称 类型 示例值 描述
data YmDispatchTipDto demo data
  • └ dispatch_tip
  • String
  • 优惠活动
  • 活动内容
  • └ dispatch_tip_link
  • String
  • http://www.taobao.com
  • 活动链接
  • └ need_show
  • Boolean
  • true
  • 是否显示活动
status_code String demo 状态码
status_message String demo 状态信息
is_success Boolean false 是否成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
1
2
3
4
5
6
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoYimaDispatchNotificationGettipRequest req = new CainiaoYimaDispatchNotificationGettipRequest();
req.setUserId(40921L);
req.setSessionCode("123wq");
CainiaoYimaDispatchNotificationGettipResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
1
2
3
4
5
6
7
8
9
10
<cainiao_yima_dispatch_notification_gettip_response>
    <data>
        <dispatch_tip>优惠活动</dispatch_tip>
        <dispatch_tip_link>http://www.taobao.com</dispatch_tip_link>
        <need_show>true</need_show>
    </data>
    <status_code>demo</status_code>
    <status_message>demo</status_message>
    <is_success>false</is_success>
</cainiao_yima_dispatch_notification_gettip_response>

异常示例

  • XML示例
  • JSON示例
1
2
3
4
5
6
<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

我要提问
返回
顶部