BaseSMS

Documentation

Index

• func CheckSMS(args *ArgsCheckSMS) bool
• func CreateSMS(args *ArgsCreateSMS) (errCode string, err error)
• func CreateSMSCheck(args *ArgsCreateSMSCheck) (errCode string, err error)
• func DeleteConfig(args *ArgsDeleteConfig) (err error)
• func Run()
• func UpdateConfig(args *ArgsUpdateConfig) (err error)
• type ArgsCheckSMS
• type ArgsCheckSMSAndData
• type ArgsCreateConfig
• type ArgsCreateSMS
• type ArgsCreateSMSCheck
• type ArgsDeleteConfig
• type ArgsGetConfigByID
• type ArgsGetConfigList
• type ArgsGetSMSList
• type ArgsUpdateConfig
• type DataSMS
• type FieldsConfig
  • func CreateConfig(args *ArgsCreateConfig) (data FieldsConfig, err error)
  • func GetConfigByID(args *ArgsGetConfigByID) (data FieldsConfig, err error)
  • func GetConfigList(args *ArgsGetConfigList) (dataList []FieldsConfig, dataCount int64, err error)
• type FieldsSMS
  • func CheckSMSAndData(args *ArgsCheckSMSAndData) (data FieldsSMS, b bool)
  • func GetSMSList(args *ArgsGetSMSList) (dataList []FieldsSMS, dataCount int64, err error)

Functions

func CheckSMS

func CheckSMS(args *ArgsCheckSMS) bool

CheckSMS 验证短信请求

func CreateSMS

func CreateSMS(args *ArgsCreateSMS) (errCode string, err error)

CreateSMS 创建新的短信请求

func CreateSMSCheck

func CreateSMSCheck(args *ArgsCreateSMSCheck) (errCode string, err error)

CreateSMSCheck 创建验证用的短信验证码

func DeleteConfig

func DeleteConfig(args *ArgsDeleteConfig) (err error)

DeleteConfig 删除配置

func Run

func Run()

Run 维护

func UpdateConfig

func UpdateConfig(args *ArgsUpdateConfig) (err error)

UpdateConfig 修改配置

Types

type ArgsCheckSMS

type ArgsCheckSMS struct {
	//组织ID
	OrgID int64 `db:"org_id" json:"orgID" check:"id" empty:"true"`
	//配置ID
	ConfigID int64 `json:"configID"`
	//会话
	Token int64 `json:"token"`
	//值
	Value string `json:"value"`
}

ArgsCheckSMS 验证短信请求参数

type ArgsCheckSMSAndData

type ArgsCheckSMSAndData struct {
	//组织ID
	OrgID int64 `db:"org_id" json:"orgID" check:"id" empty:"true"`
	//配置ID
	ConfigID int64 `json:"configID"`
	//会话
	Token int64 `json:"token"`
	//值
	Value string `json:"value"`
}

ArgsCheckSMSAndData 验证并反馈验证码的数据结构参数

type ArgsCreateConfig

type ArgsCreateConfig struct {
	//组织ID
	OrgID int64 `db:"org_id" json:"orgID" check:"id" empty:"true"`
	//使用哪一家？
	// tencent / aliyun
	System string `db:"system" json:"system" check:"mark"`
	//来源系统的显示名称
	Name string `db:"name" json:"name" check:"name"`
	//应用ID
	AppID string `db:"app_id" json:"appID"`
	//应用密钥
	AppKey string `db:"app_key" json:"appKey"`
	//默认过期时间
	DefaultExpire string `db:"default_expire" json:"defaultExpire"`
	//获取间隔时间 秒
	TimeSpacing int64 `db:"time_spacing" json:"timeSpacing"`
	//模版ID
	TemplateID string `db:"template_id" json:"templateID"`
	//签名名称
	TemplateSign string `db:"template_sign" json:"templateSign"`
	//扩展参数
	TemplateParams CoreSQLConfig.FieldsConfigsType `db:"template_params" json:"templateParams"`
	//默认参数
	Params CoreSQLConfig.FieldsConfigsType `db:"params" json:"params"`
}

ArgsCreateConfig 创建新配置参数

type ArgsCreateSMS

type ArgsCreateSMS struct {
	//组织ID
	OrgID int64 `db:"org_id" json:"orgID" check:"id" empty:"true"`
	//配置ID
	ConfigID int64 `json:"configID"`
	//会话
	Token int64 `json:"token"`
	//电话
	NationCode string `json:"nationCode"`
	Phone      string `json:"phone"`
	//短信内容
	Params CoreSQLConfig.FieldsConfigsType `json:"params"`
	//创建来源
	FromInfo CoreSQLFrom.FieldsFrom `json:"fromInfo"`
}

ArgsCreateSMS 创建新的短信请求参数

type ArgsCreateSMSCheck

type ArgsCreateSMSCheck struct {
	//组织ID
	OrgID int64 `db:"org_id" json:"orgID" check:"id" empty:"true"`
	//配置ID
	ConfigID int64 `json:"configID"`
	//会话
	Token int64 `json:"token"`
	//电话
	NationCode string `json:"nationCode"`
	Phone      string `json:"phone"`
	//创建来源
	FromInfo CoreSQLFrom.FieldsFrom `json:"fromInfo"`
}

ArgsCreateSMSCheck 创建验证用的短信验证码参数

type ArgsDeleteConfig

type ArgsDeleteConfig struct {
	//ID
	ID int64 `db:"id" json:"id" check:"id"`
	//组织ID
	OrgID int64 `db:"org_id" json:"orgID" check:"id" empty:"true"`
}

ArgsDeleteConfig 删除配置参数

type ArgsGetConfigByID

type ArgsGetConfigByID struct {
	//ID
	ID int64 `db:"id" json:"id" check:"id"`
	//组织ID
	OrgID int64 `db:"org_id" json:"orgID" check:"id" empty:"true"`
}

ArgsGetConfigByID 获取某个数据参数

type ArgsGetConfigList

type ArgsGetConfigList struct {
	//分页
	Pages CoreSQLPages.ArgsDataList `json:"pages"`
	//组织ID
	OrgID int64 `db:"org_id" json:"orgID" check:"id" empty:"true"`
	//是否被删除
	IsRemove bool `db:"is_remove" json:"isRemove" check:"bool" empty:"true"`
	//搜索
	Search string `json:"search" check:"search" empty:"true"`
}

ArgsGetConfigList 获取列表参数

type ArgsGetSMSList

type ArgsGetSMSList struct {
	//分页
	Pages CoreSQLPages.ArgsDataList `json:"pages"`
	//组织ID
	OrgID int64 `db:"org_id" json:"orgID" check:"id" empty:"true"`
	//短信配置
	ConfigID int64 `json:"configID" check:"id" empty:"true"`
	//手机号
	NationCode string `json:"nationCode" check:"nationCode" empty:"true"`
	Phone      string `json:"phone" check:"phone" empty:"true"`
	//是否过期
	NeedIsExpire bool `json:"needIsExpire" check:"bool"`
	IsExpire     bool `json:"isExpire" check:"bool"`
	//是否已经发送
	NeedIsSend bool `json:"needIsSend" check:"bool"`
	IsSend     bool `json:"isSend" check:"bool"`
	//是否发送失败
	NeedIsFailed bool `json:"needIsFailed" check:"bool"`
	IsFailed     bool `json:"isFailed" check:"bool"`
}

ArgsGetSMSList 获取短信列表参数

type ArgsUpdateConfig

type ArgsUpdateConfig struct {
	//ID
	ID int64 `db:"id" json:"id" check:"id"`
	//组织ID
	OrgID int64 `db:"org_id" json:"orgID" check:"id" empty:"true"`
	//使用哪一家？
	// tencent / aliyun
	System string `db:"system" json:"system" check:"mark"`
	//来源系统的显示名称
	Name string `db:"name" json:"name" check:"name"`
	//应用ID
	AppID string `db:"app_id" json:"appID"`
	//应用密钥
	AppKey string `db:"app_key" json:"appKey"`
	//默认过期时间
	DefaultExpire string `db:"default_expire" json:"defaultExpire"`
	//获取间隔时间 秒
	TimeSpacing int64 `db:"time_spacing" json:"timeSpacing"`
	//模版ID
	TemplateID string `db:"template_id" json:"templateID"`
	//签名名称
	TemplateSign string `db:"template_sign" json:"templateSign"`
	//扩展参数
	TemplateParams CoreSQLConfig.FieldsConfigsType `db:"template_params" json:"templateParams"`
	//默认参数
	Params CoreSQLConfig.FieldsConfigsType `db:"params" json:"params"`
}

ArgsUpdateConfig 修改配置参数

type DataSMS

type DataSMS struct {
	//创建时间
	CreateAt time.Time `json:"createAt"`
	//过期时间
	// 过期后不清理数据，但存在保留的最大时间
	ExpireAt time.Time `json:"expireAt"`
	//发送时间
	SendAt time.Time `json:"sendAt"`
	//组织ID
	OrgID int64 `json:"orgID"`
	//配置ID
	ConfigID int64 `json:"configID"`
	//会话
	Token int64 `json:"token"`
	//用户ID
	UserID int64 `json:"userID"`
	//国家代码
	NationCode string `json:"nationCode"`
	//目标手机号
	// 目标手机号是唯一的标识码
	Phone string `json:"phone"`
	//短信内容
	Des string `json:"des"`
	//失败原因
	// 如果为本地原因则显示错误代码，否则显示API提供方反馈信息
	FailedMsg string `json:"failedMsg"`
	//短信类型
	// check 验证类; des 内容类
	UseType string `json:"useType"`
	//是否已经验证
	HaveCheck time.Time `json:"haveCheck"`
}

type FieldsConfig

type FieldsConfig struct {
	//ID
	ID int64 `db:"id" json:"id"`
	//创建时间
	CreateAt time.Time `db:"create_at" json:"createAt"`
	//更新时间
	UpdateAt time.Time `db:"update_at" json:"updateAt"`
	//删除时间
	DeleteAt time.Time `db:"delete_at" json:"deleteAt"`
	//组织ID
	OrgID int64 `db:"org_id" json:"orgID"`
	//使用哪一家？
	// tencent / aliyun
	System string `db:"system" json:"system"`
	//来源系统的显示名称
	Name string `db:"name" json:"name"`
	//应用ID
	AppID string `db:"app_id" json:"appID"`
	//应用密钥
	AppKey string `db:"app_key" json:"appKey"`
	//默认过期时间
	DefaultExpire string `db:"default_expire" json:"defaultExpire"`
	//获取间隔时间 秒
	TimeSpacing int64 `db:"time_spacing" json:"timeSpacing"`
	//模版ID
	TemplateID string `db:"template_id" json:"templateID"`
	//签名名称
	TemplateSign string `db:"template_sign" json:"templateSign"`
	//扩展参数
	TemplateParams CoreSQLConfig.FieldsConfigsType `db:"template_params" json:"templateParams"`
	//扩展参数
	// mark: 'check' 验证码短信
	Params CoreSQLConfig.FieldsConfigsType `db:"params" json:"params"`
}

FieldsConfig 短信模版和配置信息结构

func CreateConfig

func CreateConfig(args *ArgsCreateConfig) (data FieldsConfig, err error)

CreateConfig 创建新配置

func GetConfigByID

func GetConfigByID(args *ArgsGetConfigByID) (data FieldsConfig, err error)

GetConfigByID 获取某个数据

func GetConfigList

func GetConfigList(args *ArgsGetConfigList) (dataList []FieldsConfig, dataCount int64, err error)

GetConfigList 获取列表

type FieldsSMS

type FieldsSMS struct {
	//ID
	ID int64 `db:"id" json:"id"`
	//创建时间
	CreateAt time.Time `db:"create_at" json:"createAt"`
	//组织ID
	OrgID int64 `db:"org_id" json:"orgID"`
	//过期时间
	// 过期后不清理数据，但存在保留的最大时间
	ExpireAt time.Time `db:"expire_at" json:"expireAt"`
	//发送时间
	SendAt time.Time `db:"send_at" json:"sendAt"`
	//失败原因
	// 如果为本地原因则显示错误代码，否则显示API提供方反馈信息
	FailedMsg string `db:"failed_msg" json:"failedMsg"`
	//是否已经验证
	// 仅用于验证码处理
	IsCheck bool `db:"is_check" json:"isCheck"`
	//配置ID
	ConfigID int64 `db:"config_id" json:"configID"`
	//会话
	Token int64 `db:"token" json:"token"`
	//国家代码
	NationCode string `db:"nation_code" json:"nationCode"`
	//目标手机号
	// 目标手机号是唯一的标识码
	Phone string `db:"phone" json:"phone"`
	//附带参数
	Params CoreSQLConfig.FieldsConfigsType `db:"params" json:"params"`
	//创建来源和创建来源ID
	FromInfo CoreSQLFrom.FieldsFrom `db:"from_info" json:"fromInfo"`
}

FieldsSMS 短信结构体

func CheckSMSAndData

func CheckSMSAndData(args *ArgsCheckSMSAndData) (data FieldsSMS, b bool)

CheckSMSAndData 验证并反馈验证码的数据结构

func GetSMSList

func GetSMSList(args *ArgsGetSMSList) (dataList []FieldsSMS, dataCount int64, err error)

GetSMSList 获取短信列表