文档中心 > API类目 > 菜鸟无线API

cainiao.yima.delivery.msg.template.querybyid (单个模板查询)

单个模板查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
template_id Number 可选 12321 模板id
personal_session String 可选 fsd sessionCode
personal_user_id Number 可选 4398618530740 小件员个人账号
source String 可选 COLLECT 调用来源

响应参数

名称 类型 示例值 描述
status_code String 业务错误码
data DeliveryMsgTemplateDto data
  • └ template_id
  • Number
  • 522423
  • 模板id
  • └ content
  • String
  • 您的快递到了
  • 模板内容
  • └ title
  • String
  • 测试模板
  • 名称
is_success Boolean true 成功与否
status_message String ERROR 错误信息
trace_id String faffafa 鹰眼id

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoYimaDeliveryMsgTemplateQuerybyidRequest req = new CainiaoYimaDeliveryMsgTemplateQuerybyidRequest();
req.setTemplateId(12321L);
req.setPersonalSession("fsd");
req.setPersonalUserId(4398618530740L);
req.setSource("COLLECT");
CainiaoYimaDeliveryMsgTemplateQuerybyidResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<cainiao_yima_delivery_msg_template_querybyid_response>
    <status_code></status_code>
    <data>
        <template_id>522423</template_id>
        <content>您的快递到了</content>
        <title>测试模板</title>
    </data>
    <is_success>true</is_success>
    <status_message>ERROR</status_message>
    <trace_id>faffafa</trace_id>
</cainiao_yima_delivery_msg_template_querybyid_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

返回
顶部