文档中心 > API类目 > 手淘开放API

taobao.logistics.taowai.msg.send (淘外包裹物流信息走淘宝发包裹状态通知接口)

淘外包裹物流信息走淘宝发包裹状态通知接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
taowai_msg_send_request TaowaiMsgSendRequest 可选 请求对象
  • └ cp_code
  • String
  • 必须
  • ZTO
  • 快递公司编码
  • └ mail_no
  • String
  • 必须
  • 78637917732601
  • 运单号
  • └ occur_time
  • Number
  • 可选
  • 1669622596000
  • 发生时间
  • └ ext_params
  • String
  • 可选
  • { "supportHomeArrived": "true", }
  • 扩展参数
  • └ openid
  • String
  • 可选
  • XXXX
  • openid
  • └ logistics_status
  • String
  • 必须
  • TRANSPORT
  • 物流状态 揽收 发货 运输 签收等
  • └ scene
  • Number
  • 必须
  • 1
  • 1-查件 2-寄件
  • └ mobile_phone
  • String
  • 必须
  • 13374890278
  • 移动电话

响应参数

名称 类型 示例值 描述
result_msg String 参数异常 错误提示
result MsgSendResponse 对象
  • └ operate_time
  • Number
  • 99920000
  • 发送操作执行时间
  • └ sms_success
  • Boolean
  • true
  • 短信发送是否成功
  • └ sms_error_code
  • String
  • exceedLimit
  • 短信发送失败结果码(成功情况无需关注)
  • └ msg_push_success
  • Boolean
  • true
  • 交易物流消息是否发送成功
  • └ msg_push_error_code
  • String
  • exceedLimit
  • 交易物流消息发送失败结果码(成功情况无需关注)
result_code String UNKNOW_RRROR 错误码
result_success Boolean true 通讯成功/通讯失败

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LogisticsTaowaiMsgSendRequest req = new LogisticsTaowaiMsgSendRequest();
LogisticsTaowaiMsgSendRequest.TaowaiMsgSendRequest obj1 = new LogisticsTaowaiMsgSendRequest.TaowaiMsgSendRequest();
obj1.setCpCode("ZTO");
obj1.setMailNo("78637917732601");
obj1.setOccurTime(1669622596000L);
obj1.setExtParams("{ 	\"supportHomeArrived\": \"true\", }");
obj1.setOpenid("XXXX");
obj1.setLogisticsStatus("TRANSPORT");
obj1.setScene(1L);
obj1.setMobilePhone("13374890278");
req.setTaowaiMsgSendRequest(obj1);
LogisticsTaowaiMsgSendResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<logistics_taowai_msg_send_response>
    <result_msg>参数异常</result_msg>
    <result>
        <operate_time>99920000</operate_time>
        <sms_success>true</sms_success>
        <sms_error_code>exceedLimit</sms_error_code>
        <msg_push_success>true</msg_push_success>
        <msg_push_error_code>exceedLimit</msg_push_error_code>
    </result>
    <result_code>UNKNOW_RRROR</result_code>
    <result_success>true</result_success>
</logistics_taowai_msg_send_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>

错误码解释

错误码 错误描述 解决方案
isv.SystemError 系统错误 重试

API工具

如何获得此API

FAQ

返回
顶部