alidayu

Documentation

Index

• Constants
• type SmsHelper
  • func NewSmsHelper(cfg *config.Config) *SmsHelper
  • func (ss *SmsHelper) SendSms(phoneNumber string, signName, templateCode, templateParam, outId string) (*SmsResp, error)
• type SmsReq
• type SmsResp

Constants

const (
	HMACSHA1 = "HMAC-SHA1"
)

Types

type SmsHelper

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

func NewSmsHelper

func NewSmsHelper(cfg *config.Config) *SmsHelper

func (*SmsHelper) SendSms

func (ss *SmsHelper) SendSms(phoneNumber string, signName, templateCode, templateParam, outId string) (*SmsResp, error)

type SmsReq

type SmsReq struct {
	// AccessKeyId	是否必填：是 说明：AccessKeyId
	AccessKeyId string `form:"AccessKeyId"`
	// Action 是否必填：是	说明：API的命名，固定值，如发送短信API的值为：SendSms
	Action string `form:"Action"`
	// Format	是否必填：否	说明：没传默认为JSON，可选填值：XML
	Format string `form:"Format"`
	// OutId 是否必填：否	说明：外部流水扩展字段
	OutId string `form:"OutId"`
	// PhoneNumbers 是否必填：是	说明：短信接收号码,支持以逗号分隔的形式进行批量调用，批量上限为1000个手机号码,批量调用相对于单条调用及时性稍有延迟,验证码类型的短信推荐使用单条调用的方式
	PhoneNumbers string `form:"PhoneNumbers"`
	// RegionId 是否必填：是	说明：API支持的RegionID，如短信API的值为：cn-hangzhou
	RegionId string `form:"RegionId"`
	// SignName 是否必填：是	说明：短信签名(如 云通信)
	SignName string `form:"SignName"`
	// Signature	是否必填：是	说明：最终生成的签名结果值
	Signature string `form:"Signature"`
	// SignatureMethod	是否必填：是	说明：建议固定值：HMAC-SHA1
	SignatureMethod string `form:"SignatureMethod"`
	// SignatureNonce	是否必填：是	说明：用于请求的防重放攻击，每次请求唯一，JAVA语言建议用：java.util.UUID.randomUUID()生成即可
	SignatureNonce string `form:"SignatureNonce"`
	// SignatureVersion	是否必填：是	说明：建议固定值：1.0
	SignatureVersion string `form:"SignatureVersion"`
	// TemplateCode 是否必填：是	说明：短信模板ID
	TemplateCode string `form:"TemplateCode"`
	// TemplateParam 是否必填：否	说明：短信模板变量替换JSON串,友情提示:如果JSON中需要带换行符,请参照标准的JSON协议。（如{“code”:”1234”,”product”:”ytx”} ）
	TemplateParam string `form:"TemplateParam"`
	// Timestamp	是否必填：是	说明：格式为：yyyy-MM-dd’T’HH:mm:ss’Z’；时区为：GMT
	Timestamp string `form:"Timestamp"`
	// Version 是否必填：是	说明：API的版本，固定值，如短信API的值为：2017-05-25
	Version string `form:"Version"`
}

SmsReq ...

type SmsResp

type SmsResp struct {
	RequestId string `json:"RequestId"`
	Code      string `json:"Code"`
	Message   string `json:"Message"`
	BizId     string `json:"BizId"`
}