a Ruby Gem for using aliyun sms service. 一个应用阿里云短信推送服务的Ruby Gem。

Aliyun::Sms 阿里云短信服务 Ruby Gem aliyun-sms
用于阿里云短信服务的 Ruby Gem. 使用这个 Gem 的前提是已经在阿里云注册用户,申请开通了短信服务, 并获得了以下几个关键参数:

  • ACCESS_KEY_SECRET: 阿里云接入密钥,在阿里云控制台申请获取。
  • ACCESS_KEY_ID: 阿里云接入 ID, 在阿里云控制台申请获取。
  • SIGN_NAME: 短信签名,在阿里云申请开通短信服务时获取。
  • TEMPLATE_CODE: 短信模版代码,在阿里云申请开通短信服务时申请获取。

1. Installation 安装

Rails 应用安装方法
在应用的 Gemfile 文件中添加 Ruby Gems 安装源:

gem 'aliyun-sms'   # Ruby Gems 安装源

应用的根目录下运行:

bundle

安装可能遇到的问题及其解决方式
安装后,如果出现无法找到atyun-sms.rb文件,很可能是镜像安装源与 Ruby Gems 不同步造成的,可以改为 Github 安装源,例如 Rails Gemfile 文件引用可以改为下面格式,即可正确安装。

gem 'aliyun-sms', git: 'https://github.com/VICTOR-LUO-F/aliyun-sms.git'

Usage 使用

Rails 应用使用方法
第一步:
在 Rails 应用目录 config/initializers/ 下创建脚本文件 aliyun-sms.rb,在文件中加入以下内容:

Aliyun::Sms.configure do |config|
    config.access_key_secret = ACCESS_KEY_SECRET # 阿里云接入密钥,在阿里云控制台申请
    config.access_key_id = ACCESS_KEY_ID         # 阿里云接入 ID, 在阿里云控制台申请
    config.action = 'SendSms'                    # 默认设置,如果没有特殊需要,可以不改
    config.format = 'JSON'                       # 短信推送返回信息格式,可以填写 'JSON'或者'XML'
    config.region_id = 'cn-hangzhou'             # 默认设置,如果没有特殊需要,可以不改      
    config.sign_name = SIGN_NAME                 # 短信签名,在阿里云申请开通短信服务时申请获取
    config.signature_method = 'HMAC-SHA1'        # 加密算法,默认设置,不用修改
    config.signature_version = '1.0'             # 签名版本,默认设置,不用修改
    config.sms_version = '2017-05-25'            # 服务版本,默认设置,不用修改
    config.domain = 'dysmsapi.aliyuncs.com'      # 阿里云短信服务器, 默认设置,不用修改
  end

第二步:
在 Rails 应用中调用短信发送代码:

Aliyun::Sms.send(phone_number, template_code, param_string)

参数说明:

  • phone_number: 接收短信的手机号,必须为字符型,例如 ‘1234567890’;
  • template_code: 短信模版代码,必须为字符型,申请开通短信服务后,由阿里云提供,例如 ‘SMS_12345678’;
  • para_string: 请求字符串,向短信模版提供参数,必须为字符型的json格式,例如 ‘{“customer”: “username”}’。

特别说明:
在程序中可以先用 HASH 组织 param_string 内容,再使用 to_json 方法转换为 json 格式字符串,例如:

phone_number = '1234567890'
template_code = 'SMS_12345678'
param_string = {'customer' => 'username'}.to_json
Aliyun::Sms.send(phone_number, template_code, param_string)

References

VICTOR-LUO-F/aliyun-sms: a Ruby Gem for using aliyun sms service. 一个应用阿里云短信推送服务的Ruby Gem。
https://github.com/VICTOR-LUO-F/aliyun-sms

aliyun-sms | RubyGems.org | your community gem host
https://rubygems.org/gems/aliyun-sms

短信服务-阿里云
https://help.aliyun.com/product/44282.html

打赏

Leave a Reply

Your email address will not be published. Required fields are marked *