注意:以下文档只适用于TOP接口,请谨慎使用!

文档中心 > API类目 > 千牛接口

taobao.tpn.template.message.send (发送tpn模板消息)

发送千牛模板消息

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
template_key String 必须 xxxx 模板分配的key, 模版详情最下面配置信息里的 消息key,模版拥有者可见,日常预发线上都是同一个
mobile_biz_data Json 可选 {"key1":"value","key2":123} 移动端通用协议字段,移动和PC 协议参数一样时,可以不传, 默认会用bizData字段, 移动端不一样使用这个字段
biz_data Json 可选 {"key1":"value","key2":123} PC端消息查看详情动作,需要的业务数据,详细字段含义见:打开网址 https://jindoucloud.taobao.com/doc/detail?id=24,打开插件 https://jindoucloud.taobao.com/doc/detail?id=20;如果action是打开网址,url必须填写 bizData.put("page", "https://www.taobao.com"); 如果action是打开插件,插件页面,和页面参数要带上; 举例: 打开插件详情页 qap://detail.js,页面参数 id=123,bizData.put("page", "{ \"url\": \"qap://detail.js\", \"capability\": \"questionDetail\"}"); bizData.put("extraData", "{\"id\":\"123\"}");具体要什么参数和插件开发前端协商参数, 这个map提供参数设置;
template_id Number 必须 101 模板ID
picture String 可选 http://xxx 移动显示的缩略图(要符合移动端规范)
pict String 可选 http://xxx PC端显示的大图
user_id Number 必须 12345 主账号ID
sub_user_id Number 可选 123456 子账号ID
title_param Json 可选 {"key1":"value","key2":123} 消息标题参数, 和模板里的参数名一一对应
biz_id Number 必须 122323434545 业务方业务id,同一个用户bizId不要相同,相同会消息覆盖,可拿该id排查发送情况,如果没有可用时间戳(重要排查依据,没有bizId,千牛也没法排查问题)
content_param Json 可选 {"key1":"value","key2":123} 消息内容参数

响应参数

名称 类型 示例值 描述
result String 1234567890 消息ID
error_msg String Invalid-parameter 错误提示
is_success Boolean true 是否发送成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TpnTemplateMessageSendRequest req = new TpnTemplateMessageSendRequest();
req.setTemplateKey("xxxx");
req.setMobileBizDataString("{\"key1\":\"value\",\"key2\":123}");
req.setBizDataString("{\"key1\":\"value\",\"key2\":123}");
req.setTemplateId(101L);
req.setPicture("http://xxx");
req.setPict("http://xxx");
req.setUserId(12345L);
req.setSubUserId(123456L);
req.setTitleParamString("{\"key1\":\"value\",\"key2\":123}");
req.setBizId(122323434545L);
req.setContentParamString("{\"key1\":\"value\",\"key2\":123}");
TpnTemplateMessageSendResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<tpn_template_message_send_response>
    <result>1234567890</result>
    <error_msg>Invalid-parameter</error_msg>
    <is_success>true</is_success>
</tpn_template_message_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>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部