XAliyunSms

README

XAliyunSms Starter

基于 https://github.com/aliyun/alibaba-cloud-sdk-go 阿里云官方包 短信服务需引用 import "github.com/aliyun/alibaba-cloud-sdk-go/services/dysmsapi"

AliyunSms Documentation

Documentation https://help.aliyun.com/product/44282.html

短信使用流程：

• 入驻阿里云
• 开通短信服务
• 获取AccessKey
• 创建签名和模版
• 短信接口配置
• 发送短信

XAliyunSms Starter Usage

goinfras.RegisterStarter(XAliyunSms.NewStarter())

XAliyunSms Config Setting

Scheme          string // 交互协议："https"...
EndPoint        string // 必须，服务器节点
AccessKeyId     string // 必须，主账号AccessKey的ID。
AccessSecret    string // 必须，主账号秘钥。
SignName        string // 必须，短信签名名称。请在控制台签名管理页面签名名称一列查看。必须是已添加、并通过审核的短信签名。
TemplateCode    string // 必须，短信模板ID。请在控制台模板管理页面模板CODE一列查看。 必须是已添加、并通过审核的短信签名；且发送国际/港澳台消息时，请使用国际/港澳台短信模版。
Action          string // 系统规定参数。取值：SendSms。
OutId           string // 外部流水扩展字段。
SmsUpExtendCode string // 上行短信扩展码，无特殊需要此字段的用户请忽略此字段。

XAliyunSms Usage

1、发送单条短信

response, err := XAliyunSms.XCommonSms().SendSmsMsg("scheme", "tel", "signName", "templateCode", "templateParamJson")
So(err, ShouldBeNil)
Println("Send Sms Status:", response.IsSuccess())

2、批量发送短信

smsResponse, err := XAliyunSms.XCommonSms().SendBatchSmsMsg("scheme", "templateCode","templateParamsJson", []string{"tel1","tel2"}, []string{"signName1","signName2"})
So(err, ShouldBeNil)
Println("Send Batch Sms Status:", smsResponse.IsSuccess())

Documentation

Index

• func CreateDefaultClient(config *Config) error
• func NewAliyunSmsClient(config *Config) (*dysmsapi.Client, error)
• func NewStarter() *starter
• func XClient() *dysmsapi.Client
• func XFClient(f func(c *dysmsapi.Client) error) error
• type CommonSms
  • func XCommonSms() *CommonSms
  • func (c *CommonSms) SendBatchSmsMsg(scheme, templateCode, templateParamsJson string, tels, signNames []string) (*dysmsapi.SendBatchSmsResponse, error)
  • func (c *CommonSms) SendSmsMsg(scheme, tel, signName, templateCode, templateParamsJson string) (*dysmsapi.SendSmsResponse, error)
• type Config
  • func DefaultConfig() *Config

Functions

func CreateDefaultClient

func CreateDefaultClient(config *Config) error

创建一个默认配置的Manager

func NewAliyunSmsClient

func NewAliyunSmsClient(config *Config) (*dysmsapi.Client, error)

func NewStarter

func NewStarter() *starter

func XClient

func XClient() *dysmsapi.Client

func XFClient

func XFClient(f func(c *dysmsapi.Client) error) error

资源组件闭包执行

Types

type CommonSms

type CommonSms struct {
	// contains filtered or unexported fields
}

func XCommonSms

func XCommonSms() *CommonSms

func (*CommonSms) SendBatchSmsMsg

func (c *CommonSms) SendBatchSmsMsg(scheme, templateCode, templateParamsJson string, tels, signNames []string) (*dysmsapi.SendBatchSmsResponse, error)

*

• @Description: 批量短信发送
• @receiver c
• @param scheme 交互协议："https"...
• @param templateCode 必须，短信模板ID。请在控制台模板管理页面模板CODE一列查看。 必须是已添加、并通过审核的短信签名；且发送国际/港澳台消息时，请使用国际/港澳台短信模版。
• @param tels 需要接收短信的手机号码数组
• @param signNames 必须，短信签名名称数组。请在控制台签名管理页面签名名称一列查看。必须是已添加、并通过审核的短信签名。
• @param templateParamsJson 必须，短信模板参数，与templateCode 配合
• @return *dysmsapi.SendBatchSmsResponse
• @return error

func (*CommonSms) SendSmsMsg

func (c *CommonSms) SendSmsMsg(scheme, tel, signName, templateCode, templateParamsJson string) (*dysmsapi.SendSmsResponse, error)

*

• @Description: 单条短信发送
• @receiver c
• @param scheme 交互协议："https"...
• @param tel 手机号码
• @param signName 必须，短信签名名称。请在控制台签名管理页面签名名称一列查看。必须是已添加、并通过审核的短信签名。
• @param templateCode 必须，短信模板ID。请在控制台模板管理页面模板CODE一列查看。 必须是已添加、并通过审核的短信签名；且发送国际/港澳台消息时，请使用国际/港澳台短信模版。
• @param templateParamJson 必须，短信模板参数，与templateCode 配合
• @return *dysmsapi.SendSmsResponse
• @return error

type Config

type Config struct {
	EndPoint     string // 必须，服务器节点
	AccessKeyId  string // 必须，主账号AccessKey的ID。
	AccessSecret string // 必须，主账号秘钥。
}

func DefaultConfig

func DefaultConfig() *Config