sms

package
v0.0.0-...-fcc9f11 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 8, 2018 License: Apache-2.0 Imports: 16 Imported by: 9

Documentation

Overview

Package sms Copyright 2016 The GiterLab Authors. All rights reserved.

Package sms Copyright 2016 The GiterLab Authors. All rights reserved.

Index

Constants

This section is empty.

Variables

View Source 
var HTTPDebugEnable = false

HTTPDebugEnable http调试开关

Functions

This section is empty.

Types

type Client 

type Client struct {
	// SMS服务的地址，默认为（https://sms.aliyuncs.com）
	EndPoint string
	// 访问SMS服务的accessid，通过官方网站申请或通过管理员获取
	AccessID string
	// 访问SMS服务的accesskey，通过官方网站申请或通过管理员获取
	AccessKey string
	// 连接池中每个连接的Socket超时，单位为秒，可以为int或float。默认值为30
	SocketTimeout int

	// 其他参数
	Param Param
	// contains filtered or unexported fields
}

Client HTTP请求配置信息

func New 

func New(accessid, accesskey string) (c *Client)

New 创建一个短信发送客户端

func (*Client) SendMulti 

func (c *Client) SendMulti(RecNum []string, signname, templatecode, ParamString string) (e *ErrorMessage, err error)

SendMulti 发送给多个手机号, 最多100个

func (*Client) SendOne 

func (c *Client) SendOne(RecNum, signname, templatecode, ParamString string) (e *ErrorMessage, err error)

SendOne 发送给一个手机号

func (*Client) SetAccessID 

func (c *Client) SetAccessID(accessid string)

SetAccessID 设置短信服务的accessid，通过官方网站申请或通过管理员获取

func (*Client) SetAccessKey 

func (c *Client) SetAccessKey(accesskey string)

SetAccessKey 设置短信服务的accesskey，通过官方网站申请或通过管理员获取

func (*Client) SetEndPoint 

func (c *Client) SetEndPoint(endPoint string)

SetEndPoint 设置短信服务器

func (*Client) SetSocketTimeout 

func (c *Client) SetSocketTimeout(sockettimeout int)

SetSocketTimeout 设置短信服务的Socket超时，单位为秒，可以为int或float。默认值为30

type ErrorMessage 

type ErrorMessage struct {
	HTTPCode  int     `json:"-"`
	Model     *string `json:"Model,omitempty"`
	RequestID *string `json:"RequestId,omitempty"`
	Message   *string `json:"Message,omitempty"`
	Code      *string `json:"Code,omitempty"`
}

ErrorMessage 短信服务器返回的错误信息

func (*ErrorMessage) Error 

func (e *ErrorMessage) Error() string

Error 序列化成字符串

func (*ErrorMessage) GetCode 

func (e *ErrorMessage) GetCode() string

GetCode 获取请求的错误码

func (*ErrorMessage) GetHTTPCode 

func (e *ErrorMessage) GetHTTPCode() int

GetHTTPCode 获取HTTP请求的错误码

func (*ErrorMessage) GetMessage 

func (e *ErrorMessage) GetMessage() string

GetMessage 获取错误信息

func (*ErrorMessage) GetModel 

func (e *ErrorMessage) GetModel() string

GetModel get model

func (*ErrorMessage) GetRequestID 

func (e *ErrorMessage) GetRequestID() string

GetRequestID 获取请求的ID序列

func (*ErrorMessage) SetHTTPCode 

func (e *ErrorMessage) SetHTTPCode(code int)

SetHTTPCode 设置HTTP错误码

type Param 

type Param struct {
	// 系统参数
	AccessKeyID      string // 阿里云颁发给用户的访问服务所用的密钥ID
	Timestamp        string // 格式为：yyyy-MM-dd’T’HH:mm:ss’Z’；时区为：GMT
	Format           string // 没传默认为JSON，可选填值：XML
	SignatureMethod  string // 建议固定值：HMAC-SHA1
	SignatureVersion string // 建议固定值：1.0
	SignatureNonce   string // 用于请求的防重放攻击，每次请求唯一
	Signature        string // 最终生成的签名结果值

	// 业务参数
	Action       string // API的命名，固定值，如发送短信API的值为：SendSms
	Version      string // API的版本，固定值，如短信API的值为：2017-05-25
	RegionID     string // API支持的RegionID，如短信API的值为：cn-hangzhou
	RecNum       string // 手机号
	SignName     string // 短信签名
	TemplateCode string // 短信模板
	ParamString  string // 短信版本中的参数
	OutID        string // 外部流水扩展字段
}

Param 短信发送所需要的参数

func (*Param) GetAccessKeyID 

func (p *Param) GetAccessKeyID() string

GetAccessKeyID 获取密钥ID

func (*Param) GetAction 

func (p *Param) GetAction() string

GetAction 获取API请求方法参数

func (*Param) GetFormat 

func (p *Param) GetFormat() string

GetFormat 获取返回格式

func (*Param) GetOutID 

func (p *Param) GetOutID() string

GetOutID 获取外部流水扩展字段

func (*Param) GetParamString 

func (p *Param) GetParamString() string

GetParamString 获取短信模板参数

func (*Param) GetRecNum 

func (p *Param) GetRecNum() string

GetRecNum 获取短信接收的手机号

func (*Param) GetRegionID 

func (p *Param) GetRegionID() string

GetRegionID 获取API的RegionID

func (*Param) GetSignName 

func (p *Param) GetSignName() string

GetSignName 获取签名参数

func (*Param) GetSignature 

func (p *Param) GetSignature() string

GetSignature 获取签名结果

func (*Param) GetSignatureMethod 

func (p *Param) GetSignatureMethod() string

GetSignatureMethod 获取签名方法

func (*Param) GetSignatureNonce 

func (p *Param) GetSignatureNonce() string

GetSignatureNonce 获取当前请求的序列

func (*Param) GetSignatureVersion 

func (p *Param) GetSignatureVersion() string

GetSignatureVersion 获取签名版本

func (*Param) GetTemplateCode 

func (p *Param) GetTemplateCode() string

GetTemplateCode 获取短信模板

func (*Param) GetTimestamp 

func (p *Param) GetTimestamp() string

GetTimestamp 获取时间戳

func (*Param) GetVersion 

func (p *Param) GetVersion() string

GetVersion 获取API版本

func (*Param) SetAccessKeyID 

func (p *Param) SetAccessKeyID(accesskeyid string)

SetAccessKeyID 设置密钥ID

func (*Param) SetAction 

func (p *Param) SetAction(action string)

SetAction 设置API请求方法参数

func (*Param) SetFormat 

func (p *Param) SetFormat(format string)

SetFormat 设置返回格式，JSON/XML

func (*Param) SetOutID 

func (p *Param) SetOutID(outid string)

SetOutID 设置外部流水扩展字段

func (*Param) SetParamString 

func (p *Param) SetParamString(ParamString string)

SetParamString 设置短信模板参数

func (*Param) SetRecNum 

func (p *Param) SetRecNum(RecNum string)

SetRecNum 设置短信接收的手机号

func (*Param) SetRegionID 

func (p *Param) SetRegionID(regioniD string)

SetRegionID 设置API的RegionID

func (*Param) SetSignName 

func (p *Param) SetSignName(signname string)

SetSignName 设置签名参数

func (*Param) SetSignature 

func (p *Param) SetSignature(signature string)

SetSignature 设置最终的签名结果

func (*Param) SetSignatureMethod 

func (p *Param) SetSignatureMethod(signaturemethod string)

SetSignatureMethod 设置签名方法

func (*Param) SetSignatureNonce 

func (p *Param) SetSignatureNonce(signaturenonce string)

SetSignatureNonce 设置每一次请求的唯一序列

func (*Param) SetSignatureVersion 

func (p *Param) SetSignatureVersion(signatureversion string)

SetSignatureVersion 设置签名版本

func (*Param) SetTemplateCode 

func (p *Param) SetTemplateCode(templatecode string)

SetTemplateCode 设置短信模板

func (*Param) SetTimestamp 

func (p *Param) SetTimestamp(timestamp string)

SetTimestamp 设置时间戳

func (*Param) SetVersion 

func (p *Param) SetVersion(version string)

SetVersion 设置API版本

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.