usms

Documentation

Index

• type GetUSMSSendReceiptRequest
• type GetUSMSSendReceiptResponse
• type ReceiptPerPhone
• type ReceiptPerSession
• type SendUSMSMessageRequest
• type SendUSMSMessageResponse
• type USMSClient
  • func NewClient(config *ucloud.Config, credential *auth.Credential) *USMSClient
  • func (c *USMSClient) GetUSMSSendReceipt(req *GetUSMSSendReceiptRequest) (*GetUSMSSendReceiptResponse, error)
  • func (c *USMSClient) NewGetUSMSSendReceiptRequest() *GetUSMSSendReceiptRequest
  • func (c *USMSClient) NewSendUSMSMessageRequest() *SendUSMSMessageRequest
  • func (c *USMSClient) SendUSMSMessage(req *SendUSMSMessageRequest) (*SendUSMSMessageResponse, error)

Types

type GetUSMSSendReceiptRequest

type GetUSMSSendReceiptRequest struct {
	request.CommonBase

	// 发送短信时返回的SessionNo集合，SessionNoSet.0,SessionNoSet.1....格式
	SessionNoSet []string `required:"true"`
}

GetUSMSSendReceiptRequest is request schema for GetUSMSSendReceipt action

type GetUSMSSendReceiptResponse

type GetUSMSSendReceiptResponse struct {
	response.CommonBase

	// 错误描述
	Message string

	// 回执信息集合
	Data []ReceiptPerSession
}

GetUSMSSendReceiptResponse is response schema for GetUSMSSendReceipt action

type ReceiptPerPhone

type ReceiptPerPhone struct {

	// 手机号码
	Phone string

	// 消耗短信条数
	CostCount int

	// 回执结果
	ReceiptResult string

	// 回执结果描述
	ReceiptDesc string

	// 回执返回时间
	ReceiptTime int
}

ReceiptPerPhone - 每个目的手机号的发送回执信息

this model is auto created by ucloud code generater for open api, you can also see https://docs.ucloud.cn for detail.

type ReceiptPerSession

type ReceiptPerSession struct {

	// 发送短信时返回的SessionNo
	SessionNo string

	// 每个手机号的短信回执信息集合
	ReceiptSet []ReceiptPerPhone
}

ReceiptPerSession - 每个提交的回执结果集合

this model is auto created by ucloud code generater for open api, you can also see https://docs.ucloud.cn for detail.

type SendUSMSMessageRequest

type SendUSMSMessageRequest struct {
	request.CommonBase

	// 电话号码数组，电话号码格式为(60)1xxxxxxxx，()中为国际长途区号(如中国为86或0086，两种格式都支持)，后面为电话号码.若不传入国际区号，如1851623xxxx，则默认为国内手机号
	PhoneNumbers []string `required:"true"`

	// 模板参数数组，以TempalteParams.0，TempalteParams.1.。。格式。若模板ID指定的模板无可变参数，则不传入该参数。模板参数个数与模板不匹配，则不允许发送
	TemplateParams []string `required:"true"`

	// 模板ID。若指定的模板ID审核未通过(status不等于2)则不允许发送
	TemplateId *string `required:"true"`

	// 使用的签名，如果不输入则使用默认签名，若没有申请默认签名不允许发送；若输入的签名没有申请，则无法发送
	SigContent *string `required:"false"`
}

SendUSMSMessageRequest is request schema for SendUSMSMessage action

type SendUSMSMessageResponse

type SendUSMSMessageResponse struct {
	response.CommonBase

	// 发生错误时表示错误描述
	Message string

	// 本次提交发送的短信的唯一ID，可根据该值查询本次发送的短信列表
	SessionNo string
}

SendUSMSMessageResponse is response schema for SendUSMSMessage action

type USMSClient

type USMSClient struct {
	*ucloud.Client
}

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) GetUSMSSendReceipt

func (c *USMSClient) GetUSMSSendReceipt(req *GetUSMSSendReceiptRequest) (*GetUSMSSendReceiptResponse, error)

GetUSMSSendReceipt - 获取短信发送回执信息。下游服务提供商回执信息返回会有一定延时，建议发送完短信以后，5-10分钟后再调用该接口拉取回执信息。若超过12小时未返回，则请联系技术支持确认原因

func (*USMSClient) NewGetUSMSSendReceiptRequest

func (c *USMSClient) NewGetUSMSSendReceiptRequest() *GetUSMSSendReceiptRequest

NewGetUSMSSendReceiptRequest will create request of GetUSMSSendReceipt action.

func (*USMSClient) NewSendUSMSMessageRequest

func (c *USMSClient) NewSendUSMSMessageRequest() *SendUSMSMessageRequest

NewSendUSMSMessageRequest will create request of SendUSMSMessage action.

func (*USMSClient) SendUSMSMessage

func (c *USMSClient) SendUSMSMessage(req *SendUSMSMessageRequest) (*SendUSMSMessageResponse, error)

SendUSMSMessage - 发送短信息。短信字数超过70个后，按照每66个进行切割(因为要加上1/3), 2/3)等字样，占用4个字长)。短信最大长度不能超过600个字。每个汉字、数字、字母、字符都按一个字计