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

文档中心 > API类目 > 阿里大于API

alibaba.aliqin.fc.sms.num.send (短信发送)

向指定手机号码发送模板短信,模板内可设置部分变量。使用前需要在阿里大于管理中心添加短信签名与短信模板。测试时请直接使用正式环境HTTP请求地址。 【重要】批量发送(一次传递多个号码eg:1381111111,1382222222)会产生相应的延迟,触达时间要求高的建议单条发送

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
rec_num String 必须 13000000000 短信接收号码。支持单个或多个手机号码,传入号码为11位手机号码,不能加0或+86。群发短信需传入多个号码,以英文逗号分隔,一次调用最多传入200个号码。示例:18600000000,13911111111,13322222222
sms_template_code String 必须 SMS_585014 短信模板ID,传入的模板必须是在阿里大于“管理中心-短信模板管理”中的可用模板。示例:SMS_585014
extend String 可选 123456 公共回传参数,在“消息返回”中会透传回该参数;举例:用户可以传入自己下级的会员ID,在消息返回时,该会员ID会包含在内,用户可以根据该会员ID识别是哪位会员使用了你的应用
sms_free_sign_name String 必须 阿里大于 短信签名,传入的短信签名必须是在阿里大于“管理中心-验证码/短信通知/推广短信-配置短信签名”中的可用签名。如“阿里大于”已在短信签名管理中通过审核,则可传入”阿里大于“(传参时去掉引号)作为短信签名。短信效果示例:【阿里大于】欢迎使用阿里大于服务。
sms_param Json 可选 {"code":"1234","product":"alidayu"} 短信模板变量,传参规则{"key":"value"},key的名字须和申请模板中的变量名一致,多个变量之间以逗号隔开。示例:针对模板“验证码${code},您正在进行${product}身份验证,打死不要告诉别人哦!”,传参时需传入{"code":"1234","product":"alidayu"}
sms_type String 必须 normal 短信类型,传入值请填写normal

响应参数

名称 类型 示例值 描述
result BizResult 0 返回值
  • └ model
  • String
  • 134523^4351232
  • 返回结果
  • └ msg
  • String
  • 成功
  • 返回信息描述
  • └ success
  • Boolean
  • false
  • true表示成功,false表示失败
  • └ err_code
  • String
  • 0
  • 错误码

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAliqinFcSmsNumSendRequest req = new AlibabaAliqinFcSmsNumSendRequest();
req.setRecNum("13000000000");
req.setSmsTemplateCode("SMS_585014");
req.setExtend("123456");
req.setSmsFreeSignName("阿里大于");
req.setSmsParamString("{\"code\":\"1234\",\"product\":\"alidayu\"}");
req.setSmsType("normal");
AlibabaAliqinFcSmsNumSendResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_aliqin_fc_sms_num_send_response>
    <result>
        <model>134523^4351232</model>
        <msg>成功</msg>
        <success>false</success>
        <err_code>0</err_code>
    </result>
</alibaba_aliqin_fc_sms_num_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>

错误码解释

错误码 错误描述 解决方案
isv.OUT_OF_SERVICE 业务停机 登陆www.alidayu.com充值
isv.PRODUCT_UNSUBSCRIBE 产品服务未开通 登陆www.alidayu.com开通相应的产品服务
isv.ACCOUNT_NOT_EXISTS 账户信息不存在 登陆www.alidayu.com完成入驻
isv.ACCOUNT_ABNORMAL 账户信息异常 联系技术支持
isv.SMS_TEMPLATE_ILLEGAL 模板不合法 登陆www.alidayu.com查询审核通过短信模板使用
isv.SMS_SIGNATURE_ILLEGAL 签名不合法 登陆www.alidayu.com查询审核通过的签名使用
isv.MOBILE_NUMBER_ILLEGAL 手机号码格式错误 使用合法的手机号码
isv.MOBILE_COUNT_OVER_LIMIT 手机号码数量超过限制 批量发送,手机号码以英文逗号分隔,不超过200个号码
isv.TEMPLATE_MISSING_PARAMETERS 短信模板变量缺少参数 确认短信模板中变量个数,变量名,检查传参是否遗漏
isv.INVALID_PARAMETERS 参数异常 检查参数是否合法
isv.BUSINESS_LIMIT_CONTROL 触发业务流控限制 短信验证码,使用同一个签名,对同一个手机号码发送短信验证码,允许每分钟1条,累计每小时7条。 短信通知,使用同一签名、同一模板,对同一手机号发送短信通知,允许每天50条(自然日)。
isv.INVALID_JSON_PARAM JSON参数不合法 JSON参数接受字符串值。例如{"code":"123456"},不接收{"code":123456}
isp.SYSTEM_ERROR - -
isv.BLACK_KEY_CONTROL_LIMIT 模板变量中存在黑名单关键字。如:阿里大鱼 黑名单关键字禁止在模板变量中使用,若业务确实需要使用,建议将关键字放到模板中,进行审核。
isv.PARAM_NOT_SUPPORT_URL 不支持的url传参方式 若模板中要使用url;url的域必须固化在模板中。eg:www.alidayu.com/1/23 适配该规则 www.alidayu.com 写在模板中/1/23 写在变量中
isv.PARAM_LENGTH_LIMIT 变量长度受限 变量长度受限 请尽量固化变量中固定部分
isv.AMOUNT_NOT_ENOUGH 余额不足 因余额不足未能发送成功,请登录管理中心充值后重新发送
isv.DAY_LIMIT_CONTROL 触发日发送限额 修改日发送量限额值
isv.MONTH_LIMIT_CONTROL 触发月发送限额 修改月发送量限额值
isv.SMS_SIGN_ILLEGAL 短信签名非法 检查短信发送时使用的签名

API工具

如何获得此API

FAQ

返回
顶部