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

taobao.opencrm.sms.crowd.send (C版用户人群短信发送接口)

发送短信接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
task_content ShortMessageDeliverTaskContent 必须 任务内容
  • └ tpl_code
  • String
  • 可选
  • SMS_3385002
  • 短信模板Code
  • └ tpl_plh
  • String
  • 可选
  • content
  • 短信模板占位符
  • └ deliver_targets
  • String []
  • 可选
  • ["18600238902","18600238920"]
  • 测试短信才用测试手机号
  • └ out_node_inst_id
  • Number
  • 可选
  • 4001
  • 节点实例ID
  • └ crowd_mode
  • Boolean
  • 必须
  • true
  • 人群模式
  • └ crowd_inst_id
  • Number
  • 可选
  • 6001
  • 人群实例ID
  • └ signature
  • String
  • 必须
  • jinse01官方旗舰店
  • 短信签名
  • └ plh_val
  • String
  • 可选
  • {"nick":"jinse01","point":"10","levelName":"普通会员","shortLink":"c.tb.cn/c.Kgsf"}
  • 卖家设置的短信模板占位符值
  • └ msg_type
  • Number
  • 必须
  • 1
  • 短信类型
  • └ mobile_acquisition_rule
  • String []
  • 可选
  • [3,1,2]
  • 自定义手机号获取规则
  • └ template_id
  • String
  • 可选
  • 11111111
  • 模板id
  • └ sms_up_extend_code
  • String
  • 可选
  • 12345
  • 短信拓展码
  • └ extend_name
  • String
  • 可选
  • XXX天猫期舰店
  • 短信拓展名称
  • └ seller_tpl
  • String
  • 可选
  • 亲爱的${nick},兜家年货清仓五折起咯!爆款超低折扣,领券再减折上折,更有满返优惠券等你拿!就一个字:值!赶紧加购吧!
  • 测试短信内容模板

响应参数

名称 类型 示例值 描述
result NodeExecuteReportDto 非人群模式的发送报告
  • └ coupon_un_use_count
  • Number
  • 1000
  • couponUnUseCount
  • └ coupon_used_count
  • Number
  • 200
  • couponUsedCount
  • └ coupon_using_count
  • Number
  • 800
  • couponUsingCount
  • └ fail_bill_count
  • Number
  • 40
  • failBillCount
  • └ fail_count
  • Number
  • 20
  • failCount
  • └ fail_statistics
  • String
  • {}
  • failStatistics
  • └ limited_count
  • Number
  • 5
  • limitedCount
  • └ node_inst_id
  • Number
  • 4001
  • nodeInstId
  • └ short_link_click_pv
  • Number
  • 1000
  • shortLinkClickPv
  • └ short_link_click_uv
  • Number
  • 500
  • shortLinkClickUv
  • └ success_bill_count
  • Number
  • 200
  • successBillCount
  • └ success_count
  • Number
  • 100
  • successCount
  • └ total_count
  • Number
  • 1000
  • totalCount
  • └ unknown_status_bill_count
  • Number
  • 20
  • unknownStatusBillCount
  • └ unknown_status_count
  • Number
  • 10
  • unknownStatusCount

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OpencrmSmsCrowdSendRequest req = new OpencrmSmsCrowdSendRequest();
OpencrmSmsCrowdSendRequest.ShortMessageDeliverTaskContent obj1 = new OpencrmSmsCrowdSendRequest.ShortMessageDeliverTaskContent();
obj1.setTplCode("SMS_3385002");
obj1.setTplPlh("content");
obj1.setDeliverTargets(""18600238902","18600238920"");
obj1.setOutNodeInstId(4001L);
obj1.setCrowdMode(true);
obj1.setCrowdInstId(6001L);
obj1.setSignature("jinse01官方旗舰店");
obj1.setPlhVal("{\"nick\":\"jinse01\",\"point\":\"10\",\"levelName\":\"普通会员\",\"shortLink\":\"c.tb.cn/c.Kgsf\"}");
obj1.setMsgType(1L);
obj1.setMobileAcquisitionRule("3,1,2");
obj1.setTemplateId("11111111");
obj1.setSmsUpExtendCode("12345");
obj1.setExtendName("XXX天猫期舰店");
obj1.setSellerTpl("亲爱的${nick},兜家年货清仓五折起咯!爆款超低折扣,领券再减折上折,更有满返优惠券等你拿!就一个字:值!赶紧加购吧!");
req.setTaskContent(obj1);
OpencrmSmsCrowdSendResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<opencrm_sms_crowd_send_response>
    <result>
        <coupon_un_use_count>1000</coupon_un_use_count>
        <coupon_used_count>200</coupon_used_count>
        <coupon_using_count>800</coupon_using_count>
        <fail_bill_count>40</fail_bill_count>
        <fail_count>20</fail_count>
        <fail_statistics>{}</fail_statistics>
        <limited_count>5</limited_count>
        <node_inst_id>4001</node_inst_id>
        <short_link_click_pv>1000</short_link_click_pv>
        <short_link_click_uv>500</short_link_click_uv>
        <success_bill_count>200</success_bill_count>
        <success_count>100</success_count>
        <total_count>1000</total_count>
        <unknown_status_bill_count>20</unknown_status_bill_count>
        <unknown_status_count>10</unknown_status_count>
    </result>
</opencrm_sms_crowd_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

返回
顶部