文档中心 > API类目 > 客户运营平台API

taobao.opencrm.card.sms.single.send (C版用户卡片短信单点发送接口)

通过ouid列表发送短信卡片消息,最多100个

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
task_content ShortMessageDeliverTaskContent 必须 短息任务参数集合
  • └ tpl_plh
  • String
  • 可选
  • content
  • 聚石塔申请的短信模板占位符
  • └ deliver_targets
  • String []
  • 必须
  • ["123456","233445"]
  • ouid列表
  • └ signature
  • String
  • 必须
  • jinse01官方旗舰店
  • 短信签名
  • └ plh_val_short_link
  • String
  • 可选
  • t.cn
  • shortLink of placeholders(淘短链)
  • └ tpl_code
  • String
  • 可选
  • SMS_3385002
  • 聚石塔申请的短信模板Code
  • └ placeholders
  • String []
  • 可选
  • nick(对应plh_val_nick)
  • 短信模板占位符list只支持4种错一点都不行
  • └ out_node_inst_id
  • Number
  • 必须
  • 100015
  • 节点实例ID(回执信息唯一标志)
  • └ plh_val_point
  • Number
  • 可选
  • 1000
  • point of placeholders(买家积分)
  • └ plh_val
  • String
  • 可选
  • {"nick":"jinse01","point":"10","levelName":"普通会员","shortLink":"c.tb.cn/c.Kgsf"}
  • 需要传递的占位符对应的值(链接类占位符值必须通过这个参数传递)
  • └ plh_val_level_name
  • String
  • 可选
  • 至尊会员
  • levelName of placeholders(买家等级名称)
  • └ plh_val_nick
  • String
  • 可选
  • 知庸01
  • nick of placeholders(买家nick)
  • └ msg_type
  • Number
  • 必须
  • 1
  • 短信类型
  • └ mobile_acquisition_rule
  • String []
  • 可选
  • [3,1,2]
  • 自定义手机号获取规则
  • └ logistics_order_id_list
  • String []
  • 可选
  • ["233425645","233835645"]
  • 指定订单号列表
  • └ seller_tpl
  • String
  • 可选
  • 亲爱的${nick},兜家年货清仓五折起咯!
  • 回落数字短信内容
  • └ sms_up_extend_code
  • String
  • 可选
  • 12345
  • 短信拓展码
  • └ card_template_code
  • String
  • 可选
  • SMS_3385002
  • 卡片短信模板Code
  • └ card_template_param
  • String
  • 可选
  • {"name":"1111","time":"20210808121212"}
  • 卡片短信内容
  • └ fall_back_type
  • Number
  • 可选
  • 1
  • 卡片短信回落类型:0-不回落,1-回落普通短信,2-回落数字短信
  • └ template_id
  • String
  • 可选
  • 123456
  • 回落普通短信模板Id
  • └ custom_url
  • String
  • 可选
  • http://xxx
  • 卡片短信渲染失败后跳转链接
  • └ card_dync_params
  • String
  • 可选
  • 卡片短信占位符值散列
  • └ card_template_list
  • String []
  • 可选
  • ["1118234","1116237"]
  • 多模版推荐发送时卡片短信模板id列表,目前列表中的模版必须为富媒体短信模版申请通过的单图文和单商品卡片模版,且模版的占位符必须相同
  • └ digital_template_id
  • String
  • 可选
  • 1113236
  • 数字短信模版id, 选择回落数字短信使用,填写使用富媒体短信模版申请接口和数字短信模版申请接口通过的模版id
  • └ digital_template_list
  • String []
  • 可选
  • ["1113236","1112345"]
  • 选择回落数字短信,并且多模版推荐时使用,模版必须为富媒体短信模版申请通过的单图文和单商品数字模版,且模版的占位符必须相同

响应参数

名称 类型 示例值 描述
result Boolean false 是否成功生成单点投递任务
result_error_code String 90001 错误码
result_error_msg String 系统异常 报错信息
is_successed Boolean false 接口是否调用成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OpencrmCardSmsSingleSendRequest req = new OpencrmCardSmsSingleSendRequest();
OpencrmCardSmsSingleSendRequest.ShortMessageDeliverTaskContent obj1 = new OpencrmCardSmsSingleSendRequest.ShortMessageDeliverTaskContent();
obj1.setTplPlh("content");
obj1.setDeliverTargets(""123456","233445"");
obj1.setSignature("jinse01官方旗舰店");
obj1.setPlhValShortLink("t.cn");
obj1.setTplCode("SMS_3385002");
obj1.setPlaceholders("nick(对应plh_val_nick)");
obj1.setOutNodeInstId(100015L);
obj1.setPlhValPoint(1000L);
obj1.setPlhVal("{\"nick\":\"jinse01\",\"point\":\"10\",\"levelName\":\"普通会员\",\"shortLink\":\"c.tb.cn/c.Kgsf\"}");
obj1.setPlhValLevelName("至尊会员");
obj1.setPlhValNick("知庸01");
obj1.setMsgType(1L);
obj1.setMobileAcquisitionRule("3,1,2");
obj1.setLogisticsOrderIdList(""233425645","233835645"");
obj1.setSellerTpl("亲爱的${nick},兜家年货清仓五折起咯!");
obj1.setSmsUpExtendCode("12345");
obj1.setCardTemplateCode("SMS_3385002");
obj1.setCardTemplateParam("{\"name\":\"1111\",\"time\":\"20210808121212\"}");
obj1.setFallBackType(1L);
obj1.setTemplateId("123456");
obj1.setCustomUrl("http://xxx");
obj1.setCardDyncParams("");
obj1.setCardTemplateList(""1118234","1116237"");
obj1.setDigitalTemplateId("1113236");
obj1.setDigitalTemplateList(""1113236","1112345"");
req.setTaskContent(obj1);
OpencrmCardSmsSingleSendResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<opencrm_card_sms_single_send_response>
    <result>false</result>
    <result_error_code>90001</result_error_code>
    <result_error_msg>系统异常</result_error_msg>
    <is_successed>false</is_successed>
</opencrm_card_sms_single_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

返回
顶部