Documentation
¶
Overview ¶
Package usms include resources of ucloud usms product
See also
- API: https://docs.ucloud.cn/api/usms-api/index
- Product: https://www.ucloud.cn/site/product/usms.html
for detail.
Index ¶
- type AddBackfillRequest
- type AddBackfillResponse
- type AddUSMSSignatureQualificationRequest
- type AddUSMSSignatureQualificationResponse
- type BatchInfo
- type CreateUSMSSignatureRequest
- type CreateUSMSSignatureResponse
- type CreateUSMSTemplateRequest
- type CreateUSMSTemplateResponse
- type DeleteUSMSSignatureQualificationRequest
- type DeleteUSMSSignatureQualificationResponse
- type DeleteUSMSSignatureRequest
- type DeleteUSMSSignatureResponse
- type DeleteUSMSTemplateRequest
- type DeleteUSMSTemplateResponse
- type FailPhoneDetail
- type GetUSMSSendReceiptRequest
- type GetUSMSSendReceiptResponse
- type GetUSMSSendStatisticsRequest
- type GetUSMSSendStatisticsResponse
- type GetUSMSSignatureQualificationRequest
- type GetUSMSSignatureQualificationResponse
- type GetUSMSTemplateSendStatisticsRequest
- type GetUSMSTemplateSendStatisticsResponse
- type OutSignature
- type OutSignatureQualification
- type OutSignatureQualificationDetail
- type OutTemplate
- type QueryUSMSSignatureQualificationRequest
- type QueryUSMSSignatureQualificationResponse
- type QueryUSMSSignatureRequest
- type QueryUSMSSignatureResponse
- type QueryUSMSTemplateRequest
- type QueryUSMSTemplateResponse
- type ReceiptPerPhone
- type ReceiptPerSession
- type SendBatchUSMSMessageRequest
- type SendBatchUSMSMessageResponse
- type SendUSMSMessageRequest
- type SendUSMSMessageResponse
- type StatisticsData
- type StatisticsDataInfo
- type TemplateStatisticsDataInfo
- type USMSClient
- func (c *USMSClient) AddBackfill(req *AddBackfillRequest) (*AddBackfillResponse, error)
- func (c *USMSClient) AddUSMSSignatureQualification(req *AddUSMSSignatureQualificationRequest) (*AddUSMSSignatureQualificationResponse, error)
- func (c *USMSClient) CreateUSMSSignature(req *CreateUSMSSignatureRequest) (*CreateUSMSSignatureResponse, error)
- func (c *USMSClient) CreateUSMSTemplate(req *CreateUSMSTemplateRequest) (*CreateUSMSTemplateResponse, error)
- func (c *USMSClient) DeleteUSMSSignature(req *DeleteUSMSSignatureRequest) (*DeleteUSMSSignatureResponse, error)
- func (c *USMSClient) DeleteUSMSSignatureQualification(req *DeleteUSMSSignatureQualificationRequest) (*DeleteUSMSSignatureQualificationResponse, error)
- func (c *USMSClient) DeleteUSMSTemplate(req *DeleteUSMSTemplateRequest) (*DeleteUSMSTemplateResponse, error)
- func (c *USMSClient) GetUSMSSendReceipt(req *GetUSMSSendReceiptRequest) (*GetUSMSSendReceiptResponse, error)
- func (c *USMSClient) GetUSMSSendStatistics(req *GetUSMSSendStatisticsRequest) (*GetUSMSSendStatisticsResponse, error)
- func (c *USMSClient) GetUSMSSignatureQualification(req *GetUSMSSignatureQualificationRequest) (*GetUSMSSignatureQualificationResponse, error)
- func (c *USMSClient) GetUSMSTemplateSendStatistics(req *GetUSMSTemplateSendStatisticsRequest) (*GetUSMSTemplateSendStatisticsResponse, error)
- func (c *USMSClient) NewAddBackfillRequest() *AddBackfillRequest
- func (c *USMSClient) NewAddUSMSSignatureQualificationRequest() *AddUSMSSignatureQualificationRequest
- func (c *USMSClient) NewCreateUSMSSignatureRequest() *CreateUSMSSignatureRequest
- func (c *USMSClient) NewCreateUSMSTemplateRequest() *CreateUSMSTemplateRequest
- func (c *USMSClient) NewDeleteUSMSSignatureQualificationRequest() *DeleteUSMSSignatureQualificationRequest
- func (c *USMSClient) NewDeleteUSMSSignatureRequest() *DeleteUSMSSignatureRequest
- func (c *USMSClient) NewDeleteUSMSTemplateRequest() *DeleteUSMSTemplateRequest
- func (c *USMSClient) NewGetUSMSSendReceiptRequest() *GetUSMSSendReceiptRequest
- func (c *USMSClient) NewGetUSMSSendStatisticsRequest() *GetUSMSSendStatisticsRequest
- func (c *USMSClient) NewGetUSMSSignatureQualificationRequest() *GetUSMSSignatureQualificationRequest
- func (c *USMSClient) NewGetUSMSTemplateSendStatisticsRequest() *GetUSMSTemplateSendStatisticsRequest
- func (c *USMSClient) NewQueryUSMSSignatureQualificationRequest() *QueryUSMSSignatureQualificationRequest
- func (c *USMSClient) NewQueryUSMSSignatureRequest() *QueryUSMSSignatureRequest
- func (c *USMSClient) NewQueryUSMSTemplateRequest() *QueryUSMSTemplateRequest
- func (c *USMSClient) NewSendBatchUSMSMessageRequest() *SendBatchUSMSMessageRequest
- func (c *USMSClient) NewSendUSMSMessageRequest() *SendUSMSMessageRequest
- func (c *USMSClient) NewUpdateUSMSSignatureQualificationRequest() *UpdateUSMSSignatureQualificationRequest
- func (c *USMSClient) NewUpdateUSMSSignatureRequest() *UpdateUSMSSignatureRequest
- func (c *USMSClient) NewUpdateUSMSTemplateRequest() *UpdateUSMSTemplateRequest
- func (c *USMSClient) NewUploadUSMSFileRequest() *UploadUSMSFileRequest
- func (c *USMSClient) QueryUSMSSignature(req *QueryUSMSSignatureRequest) (*QueryUSMSSignatureResponse, error)
- func (c *USMSClient) QueryUSMSSignatureQualification(req *QueryUSMSSignatureQualificationRequest) (*QueryUSMSSignatureQualificationResponse, error)
- func (c *USMSClient) QueryUSMSTemplate(req *QueryUSMSTemplateRequest) (*QueryUSMSTemplateResponse, error)
- func (c *USMSClient) SendBatchUSMSMessage(req *SendBatchUSMSMessageRequest) (*SendBatchUSMSMessageResponse, error)
- func (c *USMSClient) SendUSMSMessage(req *SendUSMSMessageRequest) (*SendUSMSMessageResponse, error)
- func (c *USMSClient) UpdateUSMSSignature(req *UpdateUSMSSignatureRequest) (*UpdateUSMSSignatureResponse, error)
- func (c *USMSClient) UpdateUSMSSignatureQualification(req *UpdateUSMSSignatureQualificationRequest) (*UpdateUSMSSignatureQualificationResponse, error)
- func (c *USMSClient) UpdateUSMSTemplate(req *UpdateUSMSTemplateRequest) (*UpdateUSMSTemplateResponse, error)
- func (c *USMSClient) UploadUSMSFile(req *UploadUSMSFileRequest) (*UploadUSMSFileResponse, error)
- type UpdateUSMSSignatureQualificationRequest
- type UpdateUSMSSignatureQualificationResponse
- type UpdateUSMSSignatureRequest
- type UpdateUSMSSignatureResponse
- type UpdateUSMSTemplateRequest
- type UpdateUSMSTemplateResponse
- type UploadUSMSFileRequest
- type UploadUSMSFileResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddBackfillRequest ¶ added in v0.22.11
type AddBackfillRequest struct {
request.CommonBase
// 回填时间,秒级别时间戳
BackfillTime *int `required:"false"`
// 回填内容
Content *string `required:"false"`
// 发送Number,记录一次发送请求的唯一性
SendNo *string `required:"true"`
// 发送请求的时间,秒级别时间戳
SendTime *int `required:"false"`
// 短信的接收目标,手机号需要添加国家码,比如(1)231xxxx
Target *string `required:"true"`
}
AddBackfillRequest is request schema for AddBackfill action
type AddBackfillResponse ¶ added in v0.22.11
type AddBackfillResponse struct {
response.CommonBase
// 返回错误消息。当 RetCode 非 0 时提供详细的描述信息
Message string
}
AddBackfillResponse is response schema for AddBackfill action
type AddUSMSSignatureQualificationRequest ¶ added in v0.22.38
type AddUSMSSignatureQualificationRequest struct {
request.CommonBase
// 资质属性,0-自用 1-他用
Attr *int `required:"true"`
// 公司证件文件FileId
CompanyCertificateFileId *string `required:"false"`
// 公司统一社会信用代码
CompanyCreditCode *string `required:"false"`
// 公司名称,长度限制100
CompanyName *string `required:"false"`
// 公司工作现场照片FileId
CompanyWorkScenePhotosFileId *string `required:"false"`
// 经办人手持身份证图片FileId
HandlerHandHeldImageFileId *string `required:"false"`
// 经办人身份证国徽面图片FileId
HandlerIDCardBackImageFileId *string `required:"false"`
// 经办人身份证人像面图片FileId
HandlerIDCardFrontImageFileId *string `required:"false"`
// 经办人身份证号码
HandlerIDNumber *string `required:"false"`
// 经办人姓名
HandlerName *string `required:"false"`
// 经办人手机号
HandlerPhone *string `required:"true"`
// 法人身份证号码
ManagerIDNumber *string `required:"false"`
// 法人姓名
ManagerName *string `required:"false"`
// 法人手机号
ManagerPhone *string `required:"false"`
// 资质名称
Name *string `required:"true"`
// 状态:0-草稿,1-提交审核
Status *int `required:"true"`
}
AddUSMSSignatureQualificationRequest is request schema for AddUSMSSignatureQualification action
type AddUSMSSignatureQualificationResponse ¶ added in v0.22.38
type AddUSMSSignatureQualificationResponse struct {
response.CommonBase
// 返回状态码描述,如果操作成功,默认返回为空
Message string
// 资质Id
QualificationId string
}
AddUSMSSignatureQualificationResponse is response schema for AddUSMSSignatureQualification action
type BatchInfo ¶ added in v0.21.10
type BatchInfo struct {
// 未能成功发送的详情。注:模板/签名检验失败时,该字段有效
FailureDetails string
// 签名
SigContent string
// 具体号码信息
Target []FailPhoneDetail
// 模板ID
TemplateId string
}
BatchInfo - 批量发送任务中未能成功发送的信息详情,“模板+签名”粒度
type CreateUSMSSignatureRequest ¶
type CreateUSMSSignatureRequest struct {
request.CommonBase
// 签名的资质证明文件类型,需与签名类型保持一致,说明如下:0-三证合一/企业营业执照/组织机构代码证书/社会信用代码证书;1-应用商店后台开发者管理截图;2-备案服务商的备案成功截图(含域名,网站名称,备案号);3-公众号或小程序的管理界面截图;4-商标注册证书;5-组织机构代码证书、社会信用代码证书;
CertificateType *int `required:"true"`
// 短信签名申请原因
Description *string `required:"true"`
// 短信签名的资质证明文件,需先进行base64编码格式转换,此处填写转换后的字符串。文件大小不超过4 MB
File *string `required:"false"`
// 国内/国际短信。true:国际短信,false:国内短信,若不传值则默认该值为false
International *bool `required:"false"`
// 短信签名授权委托文件,需先进行base64编码格式转换,此处填写转换后的字符串。文件大小不超过4 MB;当您是代理并使用第三方的签名时(也即SigPurpose为1-他用),该项为必填项;
ProxyFile *string `required:"false"`
// 资质ID
QualificationId *string `required:"false"`
// 短信签名对应的场景说明
SceneDesc *string `required:"false"`
// 签名内容
SigContent *string `required:"true"`
// 签名用途,0-自用,1-他用;
SigPurpose *int `required:"true"`
// 签名类型,说明如下:0-公司或企业的全称或简称;1-App应用的全称或简称;2-工信部备案网站的全称或简称;3-公众号或小程序的全称或简称;4-商标名的全称或简称;5-政府/机关事业单位/其他单位的全称或简称;
SigType *int `required:"true"`
}
CreateUSMSSignatureRequest is request schema for CreateUSMSSignature action
type CreateUSMSSignatureResponse ¶
type CreateUSMSSignatureResponse struct {
response.CommonBase
// 返回状态码描述,如果操作成功,默认返回为空
Message string
// 短信签名ID(短信签名申请时的工单ID)
SigId string
}
CreateUSMSSignatureResponse is response schema for CreateUSMSSignature action
type CreateUSMSTemplateRequest ¶
type CreateUSMSTemplateRequest struct {
request.CommonBase
// 模板变量属性说明
Instruction *string `required:"false"`
// 标记是否为国际短信。true:国际短信,false:国内短信,若不传值则默认该值为false
International *bool `required:"false"`
// 短信模板用途类型:1-验证码类短信模板;2-系统通知类短信模板;3-会员推广类短信模板;
Purpose *int `required:"true"`
// 短信模板申请原因说明,字数不超过128,每个中文、符号、英文、数字等都计为1个字。
Remark *string `required:"false"`
// 短信模板内容,说明如下:字数不超过500,每个中文、符号、英文、数组等都计为一个字;模板中的变量填写格式:{N},其中N为大于1的整数,有多个参数时,建议N从1开始顺次,例如:{1}、{2}等;短信模板禁止仅包括变量的情况;
Template *string `required:"true"`
// 短信模板名称,不超过32个字符,每个中文、符号、英文、数字等都计为1个字。
TemplateName *string `required:"true"`
// 当Purpose=3并且International=false时,也即国内会员推广类短信模板,该项必填。枚举值:【拒收请回复R】
UnsubscribeInfo *string `required:"false"`
}
CreateUSMSTemplateRequest is request schema for CreateUSMSTemplate action
type CreateUSMSTemplateResponse ¶
type CreateUSMSTemplateResponse struct {
response.CommonBase
// 返回状态码描述,如果操作成功,默认返回为空
Message string
// 短信模板ID(短信模板申请时的工单ID)
TemplateId string
}
CreateUSMSTemplateResponse is response schema for CreateUSMSTemplate action
type DeleteUSMSSignatureQualificationRequest ¶ added in v0.22.38
type DeleteUSMSSignatureQualificationRequest struct {
request.CommonBase
// 签名资质Id,支持以数组的方式,举例,以QualificationIds.0、QualificationIds.1...QualificationIds.N方式传入
QualificationIds []string `required:"true"`
}
DeleteUSMSSignatureQualificationRequest is request schema for DeleteUSMSSignatureQualification action
type DeleteUSMSSignatureQualificationResponse ¶ added in v0.22.38
type DeleteUSMSSignatureQualificationResponse struct {
response.CommonBase
// 返回状态码描述,如果操作成功,默认返回为空
Message string
}
DeleteUSMSSignatureQualificationResponse is response schema for DeleteUSMSSignatureQualification action
type DeleteUSMSSignatureRequest ¶
type DeleteUSMSSignatureRequest struct {
request.CommonBase
// 签名ID(也即短信签名申请时的工单ID),支持以数组的方式,举例,以SigIds.0、SigIds.1...SigIds.N方式传入
SigIds []string `required:"true"`
}
DeleteUSMSSignatureRequest is request schema for DeleteUSMSSignature action
type DeleteUSMSSignatureResponse ¶
type DeleteUSMSSignatureResponse struct {
response.CommonBase
// 返回状态码描述,如果操作成功,默认返回为空
Message string
}
DeleteUSMSSignatureResponse is response schema for DeleteUSMSSignature action
type DeleteUSMSTemplateRequest ¶
type DeleteUSMSTemplateRequest struct {
request.CommonBase
// 模板ID(也即短信模板申请时的工单ID),支持以数组的方式,举例,以TemplateIds.0、TemplateIds.1...TemplateIds.N方式传入
TemplateIds []string `required:"true"`
}
DeleteUSMSTemplateRequest is request schema for DeleteUSMSTemplate action
type DeleteUSMSTemplateResponse ¶
type DeleteUSMSTemplateResponse struct {
response.CommonBase
// 返回状态码描述,如果操作成功,默认返回为空
Message string
}
DeleteUSMSTemplateResponse is response schema for DeleteUSMSTemplate action
type FailPhoneDetail ¶ added in v0.21.10
type FailPhoneDetail struct {
// 扩展号码
ExtendCode string
// 发送失败原因。注:若模板/签名校验失败,该字段为空
FailureDetails string
// 手机号
Phone string
// 模板参数
TemplateParams []string
// 用户自定义ID
UserId string
}
FailPhoneDetail - 批量任务中,未能成功发送的号码及其原因
type GetUSMSSendReceiptRequest ¶
type GetUSMSSendReceiptRequest struct {
request.CommonBase
// 发送短信时返回的SessionNo集合,SessionNoSet.0,SessionNoSet.1....格式,单次调用集合数需控制在100个以内
SessionNoSet []string `required:"true"`
}
GetUSMSSendReceiptRequest is request schema for GetUSMSSendReceipt action
type GetUSMSSendReceiptResponse ¶
type GetUSMSSendReceiptResponse struct {
response.CommonBase
// 回执信息集合
Data []ReceiptPerSession
// 错误描述
Message string
}
GetUSMSSendReceiptResponse is response schema for GetUSMSSendReceipt action
type GetUSMSSendStatisticsRequest ¶ added in v0.22.23
type GetUSMSSendStatisticsRequest struct {
request.CommonBase
// 国际简码,如CN表示中国,当需要查询多个国家时,使用-分割,如CN-ID。
BrevityCode *string `required:"false"`
// 国内标记,0-国际短信 1-国内短信
Domestic *int `required:"true"`
// 结束日期,格式为YYYY-MM-DD
EndDate *string `required:"true"`
// 每页记录个数
NumPerPage *int `required:"true"`
// 排序字段,如BrevityCode表示按照BrevityCode排列,配合OrderType使用。目前支持SendDate、BrevityCode
OrderBy *string `required:"true"`
// 排序方式,asc-正序 desc-倒序
OrderType *string `required:"true"`
// 页编号,从0开始
Page *int `required:"true"`
// 短信类型,1-验证码 2-通知类 3-营销类
Purpose *int `required:"false"`
// 开始日期,格式为YYYY-MM-DD
StartDate *string `required:"true"`
}
GetUSMSSendStatisticsRequest is request schema for GetUSMSSendStatistics action
type GetUSMSSendStatisticsResponse ¶ added in v0.22.23
type GetUSMSSendStatisticsResponse struct {
response.CommonBase
// 以天为统计维度的发送数据统计集合,每天的统计数据字段详见StatisticsDataInfo模型
Data []StatisticsDataInfo
// 描述信息
Message string
// 符合查询条件的发送数据统计求和集,具体字段信息见StatisticsData模型
StatisticsData StatisticsData
// 返回记录数
Total int
}
GetUSMSSendStatisticsResponse is response schema for GetUSMSSendStatistics action
type GetUSMSSignatureQualificationRequest ¶ added in v0.22.38
type GetUSMSSignatureQualificationRequest struct {
request.CommonBase
// 项目ID列表
InAccountIds []string `required:"false"`
// 每页个数
NumPerPage *int `required:"true"`
// 排序字段,QualificationId/CreateTime
OrderBy *string `required:"true"`
// 排序类型: desc、asc
OrderType *string `required:"true"`
// 页索引
Page *int `required:"true"`
// 签名资质属性: 0-自用,1-他用
QualificationAttr *int `required:"false"`
// 签名资质状态: 0-草稿 1-审核中 2-审核通过 3-审核未通过 4-人工禁用
Status *int `required:"false"`
}
GetUSMSSignatureQualificationRequest is request schema for GetUSMSSignatureQualification action
type GetUSMSSignatureQualificationResponse ¶ added in v0.22.38
type GetUSMSSignatureQualificationResponse struct {
response.CommonBase
// 签名资质结果集合
Data []OutSignatureQualification
// 返回状态码描述,如果操作成功,默认返回为空
Message string
// 签名资质总个数
Total int
}
GetUSMSSignatureQualificationResponse is response schema for GetUSMSSignatureQualification action
type GetUSMSTemplateSendStatisticsRequest ¶ added in v0.22.44
type GetUSMSTemplateSendStatisticsRequest struct {
request.CommonBase
// 国际简码,如CN表示中国,当需要查询多个国家时,使用-分割,如CN-ID。
BrevityCode *string `required:"false"`
// 国内标记,0-国际短信 1-国内短信
Domestic *int `required:"true"`
// 结束日期,格式为YYYY-MM-DD
EndDate *string `required:"true"`
// 每页记录个数
NumPerPage *int `required:"true"`
// 排序字段,如BrevityCode表示按照BrevityCode排列,配合OrderType使用。目前支持SendDate、BrevityCode
OrderBy *string `required:"true"`
// 排序方式,asc-正序 desc-倒序
OrderType *string `required:"true"`
// 页编号,从0开始
Page *int `required:"true"`
// 开始日期,格式为YYYY-MM-DD
StartDate *string `required:"true"`
// 短信模板ID
TemplateId *string `required:"false"`
}
GetUSMSTemplateSendStatisticsRequest is request schema for GetUSMSTemplateSendStatistics action
type GetUSMSTemplateSendStatisticsResponse ¶ added in v0.22.44
type GetUSMSTemplateSendStatisticsResponse struct {
response.CommonBase
// 以天为统计维度的发送数据统计集合,每天的统计数据字段详见TemplateStatisticsDataInfo模型
Data []TemplateStatisticsDataInfo
// 描述信息
Message string
// 符合查询条件的发送数据统计求和集,具体字段信息见StatisticsData模型
StatisticsData StatisticsData
// 返回记录数
Total int
}
GetUSMSTemplateSendStatisticsResponse is response schema for GetUSMSTemplateSendStatistics action
type OutSignature ¶
type OutSignature struct {
// 签名审核失败原因
ErrDesc string
// 签名内容
SigContent string
// 签名ID
SigId string
// 签名状态。0-待审核 1-审核中 2-审核通过 3-审核未通过 4-被禁用
Status int
}
OutSignature - 短信签名
type OutSignatureQualification ¶ added in v0.22.38
type OutSignatureQualification struct {
// 项目Id
AccountId int
// 资质属性: 0-自用 1-他用
Attr int
// 公司名称
CompanyName string
// 创建时间戳
CreateTime int
// 审核未通过错误码
ErrCode int
// 审核未通过错误原因
ErrDesc string
// 经办人姓名
HandlerName string
// 负责人姓名
ManagerName string
// 修改时间戳
ModifyTime int
// 资质名称
Name string
// 资质Id
QualificationId string
// 审核完成时间戳
ReviewEndTime int
// 审核开始时间戳
ReviewStartTime int
// 状态:0-草稿 1-审核中 2-审核通过 3-审核未通过 4-人工禁用
Status int
}
OutSignatureQualification -
type OutSignatureQualificationDetail ¶ added in v0.22.38
type OutSignatureQualificationDetail struct {
// 资质属性:0-自用,1-他用
Attr int
// 公司证件文件链接
CompanyCertificateFile string
// 统一社会信用代码
CompanyCreditCode string
// 公司名称
CompanyName string
// 工作现场照片链接
CompanyWorkScenePhotos string
// 创建时间戳
CreateTime int
// 审核未通过错误码
ErrCode int
// 审核未通过错误原因
ErrDesc string
// 经办人手持身份证图片链接
HandlerHandHeldImage string
// 经办人身份证国徽面图片链接
HandlerIDCardBackImage string
// 经办人身份证人像面图片链接
HandlerIDCardFrontImage string
// 经办人证件号码
HandlerIDNumber string
// 经办人姓名
HandlerName string
// 经办人手机号
HandlerPhone string
// 负责人证件号码
ManagerIDNumber string
// 负责人姓名
ManagerName string
// 负责人手机号
ManagerPhone string
// 修改时间戳
ModifyTime int
// 资质名称
Name string
// 授权委托书文件链接
PowerOfAttorney string
// 资质Id
QualificationId string
// 审核完成时间戳
ReviewEndTime int
// 审核开始时间戳
ReviewStartTime int
// 状态:0-草稿 1-审核中 2-审核通过 3-审核未通过 4-人工禁用
Status int
}
OutSignatureQualificationDetail - 签名资质详情
type OutTemplate ¶
type OutTemplate struct {
// 创建时间
CreateTime int
// 审核失败原因
ErrDesc string
// 模板变量属性说明
Instruction string
// 模板类型,选项:1-验证码类 2-通知类 3-会员推广类
Purpose int
// 模板说明
Remark string
// 短信模板状态;状态说明:0-待审核,1-审核中,2-审核通过,3-审核未通过,4-被禁用
Status int
// 短信模板内容
Template string
// 短信模板ID
TemplateId string
// 短信模板名称
TemplateName string
// 退订信息;一般填写方式“回T退订”,当purpose为3(也即会员推广类)时,为必填项
UnsubscribeInfo string
}
OutTemplate - 短信模板
type QueryUSMSSignatureQualificationRequest ¶ added in v0.22.38
type QueryUSMSSignatureQualificationRequest struct {
request.CommonBase
// 签名资质Id
QualificationId *string `required:"true"`
}
QueryUSMSSignatureQualificationRequest is request schema for QueryUSMSSignatureQualification action
type QueryUSMSSignatureQualificationResponse ¶ added in v0.22.38
type QueryUSMSSignatureQualificationResponse struct {
response.CommonBase
// 签名资质详细信息
Data OutSignatureQualificationDetail
// 返回状态码描述,如果操作成功,默认返回为空
Message string
}
QueryUSMSSignatureQualificationResponse is response schema for QueryUSMSSignatureQualification action
type QueryUSMSSignatureRequest ¶
type QueryUSMSSignatureRequest struct {
request.CommonBase
// 签名内容;签名ID和签名至少需填写1项;
SigContent *string `required:"false"`
// 已申请的短信签名ID(短信签名申请时的工单ID);签名ID和签名至少需填写1项;
SigId *string `required:"false"`
}
QueryUSMSSignatureRequest is request schema for QueryUSMSSignature action
type QueryUSMSSignatureResponse ¶
type QueryUSMSSignatureResponse struct {
response.CommonBase
// 签名信息
Data OutSignature
// 发生错误时,表示具体错误描述
Message string
}
QueryUSMSSignatureResponse is response schema for QueryUSMSSignature action
type QueryUSMSTemplateRequest ¶
type QueryUSMSTemplateRequest struct {
request.CommonBase
// 模板ID
TemplateId *string `required:"true"`
}
QueryUSMSTemplateRequest is request schema for QueryUSMSTemplate action
type QueryUSMSTemplateResponse ¶
type QueryUSMSTemplateResponse struct {
response.CommonBase
// 短信模板明细信息,各字段说明详见OutTemplate
Data OutTemplate
// 当RetCode不为0时,Message中显示具体错误描述
Message string
}
QueryUSMSTemplateResponse is response schema for QueryUSMSTemplate action
type ReceiptPerPhone ¶
type ReceiptPerPhone struct {
// 消耗短信条数
CostCount int
// 手机号码
Phone string
// 状态报告编码
ReceiptCode string
// 回执结果描述
ReceiptDesc string
// 回执结果,枚举值:\\ > 发送成功: 代表成功 \\ > Success: 代表成功 \\ > 发送失败: 代表失败 \\ > Fail: 代表失败 \\ > 状态未知: 代表未知 \\ > Unknow: 代表未知
ReceiptResult string
// 回执返回时间
ReceiptTime int
// 自定义的业务标识ID,字符串
UserId string
}
ReceiptPerPhone - 每个目的手机号的发送回执信息
type ReceiptPerSession ¶
type ReceiptPerSession struct {
// 每个手机号的短信回执信息集合
ReceiptSet []ReceiptPerPhone
// 发送短信时返回的SessionNo
SessionNo string
}
ReceiptPerSession - 每个提交的回执结果集合
type SendBatchUSMSMessageRequest ¶ added in v0.21.10
type SendBatchUSMSMessageRequest struct {
request.CommonBase
// 批量发送内容,该参数是json数组的base64编码结果。发送内容json数组中,每个“模板+签名”组合作为一个子项,每个子项内支持多个号码,示例:发送内容json数组(base64编码前):[{"TemplateId": "UTA20212831C85C", "SigContent": "UCloud", "Target": [{"TemplateParams": ["123456"], "Phone": "18500000123", "ExtendCode": "123", "UserId": "456"} ] } ] 。json数组中各参数的定义:"TemplateId":模板ID,"SigContent"短信签名内容,"Target"具体到号码粒度的发送内容。"Target"中的具体字段有:"TemplateParams"实际发送的模板参数(若使用的是无参数模板,该参数不能传值),"Phone"手机号码, "ExtendCode"短信扩展码, "UserId"自定义业务标识ID。其中必传参数为"TemplateId", "SigContent", "Target"("Target"中必传参数为"Phone")。实际调用本接口时TaskContent传值(发送内容base64编码后)为:W3siVGVtcGxhdGVJZCI6ICJVVEEyMDIxMjgzMUM4NUMiLCAiU2lnQ29udGVudCI6ICJVQ2xvdWQiLCAiVGFyZ2V0IjogW3siVGVtcGxhdGVQYXJhbXMiOiBbIjEyMzQ1NiJdLCAiUGhvbmUiOiAiMTg1MDAwMDAxMjMiLCAiRXh0ZW5kQ29kZSI6ICIxMjMiLCAiVXNlcklkIjogIjQ1NiJ9IF0gfSBdIA==
TaskContent *string `required:"true"`
}
SendBatchUSMSMessageRequest is request schema for SendBatchUSMSMessage action
type SendBatchUSMSMessageResponse ¶ added in v0.21.10
type SendBatchUSMSMessageResponse struct {
response.CommonBase
// 未发送成功的详情,返回码非0时该字段有效,可根据该字段数据重发
FailContent []BatchInfo
// 发生错误时表示错误描述
Message string
// 本次请求Uuid
ReqUuid string
// 本次提交发送任务的唯一ID,可根据该值查询本次发送的短信列表。注:成功提交短信数大于0时,才返回该字段
SessionNo string
// 成功提交短信(未拆分)条数
SuccessCount int
}
SendBatchUSMSMessageResponse is response schema for SendBatchUSMSMessage action
type SendUSMSMessageRequest ¶
type SendUSMSMessageRequest struct {
request.CommonBase
// 短信扩展码,格式为阿拉伯数字串,默认不开通,如需开通请联系 UCloud技术支持
ExtendCode *string `required:"false"`
// 电话号码数组,电话号码格式为(60)1xxxxxxxx,()中为国际长途区号(如中国为86或0086,两种格式都支持),后面为电话号码.若不传入国际区号,如1851623xxxx,则默认为国内手机号
PhoneNumbers []string `required:"true"`
// 短信签名内容,请到[USMS控制台](https://console.ucloud.cn/usms)的签名管理页面查看;使用的短信签名必须是已申请并且通过审核;(注:国内短信为必选参数、国际短信为可选参数)
SigContent *string `required:"false"`
// 模板ID(也即短信模板申请时的工单ID),请到[USMS控制台](https://console.ucloud.cn/usms)的模板管理页面查看;使用的短信模板必须是已申请并通过审核;
TemplateId *string `required:"true"`
// 模板可变参数,以数组的方式填写,举例,TemplateParams.0,TemplateParams.1,... 若模板中无可变参数,则该项可不填写;若模板中有可变参数,则该项为必填项,参数个数需与变量个数保持一致,否则无法发送;
TemplateParams []string `required:"false"`
// 自定义的业务标识ID,字符串( 长度不能超过32 位),不支持 单引号、表情包符号等特殊字符
UserId *string `required:"false"`
}
SendUSMSMessageRequest is request schema for SendUSMSMessage action
type SendUSMSMessageResponse ¶
type SendUSMSMessageResponse struct {
response.CommonBase
// 发生错误时表示错误描述
Message string
// 本次提交发送的短信的唯一ID,可根据该值查询本次发送的短信列表
SessionNo string
// 本次提交的自定义业务标识ID,仅当发送时传入有效的UserId,才返回该字段。
UserId string
}
SendUSMSMessageResponse is response schema for SendUSMSMessage action
type StatisticsData ¶ added in v0.22.23
type StatisticsData struct {
// 发送失败数(拆分条数)
FailCostCount int
// 发送失败数(提交条数)
FailCount int
// 发送总数(拆分条数)
SendCostCount int
// 发送总数(提交条数)
SendCount int
// 提交失败数(拆分条数)
SubmitFailCostCount int
// 提交失败数(提交条数)
SubmitFailCount int
// 发送成功数(拆分条数)
SuccessCostCount int
// 发送成功数(提交条数)
SuccessCount int
// 状态未知数(拆分条数)
UnknownCostCount int
// 状态未知数(提交条数)
UnknownCount int
}
StatisticsData - 统计信息
type StatisticsDataInfo ¶ added in v0.22.23
type StatisticsDataInfo struct {
// 国际/地区标识码
BrevityCode string
// 发送总数(拆分条数)
CostCount int
// 发送总数(提交条数)
Count int
// 发送失败数(拆分条数)
FailedCostCount int
// 发送失败数(提交条数)
FailedCount int
// 发送时间
SendDate string
// 提交失败数(拆分条数)
SubmitFailedCostCount int
// 提交失败数(提交条数)
SubmitFailedCount int
// 发送成功数(拆分条数)
SuccessCostCount int
// 发送成功数(提交条数)
SuccessCount int
// 发送成功率
SuccessRate float64
// 状态未知数(拆分条数)
UnknownCostCount int
// 状态未知数(提交条数)
UnknownCount int
// UserId
UserId string
}
StatisticsDataInfo - 统计信息按天聚合
type TemplateStatisticsDataInfo ¶ added in v0.22.44
type TemplateStatisticsDataInfo struct {
// 国际/地区标识码
BrevityCode string
// 发送总数(拆分条数)
CostCount int
// 发送总数(提交条数)
Count int
// 发送失败数(拆分条数)
FailedCostCount int
// 发送失败数(提交条数)
FailedCount int
// 发送时间
SendDate string
// 提交失败数(拆分条数)
SubmitFailedCostCount int
// 提交失败数(提交条数)
SubmitFailedCount int
// 发送成功数(拆分条数)
SuccessCostCount int
// 发送成功数(提交条数)
SuccessCount int
// 短信模板ID
TemplateId string
// 状态未知数(拆分条数)
UnknownCostCount int
// 状态未知数(提交条数)
UnknownCount int
}
TemplateStatisticsDataInfo - 模版统计信息按天聚合
type USMSClient ¶
USMSClient is the client of USMS
func NewClient ¶
func NewClient(config *ucloud.Config, credential *auth.Credential) *USMSClient
NewClient will return a instance of USMSClient
func (*USMSClient) AddBackfill ¶ added in v0.22.11
func (c *USMSClient) AddBackfill(req *AddBackfillRequest) (*AddBackfillResponse, error)
API: AddBackfill
用户通过接口发送消息,当消息在终端被消费,调用该接口,进行记录。
func (*USMSClient) AddUSMSSignatureQualification ¶ added in v0.22.38
func (c *USMSClient) AddUSMSSignatureQualification(req *AddUSMSSignatureQualificationRequest) (*AddUSMSSignatureQualificationResponse, error)
API: AddUSMSSignatureQualification
添加短信签名资质申请记录
func (*USMSClient) CreateUSMSSignature ¶
func (c *USMSClient) CreateUSMSSignature(req *CreateUSMSSignatureRequest) (*CreateUSMSSignatureResponse, error)
API: CreateUSMSSignature
调用接口CreateUSMSSignature申请短信签名
func (*USMSClient) CreateUSMSTemplate ¶
func (c *USMSClient) CreateUSMSTemplate(req *CreateUSMSTemplateRequest) (*CreateUSMSTemplateResponse, error)
API: CreateUSMSTemplate
调用接口CreateUSMSTemplate申请短信模板
func (*USMSClient) DeleteUSMSSignature ¶
func (c *USMSClient) DeleteUSMSSignature(req *DeleteUSMSSignatureRequest) (*DeleteUSMSSignatureResponse, error)
API: DeleteUSMSSignature
调用接口DeleteUSMSSignature删除短信签名
func (*USMSClient) DeleteUSMSSignatureQualification ¶ added in v0.22.38
func (c *USMSClient) DeleteUSMSSignatureQualification(req *DeleteUSMSSignatureQualificationRequest) (*DeleteUSMSSignatureQualificationResponse, error)
API: DeleteUSMSSignatureQualification
删除短信签名资质申请记录
func (*USMSClient) DeleteUSMSTemplate ¶
func (c *USMSClient) DeleteUSMSTemplate(req *DeleteUSMSTemplateRequest) (*DeleteUSMSTemplateResponse, error)
API: DeleteUSMSTemplate
调用接口DeleteUSMSTemplate删除短信模板
func (*USMSClient) GetUSMSSendReceipt ¶
func (c *USMSClient) GetUSMSSendReceipt(req *GetUSMSSendReceiptRequest) (*GetUSMSSendReceiptResponse, error)
API: GetUSMSSendReceipt
调用接口GetUSMSSendReceipt短信发送状态信息
func (*USMSClient) GetUSMSSendStatistics ¶ added in v0.22.23
func (c *USMSClient) GetUSMSSendStatistics(req *GetUSMSSendStatisticsRequest) (*GetUSMSSendStatisticsResponse, error)
API: GetUSMSSendStatistics
获取发送统计数据
func (*USMSClient) GetUSMSSignatureQualification ¶ added in v0.22.38
func (c *USMSClient) GetUSMSSignatureQualification(req *GetUSMSSignatureQualificationRequest) (*GetUSMSSignatureQualificationResponse, error)
API: GetUSMSSignatureQualification
获取短信签名资质申请记录列表
func (*USMSClient) GetUSMSTemplateSendStatistics ¶ added in v0.22.44
func (c *USMSClient) GetUSMSTemplateSendStatistics(req *GetUSMSTemplateSendStatisticsRequest) (*GetUSMSTemplateSendStatisticsResponse, error)
API: GetUSMSTemplateSendStatistics
获取模板发送统计数据
func (*USMSClient) NewAddBackfillRequest ¶ added in v0.22.11
func (c *USMSClient) NewAddBackfillRequest() *AddBackfillRequest
NewAddBackfillRequest will create request of AddBackfill action.
func (*USMSClient) NewAddUSMSSignatureQualificationRequest ¶ added in v0.22.38
func (c *USMSClient) NewAddUSMSSignatureQualificationRequest() *AddUSMSSignatureQualificationRequest
NewAddUSMSSignatureQualificationRequest will create request of AddUSMSSignatureQualification action.
func (*USMSClient) NewCreateUSMSSignatureRequest ¶
func (c *USMSClient) NewCreateUSMSSignatureRequest() *CreateUSMSSignatureRequest
NewCreateUSMSSignatureRequest will create request of CreateUSMSSignature action.
func (*USMSClient) NewCreateUSMSTemplateRequest ¶
func (c *USMSClient) NewCreateUSMSTemplateRequest() *CreateUSMSTemplateRequest
NewCreateUSMSTemplateRequest will create request of CreateUSMSTemplate action.
func (*USMSClient) NewDeleteUSMSSignatureQualificationRequest ¶ added in v0.22.38
func (c *USMSClient) NewDeleteUSMSSignatureQualificationRequest() *DeleteUSMSSignatureQualificationRequest
NewDeleteUSMSSignatureQualificationRequest will create request of DeleteUSMSSignatureQualification action.
func (*USMSClient) NewDeleteUSMSSignatureRequest ¶
func (c *USMSClient) NewDeleteUSMSSignatureRequest() *DeleteUSMSSignatureRequest
NewDeleteUSMSSignatureRequest will create request of DeleteUSMSSignature action.
func (*USMSClient) NewDeleteUSMSTemplateRequest ¶
func (c *USMSClient) NewDeleteUSMSTemplateRequest() *DeleteUSMSTemplateRequest
NewDeleteUSMSTemplateRequest will create request of DeleteUSMSTemplate action.
func (*USMSClient) NewGetUSMSSendReceiptRequest ¶
func (c *USMSClient) NewGetUSMSSendReceiptRequest() *GetUSMSSendReceiptRequest
NewGetUSMSSendReceiptRequest will create request of GetUSMSSendReceipt action.
func (*USMSClient) NewGetUSMSSendStatisticsRequest ¶ added in v0.22.23
func (c *USMSClient) NewGetUSMSSendStatisticsRequest() *GetUSMSSendStatisticsRequest
NewGetUSMSSendStatisticsRequest will create request of GetUSMSSendStatistics action.
func (*USMSClient) NewGetUSMSSignatureQualificationRequest ¶ added in v0.22.38
func (c *USMSClient) NewGetUSMSSignatureQualificationRequest() *GetUSMSSignatureQualificationRequest
NewGetUSMSSignatureQualificationRequest will create request of GetUSMSSignatureQualification action.
func (*USMSClient) NewGetUSMSTemplateSendStatisticsRequest ¶ added in v0.22.44
func (c *USMSClient) NewGetUSMSTemplateSendStatisticsRequest() *GetUSMSTemplateSendStatisticsRequest
NewGetUSMSTemplateSendStatisticsRequest will create request of GetUSMSTemplateSendStatistics action.
func (*USMSClient) NewQueryUSMSSignatureQualificationRequest ¶ added in v0.22.38
func (c *USMSClient) NewQueryUSMSSignatureQualificationRequest() *QueryUSMSSignatureQualificationRequest
NewQueryUSMSSignatureQualificationRequest will create request of QueryUSMSSignatureQualification action.
func (*USMSClient) NewQueryUSMSSignatureRequest ¶
func (c *USMSClient) NewQueryUSMSSignatureRequest() *QueryUSMSSignatureRequest
NewQueryUSMSSignatureRequest will create request of QueryUSMSSignature action.
func (*USMSClient) NewQueryUSMSTemplateRequest ¶
func (c *USMSClient) NewQueryUSMSTemplateRequest() *QueryUSMSTemplateRequest
NewQueryUSMSTemplateRequest will create request of QueryUSMSTemplate action.
func (*USMSClient) NewSendBatchUSMSMessageRequest ¶ added in v0.21.10
func (c *USMSClient) NewSendBatchUSMSMessageRequest() *SendBatchUSMSMessageRequest
NewSendBatchUSMSMessageRequest will create request of SendBatchUSMSMessage action.
func (*USMSClient) NewSendUSMSMessageRequest ¶
func (c *USMSClient) NewSendUSMSMessageRequest() *SendUSMSMessageRequest
NewSendUSMSMessageRequest will create request of SendUSMSMessage action.
func (*USMSClient) NewUpdateUSMSSignatureQualificationRequest ¶ added in v0.22.38
func (c *USMSClient) NewUpdateUSMSSignatureQualificationRequest() *UpdateUSMSSignatureQualificationRequest
NewUpdateUSMSSignatureQualificationRequest will create request of UpdateUSMSSignatureQualification action.
func (*USMSClient) NewUpdateUSMSSignatureRequest ¶
func (c *USMSClient) NewUpdateUSMSSignatureRequest() *UpdateUSMSSignatureRequest
NewUpdateUSMSSignatureRequest will create request of UpdateUSMSSignature action.
func (*USMSClient) NewUpdateUSMSTemplateRequest ¶
func (c *USMSClient) NewUpdateUSMSTemplateRequest() *UpdateUSMSTemplateRequest
NewUpdateUSMSTemplateRequest will create request of UpdateUSMSTemplate action.
func (*USMSClient) NewUploadUSMSFileRequest ¶ added in v0.22.38
func (c *USMSClient) NewUploadUSMSFileRequest() *UploadUSMSFileRequest
NewUploadUSMSFileRequest will create request of UploadUSMSFile action.
func (*USMSClient) QueryUSMSSignature ¶
func (c *USMSClient) QueryUSMSSignature(req *QueryUSMSSignatureRequest) (*QueryUSMSSignatureResponse, error)
API: QueryUSMSSignature
调用接口QueryUSMSSignature查询短信签名申请状态
func (*USMSClient) QueryUSMSSignatureQualification ¶ added in v0.22.38
func (c *USMSClient) QueryUSMSSignatureQualification(req *QueryUSMSSignatureQualificationRequest) (*QueryUSMSSignatureQualificationResponse, error)
API: QueryUSMSSignatureQualification
获取短信签名资质申请记录详情
func (*USMSClient) QueryUSMSTemplate ¶
func (c *USMSClient) QueryUSMSTemplate(req *QueryUSMSTemplateRequest) (*QueryUSMSTemplateResponse, error)
API: QueryUSMSTemplate
调用接口QueryUSMSTemplate查询短信模板申请状态
func (*USMSClient) SendBatchUSMSMessage ¶ added in v0.21.10
func (c *USMSClient) SendBatchUSMSMessage(req *SendBatchUSMSMessageRequest) (*SendBatchUSMSMessageResponse, error)
API: SendBatchUSMSMessage
调用SendBatchUSMSMessage接口批量发送短信
func (*USMSClient) SendUSMSMessage ¶
func (c *USMSClient) SendUSMSMessage(req *SendUSMSMessageRequest) (*SendUSMSMessageResponse, error)
API: SendUSMSMessage
调用接口SendUSMSMessage发送短信
func (*USMSClient) UpdateUSMSSignature ¶
func (c *USMSClient) UpdateUSMSSignature(req *UpdateUSMSSignatureRequest) (*UpdateUSMSSignatureResponse, error)
API: UpdateUSMSSignature
调用接口UpdateUSMSSignature修改未通过审核的短信签名,并重新提交审核
func (*USMSClient) UpdateUSMSSignatureQualification ¶ added in v0.22.38
func (c *USMSClient) UpdateUSMSSignatureQualification(req *UpdateUSMSSignatureQualificationRequest) (*UpdateUSMSSignatureQualificationResponse, error)
API: UpdateUSMSSignatureQualification
修改短信签名资质申请记录
func (*USMSClient) UpdateUSMSTemplate ¶
func (c *USMSClient) UpdateUSMSTemplate(req *UpdateUSMSTemplateRequest) (*UpdateUSMSTemplateResponse, error)
API: UpdateUSMSTemplate
调用接口UpdateUSMSTemplate修改未通过审核的短信模板,并重新提交审核
func (*USMSClient) UploadUSMSFile ¶ added in v0.22.38
func (c *USMSClient) UploadUSMSFile(req *UploadUSMSFileRequest) (*UploadUSMSFileResponse, error)
API: UploadUSMSFile
上传文件
type UpdateUSMSSignatureQualificationRequest ¶ added in v0.22.38
type UpdateUSMSSignatureQualificationRequest struct {
request.CommonBase
// 资质属性,0-自用 1-他用
Attr *int `required:"false"`
// 公司证件文件FileId
CompanyCertificateFileId *string `required:"false"`
// 公司统一社会信用代码
CompanyCreditCode *string `required:"false"`
// 公司名称,长度限制100
CompanyName *string `required:"false"`
// 公司工作现场照片FileId
CompanyWorkScenePhotosFileId *string `required:"false"`
// 经办人手持身份证图片FileId
HandlerHandHeldImageFileId *string `required:"false"`
// 经办人身份证国徽面图片FileId
HandlerIDCardBackImageFileId *string `required:"false"`
// 经办人身份证人像面图片FileId
HandlerIDCardFrontImageFileId *string `required:"false"`
// 经办人身份证号码
HandlerIDNumber *string `required:"false"`
// 经办人姓名
HandlerName *string `required:"false"`
// 经办人手机号
HandlerPhone *string `required:"false"`
// 法人身份证号码
ManagerIDNumber *string `required:"false"`
// 法人姓名
ManagerName *string `required:"false"`
// 法人手机号
ManagerPhone *string `required:"false"`
// 资质名称
Name *string `required:"false"`
// 资质Id
QualificationId *string `required:"true"`
// 状态:0-草稿,1-提交审核
Status *int `required:"true"`
}
UpdateUSMSSignatureQualificationRequest is request schema for UpdateUSMSSignatureQualification action
type UpdateUSMSSignatureQualificationResponse ¶ added in v0.22.38
type UpdateUSMSSignatureQualificationResponse struct {
response.CommonBase
// 返回状态码描述,如果操作成功,默认返回为空
Message string
// 资质Id
QualificationId string
}
UpdateUSMSSignatureQualificationResponse is response schema for UpdateUSMSSignatureQualification action
type UpdateUSMSSignatureRequest ¶
type UpdateUSMSSignatureRequest struct {
request.CommonBase
// 签名的资质证明文件类型,需与签名类型保持一致,说明如下:0-三证合一/企业营业执照/组织机构代码证书/社会信用代码证书;1-应用商店后台开发者管理截图;2-备案服务商的备案成功截图(含域名,网站名称,备案号);3-公众号或小程序的管理界面截图;4-商标注册证书;5-组织机构代码证书、社会信用代码证书;
CertificateType *int `required:"false"`
// 短信签名的资质证明文件URL,若未更改审核材料,则该处使用已上传审核材料的URL链接,否则使用File参数
Document *string `required:"false"`
// 短信签名的资质证明文件内容,需先进行base64编码格式转换,此处填写转换后的字符串。文件大小不超过4 MB。内容格式如下: [file type];[code type],[base64] 如:image/jpeg;base64,5YaF5a65
File *string `required:"false"`
// 短信签名授权委托文件URL,若未更改授权委托文件,则该处填写已上传的授权委托文件的URL链接,否则使用ProxyFile参数
ProxyDoc *string `required:"false"`
// 短信签名授权委托文件内容,需先进行base64编码格式转换,此处填写转换后的字符串。文件大小不超过4 MB;当您是代理并使用第三方的签名时(也即SigPurpose为1-他用),该项为必填项;格式和File类似。
ProxyFile *string `required:"false"`
// 短信签名对应的场景说明
SceneDesc *string `required:"false"`
// 新的短信签名内容;长度为2-12个字符, 可包含中文、数字和符号;无需填写【】或[],系统会自动添加
SigContent *string `required:"true"`
// 签名ID(也即短信签名申请时的工单ID),支持以数组的方式,举例,以SigIds.0、SigIds.1...SigIds.N方式传入
SigId *string `required:"true"`
// 签名用途,0-自用,1-他用;
SigPurpose *int `required:"true"`
// 签名类型,说明如下:0-公司或企业的全称或简称;1-App应用的全称或简称;2-工信部备案网站的全称或简称;3-公众号或小程序的全称或简称;4-商标名的全称或简称;5-政府/机关事业单位/其他单位的全称或简称;
SigType *int `required:"true"`
}
UpdateUSMSSignatureRequest is request schema for UpdateUSMSSignature action
type UpdateUSMSSignatureResponse ¶
type UpdateUSMSSignatureResponse struct {
response.CommonBase
// 返回状态码描述,如果操作成功,默认返回为空
Message string
}
UpdateUSMSSignatureResponse is response schema for UpdateUSMSSignature action
type UpdateUSMSTemplateRequest ¶
type UpdateUSMSTemplateRequest struct {
request.CommonBase
// 模板变量属性说明
Instruction *string `required:"false"`
// 短信模板申请原因说明,字数不超过128,每个中文、符号、英文、数字等都计为1个字。
Remark *string `required:"false"`
// 新的模板内容。模板名称和模板内容必须提供一个,否则会报错。小于等于600个字
Template *string `required:"true"`
// 短信模板ID
TemplateId *string `required:"true"`
// 新的模板名称。小于等于32个字,每个中文、英文、数组、符合都计为一个字
TemplateName *string `required:"false"`
}
UpdateUSMSTemplateRequest is request schema for UpdateUSMSTemplate action
type UpdateUSMSTemplateResponse ¶
type UpdateUSMSTemplateResponse struct {
response.CommonBase
// 发生错误时表示错误描述
Message string
}
UpdateUSMSTemplateResponse is response schema for UpdateUSMSTemplate action
type UploadUSMSFileRequest ¶ added in v0.22.38
type UploadUSMSFileRequest struct {
request.CommonBase
// 文件内容,base64编码
FileContent *string `required:"true"`
// 文件名称,携带文件后缀
FileName *string `required:"true"`
// 文件类型,mime格式
FileType *string `required:"false"`
// 文件来源,0-签名资质
Source *int `required:"true"`
}
UploadUSMSFileRequest is request schema for UploadUSMSFile action
type UploadUSMSFileResponse ¶ added in v0.22.38
type UploadUSMSFileResponse struct {
response.CommonBase
// 文件FileId
FileId string
// 返回状态码描述,如果操作成功,默认返回为空
Message string
}
UploadUSMSFileResponse is response schema for UploadUSMSFile action