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

taobao.jst.sms.oaid.message.send (基于OAID的短信发送接口)

基于OAID的短信发送接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
param_send_message_by_o_a_i_d_request SendMessageByOaidRequest 必须 单个OAID发送短信的入参
  • └ extend_name
  • String
  • 可选
  • 12345
  • 拓展Name
  • └ order_id
  • String
  • 必须
  • 1590159531380428537
  • 订单号
  • └ extend_code
  • String
  • 可选
  • 12345
  • 拓展Code
  • └ sms_free_sign_name
  • String
  • 必须
  • 聚石塔测试签名
  • 短信签名
  • └ template_code
  • String
  • 必须
  • SMS_12345
  • 短信模板
  • └ params
  • 可选
  • {"content":"您好! "}
  • 短信占位符,替换短信模板里的占位符
  • └ extend
  • String
  • 可选
  • 123
  • 拓展信息
  • └ oaid
  • String
  • 必须
  • 3mwdUE03cfGGuH4A4DrWWjcL8lxkl3bH29SM1RHqDNo5RgXYTdCQj1ZMN8wbv7qnLeiX6Dr
  • OAID
  • └ additional_info
  • Boolean
  • 可选
  • true
  • 默认值:false
  • 是否需要返回附加信息

响应参数

名称 类型 示例值 描述
module String 1234567890^0 短信拓展码
req_id String 1235 top请求id

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
JstSmsOaidMessageSendRequest req = new JstSmsOaidMessageSendRequest();
JstSmsOaidMessageSendRequest.SendMessageByOaidRequest obj1 = new JstSmsOaidMessageSendRequest.SendMessageByOaidRequest();
obj1.setExtendName("12345");
obj1.setOrderId("1590159531380428537");
obj1.setExtendCode("12345");
obj1.setSmsFreeSignName("聚石塔测试签名");
obj1.setTemplateCode("SMS_12345");
obj1.setExtend("123");
obj1.setOaid("3mwdUE03cfGGuH4A4DrWWjcL8lxkl3bH29SM1RHqDNo5RgXYTdCQj1ZMN8wbv7qnLeiX6Dr");
obj1.setAdditionalInfo(true);
req.setParamSendMessageByOAIDRequest(obj1);
JstSmsOaidMessageSendResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<jst_sms_oaid_message_send_response>
    <module>1234567890^0</module>
    <req_id>1235</req_id>
</jst_sms_oaid_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

返回
顶部