Package com.qiniu.sms

Class SmsManager

  • public class SmsManager
extends java.lang.Object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Response createSignature​(java.lang.String signature, java.lang.String source, java.lang.String[] pics)
      创建签名
      Response createTemplate​(java.lang.String name, java.lang.String template, java.lang.String type, java.lang.String description, java.lang.String signatureId)
      创建模板
      Response deleteSignature​(java.lang.String signatureId)
      删除签名 审核不通过的情况下才可以重新编辑签名，已经审核通过的签名无法重新编辑。
      Response deleteTemplate​(java.lang.String templateId)
      删除模板
      Response describeSignature​(java.lang.String auditStatus, int page, int pageSize)
      查询签名
      SignatureInfo describeSignatureItems​(java.lang.String auditStatus, int page, int pageSize)  
      Response describeTemplate​(java.lang.String templateId)
      查询单个模板信息
      Response describeTemplate​(java.lang.String auditStatus, int page, int pageSize)
      查询模板
      TemplateInfo.Item describeTemplateItem​(java.lang.String templateId)
      查询单个模板信息
      TemplateInfo describeTemplateItems​(java.lang.String auditStatus, int page, int pageSize)  
      Response modifySignature​(java.lang.String signatureId, java.lang.String signature)
      编辑签名 审核不通过的情况下才可以重新编辑签名，已经审核通过的签名无法重新编辑。
      Response modifyTemplate​(java.lang.String templateId, java.lang.String name, java.lang.String template, java.lang.String description, java.lang.String signatureId)
      编辑模板 审核不通过的情况下才可以重新编辑模板，已经审核通过的模板无法重新编辑。
      Response sendFulltextMessage​(java.lang.String[] mobiles, java.lang.String content)
      发送全文本短信(不需要传模版 ID)
      Response sendMessage​(java.lang.String templateId, java.lang.String[] mobiles, java.util.Map<java.lang.String,​java.lang.String> parameters)
      发送短信
      Response sendOverseaMessage​(java.lang.String templateId, java.lang.String mobile, java.util.Map<java.lang.String,​java.lang.String> parameters)
      发送国际短信
      Response sendSingleMessage​(java.lang.String templateId, java.lang.String mobile, java.util.Map<java.lang.String,​java.lang.String> parameters)
      发送单条短信

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • SmsManager

        public SmsManager​(Auth auth)
        构建一个新的 SmsManager 对象
        Parameters:
        auth - Auth对象

      • SmsManager

        public SmsManager​(Auth auth,
                  Configuration cfg)
        构建一个新的 SmsManager 对象
        Parameters:
        auth - Auth对象
        cfg - Configuration对象

    • Method Detail

      • sendMessage

        public Response sendMessage​(java.lang.String templateId,
                            java.lang.String[] mobiles,
                            java.util.Map<java.lang.String,​java.lang.String> parameters)
                     throws QiniuException
        发送短信
        Parameters:
        templateId - 模板Id，必填
        mobiles - 手机号码数组，必填
        parameters - 参数,必填
        Returns:
        Response
        Throws:
        QiniuException - 异常

      • sendSingleMessage

        public Response sendSingleMessage​(java.lang.String templateId,
                                  java.lang.String mobile,
                                  java.util.Map<java.lang.String,​java.lang.String> parameters)
                           throws QiniuException
        发送单条短信
        Parameters:
        templateId - 模板Id，必填
        mobile - 手机号码，必填
        parameters - 参数,必填
        Returns:
        Response
        Throws:
        QiniuException - 异常

      • sendOverseaMessage

        public Response sendOverseaMessage​(java.lang.String templateId,
                                   java.lang.String mobile,
                                   java.util.Map<java.lang.String,​java.lang.String> parameters)
                            throws QiniuException
        发送国际短信
        Parameters:
        templateId - 模板Id，必填
        mobile - 手机号码，必填
        parameters - 参数,必填
        Returns:
        Response
        Throws:
        QiniuException - 异常

      • sendFulltextMessage

        public Response sendFulltextMessage​(java.lang.String[] mobiles,
                                    java.lang.String content)
                             throws QiniuException
        发送全文本短信(不需要传模版 ID)
        Parameters:
        mobiles - 手机号码数组，必填
        content - 短信内容，必须是已经审核通过的签名和模版，必填。 例如：【七牛云】您的验证码是 287712，5分钟内有效
        Returns:
        Response
        Throws:
        QiniuException - 异常

      • describeSignature

        public Response describeSignature​(java.lang.String auditStatus,
                                  int page,
                                  int pageSize)
                           throws QiniuException
        查询签名
        Parameters:
        auditStatus - 审核状态,非必填 取值范围为: "passed"(通过), "rejected"(未通过), "reviewing"(审核中)。
        page - 页码。默认为 1,非必填
        pageSize - 分页大小。默认为 20,非必填
        Returns:
        Response
        Throws:
        QiniuException - 异常

      • createSignature

        public Response createSignature​(java.lang.String signature,
                                java.lang.String source,
                                java.lang.String[] pics)
                         throws QiniuException
        创建签名
        Parameters:
        signature - 签名，必填
        source - 签名来源，申请签名时必须指定签名来源。必填 取值范围为： enterprises_and_institutions 企事业单位的全称或简称 website 工信部备案网站的全称或简称 app APP应用的全称或简称 public_number_or_small_program 公众号或小程序的全称或简称 store_name 电商平台店铺名的全称或简称 trade_name 商标名的全称或简称
        pics - 签名对应的资质证明图片进行 base64 编码格式转换后的字符串,非必填
        Returns:
        Response
        Throws:
        QiniuException - 异常

      • modifySignature

        public Response modifySignature​(java.lang.String signatureId,
                                java.lang.String signature)
                         throws QiniuException
        编辑签名 审核不通过的情况下才可以重新编辑签名，已经审核通过的签名无法重新编辑。
        Parameters:
        signatureId - 签名Id, 必填
        signature - 签名,必填
        Returns:
        Response
        Throws:
        QiniuException - 异常

      • deleteSignature

        public Response deleteSignature​(java.lang.String signatureId)
                         throws QiniuException
        删除签名 审核不通过的情况下才可以重新编辑签名，已经审核通过的签名无法重新编辑。
        Parameters:
        signatureId - 签名Id, 必填
        Returns:
        Response
        Throws:
        QiniuException - 异常

      • describeTemplate

        public Response describeTemplate​(java.lang.String auditStatus,
                                 int page,
                                 int pageSize)
                          throws QiniuException
        查询模板
        Parameters:
        auditStatus - 审核状态, 非必填 取值范围为: "passed"(通过), "rejected"(未通过), "reviewing"(审核中)。
        page - 页码。默认为 1,非必填
        pageSize - 分页大小。默认为 20,非必填
        Returns:
        Response
        Throws:
        QiniuException - 异常

      • describeTemplate

        public Response describeTemplate​(java.lang.String templateId)
                          throws QiniuException
        查询单个模板信息
        Parameters:
        templateId - 模板ID
        Returns:
        Response
        Throws:
        QiniuException - 异常

      • describeTemplateItem

        public TemplateInfo.Item describeTemplateItem​(java.lang.String templateId)
                                       throws QiniuException
        查询单个模板信息
        Parameters:
        templateId - 模板ID
        Returns:
        Response
        Throws:
        QiniuException - 异常

      • createTemplate

        public Response createTemplate​(java.lang.String name,
                               java.lang.String template,
                               java.lang.String type,
                               java.lang.String description,
                               java.lang.String signatureId)
                        throws QiniuException
        创建模板
        Parameters:
        name - 模板名称,必填
        template - 模板内容,必填
        type - 模板类型,必填 取值范围为: notification (通知类短信), verification (验证码短信), marketing (营销类短信)。
        description - 申请理由简述,必填
        signatureId - 已经审核通过的签名,必填
        Returns:
        Response
        Throws:
        QiniuException - 异常

      • modifyTemplate

        public Response modifyTemplate​(java.lang.String templateId,
                               java.lang.String name,
                               java.lang.String template,
                               java.lang.String description,
                               java.lang.String signatureId)
                        throws QiniuException
        编辑模板 审核不通过的情况下才可以重新编辑模板，已经审核通过的模板无法重新编辑。
        Parameters:
        templateId - 模板Id,必填
        name - 模板名称,必填
        template - 模板内容,必填
        description - 申请理由简述,必填
        signatureId - 已经审核通过的签名,必填
        Returns:
        Response
        Throws:
        QiniuException - 异常

      • deleteTemplate

        public Response deleteTemplate​(java.lang.String templateId)
                        throws QiniuException
        删除模板
        Parameters:
        templateId - 模板Id, 必填
        Returns:
        Response
        Throws:
        QiniuException - 异常