sdk

Documentation

Index

• Constants
• func Debug(enable bool)
• type ApnsRequest
• type Client
  • func New(options ...Option) (m Client)
• type MailRequest
• type Option
  • func WithAuth(appKey, secret string) Option
  • func WithHost(host string) Option
• type Response
• type SmsRequest

Constants

const (
	CodeNotAllow int = 401
	CodeNotFound int = 404
	CodeSuccess  int = 200
)

const ApiCredential = "/open/oauth2/token"

const ApiSendMessage = "/messages/"

Functions

func Debug

func Debug(enable bool)

Debug 输出sdk中的log

Types

type ApnsRequest

type ApnsRequest struct {
	BundleId      string      `json:"bundleId,omitempty"` // bundle id
	Template      string      `json:"template"`           // 模板
	TemplateParam interface{} `json:"params"`             // 参数
	Title         string      `json:"subject,omitempty"`  // 标题
	Receiver      string      `json:"receiver"`           // 接收者，多个时用逗号分隔
}

ApnsRequest Apns服务请求参数

type Client

type Client interface {
	SendMail(req MailRequest) (resp Response, err error)
	SendSms(req SmsRequest) (resp Response, err error)
	SendApns(req ApnsRequest) (resp Response, err error)
}

func New

func New(options ...Option) (m Client)

New 初始化.

内部存储了Credentials,应该确保复用,而不是每次新建

Client 内置了刷新credentials功能,不需要考虑credentials的获取问题.

type MailRequest

type MailRequest struct {
	Template      string      `json:"template"`                // 模板
	CloudTemplate bool        `json:"cloudTemplate,omitempty"` // 云端模板
	TemplateParam interface{} `json:"params"`                  // 参数
	Title         string      `json:"subject,omitempty"`       // 标题
	Receiver      string      `json:"receiver"`                // 接收者，多个时用逗号分隔
}

MailRequest 邮件服务请求参数

type Option

type Option func(*messageClient)

func WithAuth

func WithAuth(appKey, secret string) Option

WithAuth Credentials配置

func WithHost

func WithHost(host string) Option

type Response

type Response struct {
	Code      interface{} `json:"code,omitempty"`
	Success   interface{} `json:"success,omitempty"`
	Message   string      `json:"message,omitempty"`
	MessageId int         `json:"messageId,omitempty"`
}

type SmsRequest

type SmsRequest struct {
	Template      string      `json:"template"` // 模板
	TemplateParam interface{} `json:"params"`   // 参数
	Receiver      string      `json:"receiver"` // 接收者，多个时用逗号分隔
}

SmsRequest 短信服务请求参数