文档中心 > API类目 > 聚石塔API

taobao.jst.sms.message.send (聚石塔数据paas短信发送接口)

聚石塔短信PAAS场景中,ISV通过该API帮商家发送短信给用户。

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
send_message_request SendMessageRequest 可选 短信发送请求
  • └ extend_name
  • String
  • 可选
  • 123
  • 拓展Name
  • └ extend_code
  • String
  • 可选
  • 123
  • 拓展Code
  • └ sms_free_sign_name
  • String
  • 必须
  • 聚石塔官方
  • 短信签名
  • └ channel_type
  • String
  • 可选
  • 2
  • 默认值:2
  • 渠道类型
  • └ template_code
  • String
  • 必须
  • SMS_12345
  • 短信模版Code
  • └ params
  • 可选
  • {"content":"您好! ${url}"}
  • 短信内容参数, ${url}会被入参url的值替换掉
  • └ url
  • String
  • 可选
  • https://m.taobao.com
  • 商品H5详情页,如果不传则没有短信效果数据
  • └ extend
  • String
  • 可选
  • 123
  • 拓展信息
  • └ phone_number
  • String
  • 必须
  • 1234567890
  • 手机号码
  • └ tag
  • String
  • 可选
  • 123
  • 短信人群tag
  • └ batch_number
  • String
  • 可选
  • 1
  • 短信批次号
  • └ sms_type
  • String
  • 可选
  • normal
  • 默认值:normal
  • 短信类型
  • └ tool_flag
  • String
  • 可选
  • 0
  • 默认值:0
  • 标记字段

响应参数

名称 类型 示例值 描述
request_code String params_error 参数错误
request_success Boolean true 请求成功
request_id String 1234 1234
module String null
message String 参数错误 参数错误

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
JstSmsMessageSendRequest req = new JstSmsMessageSendRequest();
JstSmsMessageSendRequest.SendMessageRequest obj1 = new JstSmsMessageSendRequest.SendMessageRequest();
obj1.setExtendName("123");
obj1.setExtendCode("123");
obj1.setSmsFreeSignName("聚石塔官方");
obj1.setChannelType("2");
obj1.setTemplateCode("SMS_12345");
obj1.setUrl("https://m.taobao.com");
obj1.setExtend("123");
obj1.setPhoneNumber("1234567890");
obj1.setTag("123");
obj1.setBatchNumber("1");
obj1.setSmsType("normal");
obj1.setToolFlag("0");
req.setSendMessageRequest(obj1);
JstSmsMessageSendResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<jst_sms_message_send_response>
    <request_code>params_error</request_code>
    <request_success>true</request_success>
    <request_id>1234</request_id>
    <module>null</module>
    <message>参数错误</message>
</jst_sms_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

返回
顶部