后端短信服务接口扩展说明

平台提供了短信服务接口，通过实现短信服务接口，可以扩展接入第三方的短信平台，用于系统下发短信。

• 接口名：com.kdayun.z1.core.sms.service.SmsService

• 说明：目前平台已经接入阿里云短信服务平台，具体实现可以参考：com.kdayun.manager.service.impl.CoreAliyunSmsServiceImpl

短信服务接口扩展

短信下发方法：sendSms

短信验证码校验方法：checkSmsCode

平台配置

获取密钥 accessKeyId/accessKeySecret

设置平台短信配置 accessKeyId/accessKeySecret

2023-12-20 15:58:45 星期三

设置平台短信类型模板配置

前端调用接口

• 通用短信接口(这个使用 [短信服务配置->common下的配置] )

  • URL : http://xxx.com/kdayun/core/sms/send/common/smscode

  • 请求方式: get

  • 参数: phone 电话号码

  • 参数: vcodekey 图像验证码唯一标志(发送短信验证时候需要输入的图像验证码) [当开启是否开启手机短信验证码选项时候必填非空,否则传递空串]

  • 参数: vcode 短信图像验证码 [当开启是否开启手机短信验证码选项时候必填非空,否则传递空串]

  • 参数: orgid 机构id [可选参数,为空时候取当前用户的机构id]

  • 返回: 返回发送结果RetVo

  • Content-Type :application/json;charset=UTF-8

  • 例子:

    function Button1_onClickScript(cxt: ScriptContext, btn: Button) {
    if (Common.isEmpty(btn.getPage().components.InputEdit1.getValue())) {
      Common.errorMsg('请输入电话号码')
      return;
    }
    Common.get(Common.getContextPath() + '/core/sms/send/common/smscode',
      {
          phone: btn.getPage().components.InputEdit1.getValue(),
          vcodekey:'',
          vcode:''
      },
      function (res) {
          if (res.state == 'ERROR') {
              Common.errorMsg(res.msg)
          } else {
              Common.successMsg('发送成功')
          }
      })
    }
    

• 具体短信的配置
  数据字典 -> 短信服务配置

  • resetpwd 重设密码短信验证

  • forgetpwd 忘记密码短信验证

  • login 登录短信验证

  • regedit 注册短信验证

  • bind 绑定微信短信验证

  • common 通用短信验证,(一般是自定义短信验证使用. 短信组件使用此配置)

    配置的json如下:

    {
      "forgetpwd:{
          //验证码在短信模板内的变量名
          "varName": "code",
          //验证码的类型(smsCode 验证码类短信, notice 通知类短信 )
          "type": "smsCode",
          //模板id (需要在短信平台获取短信模板)
          "templateIds": [
              "SMS_152431105"
          ],
          //短信签名(需要在短信平台获取短信签名)
          "signNames": [
              "快搭"
          ]
      },
      ...
    }

    如:

    {
    "resetpwd": {
      "varName": "code",
      "type": "smsCode",
      "templateIds": [
          "SMS_152431105"
      ],
      "signNames": [
          "快搭"
      ]
    },
    "forgetpwd": {
      "varName": "code",
      "type": "smsCode",
      "templateIds": [
          "SMS_152543822"
      ],
      "signNames": [
          "快搭"
      ]
    },
    "login": {
      "varName": "code",
      "type": "smsCode",
      "templateIds": [
          "SMS_152431108"
      ],
      "signNames": [
          "快搭"
      ]
    },
    "regedit": {
      "varName": "code",
      "type": "smsCode",
      "templateIds": [
          "SMS_152431106"
      ],
      "signNames": [
          "快搭"
      ]
    },
    "bind": {
      "varName": "code",
      "signNames": [
          "快搭"
      ],
      "templateIds": [
          "SMS_172595379"
      ],
      "type": "smsCode"
    },
    "common": {
      "varName": "code",
      "signNames": [
          "快搭"
      ],
      "templateIds": [
          "SMS_172595370"
      ],
      "type": "smsCode"
    }
    }

    上面的json内的key分别对应短信平台内设置的模板 templateIds. 不同的类型如下:

  • resetpwd 重设密码短信验证配置

  • forgetpwd 忘记密码短信验证配置

  • login 登录短信验证配置

  • regedit 注册短信验证配置

  • common 通用短信验证配置

    阿里云的短信模板设置

    

    阿里云的签名管理

• 注意:

  • 签名修改和新增都需要审核;审核时长：一般2小时内完成，涉及政企签名一般2个工作日内完成，近期平均完成审核时长约1小时，如遇升级核验、审核任务较多时、非工作时间，审核时间可能会延长，请耐心等待。
    审核工作时间: 周一至周日9:00-21:00（法定节假日顺延）