apis

package
v1.62.0 Latest Latest
Warning

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

Go to latest
Published: Aug 16, 2023 License: Apache-2.0 Imports: 2 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BatchSendRequest added in v1.10.0

type BatchSendRequest struct {
	core.JDCloudRequest

	/* Region ID  */
	RegionId string `json:"regionId"`

	/* 模板Id  */
	TemplateId string `json:"templateId"`

	/* 签名Id  */
	SignId string `json:"signId"`

	/* 群发的国内电话号码,群发时一次最多不要超过100个手机号  */
	PhoneList []string `json:"phoneList"`

	/* 短信模板变量对应的数据值,Array格式 (Optional) */
	Params []string `json:"params"`
}

func NewBatchSendRequest added in v1.10.0

func NewBatchSendRequest(
	regionId string,
	templateId string,
	signId string,
	phoneList []string,
) *BatchSendRequest

* param regionId: Region ID (Required) * param templateId: 模板Id (Required) * param signId: 签名Id (Required) * param phoneList: 群发的国内电话号码,群发时一次最多不要超过100个手机号 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewBatchSendRequestWithAllParams added in v1.10.0

func NewBatchSendRequestWithAllParams(
	regionId string,
	templateId string,
	signId string,
	phoneList []string,
	params []string,
) *BatchSendRequest

* param regionId: Region ID (Required) * param templateId: 模板Id (Required) * param signId: 签名Id (Required) * param phoneList: 群发的国内电话号码,群发时一次最多不要超过100个手机号 (Required) * param params: 短信模板变量对应的数据值,Array格式 (Optional)

func NewBatchSendRequestWithoutParam added in v1.10.0

func NewBatchSendRequestWithoutParam() *BatchSendRequest

This constructor has better compatible ability when API parameters changed

func (BatchSendRequest) GetRegionId added in v1.10.0

func (r BatchSendRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*BatchSendRequest) SetParams added in v1.10.0

func (r *BatchSendRequest) SetParams(params []string)

param params: 短信模板变量对应的数据值,Array格式(Optional)

func (*BatchSendRequest) SetPhoneList added in v1.10.0

func (r *BatchSendRequest) SetPhoneList(phoneList []string)

param phoneList: 群发的国内电话号码,群发时一次最多不要超过100个手机号(Required)

func (*BatchSendRequest) SetRegionId added in v1.10.0

func (r *BatchSendRequest) SetRegionId(regionId string)

param regionId: Region ID(Required)

func (*BatchSendRequest) SetSignId added in v1.10.0

func (r *BatchSendRequest) SetSignId(signId string)

param signId: 签名Id(Required)

func (*BatchSendRequest) SetTemplateId added in v1.10.0

func (r *BatchSendRequest) SetTemplateId(templateId string)

param templateId: 模板Id(Required)

type BatchSendResponse added in v1.10.0

type BatchSendResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    BatchSendResult    `json:"result"`
}

type BatchSendResult added in v1.10.0

type BatchSendResult struct {
	Data    sms.BatchSendResp `json:"data"`
	Status  bool              `json:"status"`
	Code    int64             `json:"code"`
	Message string            `json:"message"`
}

type ReplyRequest added in v1.10.0

type ReplyRequest struct {
	core.JDCloudRequest

	/* Region ID  */
	RegionId string `json:"regionId"`

	/* 应用Id  */
	AppId string `json:"appId"`

	/* 查询时间  */
	DataDate string `json:"dataDate"`

	/* 手机号列表(选填) (Optional) */
	PhoneList []string `json:"phoneList"`
}

func NewReplyRequest added in v1.10.0

func NewReplyRequest(
	regionId string,
	appId string,
	dataDate string,
) *ReplyRequest

* param regionId: Region ID (Required) * param appId: 应用Id (Required) * param dataDate: 查询时间 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewReplyRequestWithAllParams added in v1.10.0

func NewReplyRequestWithAllParams(
	regionId string,
	appId string,
	dataDate string,
	phoneList []string,
) *ReplyRequest

* param regionId: Region ID (Required) * param appId: 应用Id (Required) * param dataDate: 查询时间 (Required) * param phoneList: 手机号列表(选填) (Optional)

func NewReplyRequestWithoutParam added in v1.10.0

func NewReplyRequestWithoutParam() *ReplyRequest

This constructor has better compatible ability when API parameters changed

func (ReplyRequest) GetRegionId added in v1.10.0

func (r ReplyRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*ReplyRequest) SetAppId added in v1.10.0

func (r *ReplyRequest) SetAppId(appId string)

param appId: 应用Id(Required)

func (*ReplyRequest) SetDataDate added in v1.10.0

func (r *ReplyRequest) SetDataDate(dataDate string)

param dataDate: 查询时间(Required)

func (*ReplyRequest) SetPhoneList added in v1.10.0

func (r *ReplyRequest) SetPhoneList(phoneList []string)

param phoneList: 手机号列表(选填)(Optional)

func (*ReplyRequest) SetRegionId added in v1.10.0

func (r *ReplyRequest) SetRegionId(regionId string)

param regionId: Region ID(Required)

type ReplyResponse added in v1.10.0

type ReplyResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    ReplyResult        `json:"result"`
}

type ReplyResult added in v1.10.0

type ReplyResult struct {
	Data    []sms.ReplyResp `json:"data"`
	Status  bool            `json:"status"`
	Code    int64           `json:"code"`
	Message string          `json:"message"`
}

type StatusReportRequest added in v1.10.0

type StatusReportRequest struct {
	core.JDCloudRequest

	/* Region ID  */
	RegionId string `json:"regionId"`

	/* 发送短信的序列号  */
	SequenceNumber string `json:"sequenceNumber"`

	/* 需要获取回执的手机号码列表,选填 (Optional) */
	PhoneList []string `json:"phoneList"`
}

func NewStatusReportRequest added in v1.10.0

func NewStatusReportRequest(
	regionId string,
	sequenceNumber string,
) *StatusReportRequest

* param regionId: Region ID (Required) * param sequenceNumber: 发送短信的序列号 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewStatusReportRequestWithAllParams added in v1.10.0

func NewStatusReportRequestWithAllParams(
	regionId string,
	sequenceNumber string,
	phoneList []string,
) *StatusReportRequest

* param regionId: Region ID (Required) * param sequenceNumber: 发送短信的序列号 (Required) * param phoneList: 需要获取回执的手机号码列表,选填 (Optional)

func NewStatusReportRequestWithoutParam added in v1.10.0

func NewStatusReportRequestWithoutParam() *StatusReportRequest

This constructor has better compatible ability when API parameters changed

func (StatusReportRequest) GetRegionId added in v1.10.0

func (r StatusReportRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*StatusReportRequest) SetPhoneList added in v1.10.0

func (r *StatusReportRequest) SetPhoneList(phoneList []string)

param phoneList: 需要获取回执的手机号码列表,选填(Optional)

func (*StatusReportRequest) SetRegionId added in v1.10.0

func (r *StatusReportRequest) SetRegionId(regionId string)

param regionId: Region ID(Required)

func (*StatusReportRequest) SetSequenceNumber added in v1.10.0

func (r *StatusReportRequest) SetSequenceNumber(sequenceNumber string)

param sequenceNumber: 发送短信的序列号(Required)

type StatusReportResponse added in v1.10.0

type StatusReportResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    StatusReportResult `json:"result"`
}

type StatusReportResult added in v1.10.0

type StatusReportResult struct {
	Data    []sms.StatusReportResp `json:"data"`
	Status  bool                   `json:"status"`
	Code    int64                  `json:"code"`
	Message string                 `json:"message"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL