程序包 org.dromara.sms4j.api

接口 SmsBlend

public interface SmsBlend
SmsBlend

通用接口，定义国内短信方法

作者:
:Wind 2023/5/16 16:03

  • 方法详细资料

    • getConfigId

      String getConfigId()
      获取短信实例唯一标识
      返回:

    • getSupplier

      String getSupplier()
      获取供应商标识
      返回:

    • sendMessage

      SmsResponse sendMessage(String phone, String message)

      说明：发送固定消息模板短信

      此方法将使用配置文件中预设的短信模板进行短信发送

      该方法指定的模板变量只能存在一个（配置文件中）

      如使用的是腾讯的短信，参数字符串中可以同时存在多个参数，使用 & 分隔例如：您的验证码为{1}在{2}分钟内有效，可以传为 message="xxxx"+"&"+"5" sendMessage

      参数:
      phone - 接收短信的手机号 message 消息内容

    • sendMessage

      SmsResponse sendMessage(String phone, LinkedHashMap<String,String> messages)
      sendMessage

      说明：发送固定消息模板多模板参数短信

      参数:
      phone - 接收短信的手机号
      messages - 模板内容

    • sendMessage

      SmsResponse sendMessage(String phone, String templateId, LinkedHashMap<String,String> messages)

      说明：使用自定义模板发送短信 sendMessage

      参数:
      templateId - 模板id
      messages - key为模板变量名称 value为模板变量值

    • massTexting

      SmsResponse massTexting(List<String> phones, String message)

      说明：群发固定模板短信 massTexting

    • massTexting

      SmsResponse massTexting(List<String> phones, String templateId, LinkedHashMap<String,String> messages)

      说明：使用自定义模板群发短信 massTexting

    • sendMessageAsync

      void sendMessageAsync(String phone, String message, CallBack callBack)

      说明：异步短信发送，固定消息模板短信 sendMessageAsync

      参数:
      phone - 要发送的号码
      message - 发送内容
      callBack - 回调

    • sendMessageAsync

      void sendMessageAsync(String phone, String message)

      说明：异步发送短信，不关注发送结果 sendMessageAsync

      参数:
      phone - 要发送的号码
      message - 发送内容

    • sendMessageAsync

      void sendMessageAsync(String phone, String templateId, LinkedHashMap<String,String> messages, CallBack callBack)

      说明：异步短信发送，使用自定义模板发送短信 sendMessage

      参数:
      templateId - 模板id
      messages - key为模板变量名称 value为模板变量值
      callBack - 回调

    • sendMessageAsync

      void sendMessageAsync(String phone, String templateId, LinkedHashMap<String,String> messages)

      说明：异步短信发送，使用自定义模板发送短信，不关注发送结果 sendMessageAsync

      参数:
      templateId - 模板id
      messages - key为模板变量名称 value为模板变量值

    • delayedMessage

      void delayedMessage(String phone, String message, Long delayedTime)

      说明：使用固定模板发送延时短信 delayedMessage

      参数:
      phone - 接收短信的手机号
      message - 要发送的短信
      delayedTime - 延迟时间

    • delayedMessage

      void delayedMessage(String phone, String templateId, LinkedHashMap<String,String> messages, Long delayedTime)

      说明：使用自定义模板发送定时短信 sendMessage delayedMessage

      参数:
      templateId - 模板id
      messages - key为模板变量名称 value为模板变量值
      phone - 要发送的手机号
      delayedTime - 延迟的时间

    • delayMassTexting

      void delayMassTexting(List<String> phones, String message, Long delayedTime)

      说明：群发延迟短信 delayMassTexting

      参数:
      phones - 要群体发送的手机号码

    • delayMassTexting

      void delayMassTexting(List<String> phones, String templateId, LinkedHashMap<String,String> messages, Long delayedTime)

      说明：使用自定义模板发送群体延迟短信 delayMassTexting

      参数:
      phones - 要群体发送的手机号码
      templateId - 模板id
      messages - key为模板变量名称 value为模板变量值
      delayedTime - 延迟的时间

    • joinInBlacklist

      default void joinInBlacklist(String phone)

      说明：加入黑名单【这个需要有全局操作的同时需要操作缓存，那么不给smsblend实际处理，代理部分处理】 joinInBlacklist

      参数:
      phone - 需要加入黑名单的手机号

    • removeFromBlacklist

      default void removeFromBlacklist(String phone)

      说明：从黑名单移除【为了sms4j组件有统一入口，同时这个需要有全局操作的同时需要操作缓存，那么不给smsblend实际处理，代理部分处理】 removeFromBlacklist

      参数:
      phone - 需要加入黑名单的手机号

    • batchJoinBlacklist

      default void batchJoinBlacklist(List<String> phones)

      说明：批量加入黑名单【为了sms4j组件有统一入口，同时这个需要有全局操作的同时需要操作缓存，那么不给smsblend实际处理，代理部分处理】 batchJoinBlacklist

      参数:
      phones - 需要加入黑名单的手机号数组

    • batchRemovalFromBlacklist

      default void batchRemovalFromBlacklist(List<String> phones)

      说明：批量从黑名单移除【为了sms4j组件有统一入口，同时这个需要有全局操作的同时需要操作缓存，那么不给smsblend实际处理，代理部分处理】 batchRemovalFromBlacklist

      参数:
      phones - 需要移除黑名单的手机号数组