v20190711

package
v3.0.233+incompatible Latest Latest
Warning

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

Go to latest
Published: Aug 14, 2020 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

View Source
const APIVersion = "2019-07-11"

Variables

This section is empty.

Functions

This section is empty.

Types

type AddSignStatus

type AddSignStatus struct {

	// 签名Id。
	SignId *uint64 `json:"SignId,omitempty" name:"SignId"`

	// 签名申请Id。
	SignApplyId *uint64 `json:"SignApplyId,omitempty" name:"SignApplyId"`
}

type AddSmsSignRequest

type AddSmsSignRequest struct {
	*tchttp.BaseRequest

	// 签名名称。
	SignName *string `json:"SignName,omitempty" name:"SignName"`

	// 签名类型。其中每种类型后面标注了其可选的 DocumentType(证明类型):
	// 0:公司(0,1,2,3)。
	// 1:APP(0,1,2,3,4) 。
	// 2:网站(0,1,2,3,5)。
	// 3:公众号或者小程序(0,1,2,3,6)。
	// 4:商标(7)。
	// 5:政府/机关事业单位/其他机构(2,3)。
	// 注:必须按照对应关系选择证明类型,否则会审核失败。
	SignType *uint64 `json:"SignType,omitempty" name:"SignType"`

	// 证明类型:
	// 0:三证合一。
	// 1:企业营业执照。
	// 2:组织机构代码证书。
	// 3:社会信用代码证书。
	// 4:应用后台管理截图(个人开发APP)。
	// 5:网站备案后台截图(个人开发网站)。
	// 6:小程序设置页面截图(个人认证小程序)。
	// 7:商标注册书。
	DocumentType *uint64 `json:"DocumentType,omitempty" name:"DocumentType"`

	// 是否国际/港澳台短信:
	// 0:表示国内短信。
	// 1:表示国际/港澳台短信。
	International *uint64 `json:"International,omitempty" name:"International"`

	// 签名用途:
	// 0:自用。
	// 1:他用。
	UsedMethod *uint64 `json:"UsedMethod,omitempty" name:"UsedMethod"`

	// 签名对应的资质证明图片需先进行 base64 编码格式转换,将转换后的字符串去掉前缀`data:image/jpeg;base64,`再赋值给该参数。
	ProofImage *string `json:"ProofImage,omitempty" name:"ProofImage"`

	// 委托授权证明。选择 UsedMethod 为他用之后需要提交委托的授权证明。
	// 图片需先进行 base64 编码格式转换,将转换后的字符串去掉前缀`data:image/jpeg;base64,`再赋值给该参数。
	// 注:只有 UsedMethod 在选择为 1(他用)时,这个字段才会生效。
	CommissionImage *string `json:"CommissionImage,omitempty" name:"CommissionImage"`

	// 签名的申请备注。
	Remark *string `json:"Remark,omitempty" name:"Remark"`
}

func NewAddSmsSignRequest

func NewAddSmsSignRequest() (request *AddSmsSignRequest)

func (*AddSmsSignRequest) FromJsonString

func (r *AddSmsSignRequest) FromJsonString(s string) error

func (*AddSmsSignRequest) ToJsonString

func (r *AddSmsSignRequest) ToJsonString() string

type AddSmsSignResponse

type AddSmsSignResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 添加签名响应
		AddSignStatus *AddSignStatus `json:"AddSignStatus,omitempty" name:"AddSignStatus"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewAddSmsSignResponse

func NewAddSmsSignResponse() (response *AddSmsSignResponse)

func (*AddSmsSignResponse) FromJsonString

func (r *AddSmsSignResponse) FromJsonString(s string) error

func (*AddSmsSignResponse) ToJsonString

func (r *AddSmsSignResponse) ToJsonString() string

type AddSmsTemplateRequest

type AddSmsTemplateRequest struct {
	*tchttp.BaseRequest

	// 模板名称。
	TemplateName *string `json:"TemplateName,omitempty" name:"TemplateName"`

	// 模板内容。
	TemplateContent *string `json:"TemplateContent,omitempty" name:"TemplateContent"`

	// 短信类型,0表示普通短信, 1表示营销短信。
	SmsType *uint64 `json:"SmsType,omitempty" name:"SmsType"`

	// 是否国际/港澳台短信:
	// 0:表示国内短信。
	// 1:表示国际/港澳台短信。
	International *uint64 `json:"International,omitempty" name:"International"`

	// 模板备注,例如申请原因,使用场景等。
	Remark *string `json:"Remark,omitempty" name:"Remark"`
}

func NewAddSmsTemplateRequest

func NewAddSmsTemplateRequest() (request *AddSmsTemplateRequest)

func (*AddSmsTemplateRequest) FromJsonString

func (r *AddSmsTemplateRequest) FromJsonString(s string) error

func (*AddSmsTemplateRequest) ToJsonString

func (r *AddSmsTemplateRequest) ToJsonString() string

type AddSmsTemplateResponse

type AddSmsTemplateResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 添加短信模板响应包体
		AddTemplateStatus *AddTemplateStatus `json:"AddTemplateStatus,omitempty" name:"AddTemplateStatus"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewAddSmsTemplateResponse

func NewAddSmsTemplateResponse() (response *AddSmsTemplateResponse)

func (*AddSmsTemplateResponse) FromJsonString

func (r *AddSmsTemplateResponse) FromJsonString(s string) error

func (*AddSmsTemplateResponse) ToJsonString

func (r *AddSmsTemplateResponse) ToJsonString() string

type AddTemplateStatus

type AddTemplateStatus struct {

	// 模板参数
	TemplateId *string `json:"TemplateId,omitempty" name:"TemplateId"`
}

type CallbackStatusStatistics

type CallbackStatusStatistics struct {

	// 短信回执量统计。
	CallbackCount *uint64 `json:"CallbackCount,omitempty" name:"CallbackCount"`

	// 短信提交成功量统计。
	RequestSuccessCount *uint64 `json:"RequestSuccessCount,omitempty" name:"RequestSuccessCount"`

	// 短信回执失败量统计。
	CallbackFailCount *uint64 `json:"CallbackFailCount,omitempty" name:"CallbackFailCount"`

	// 短信回执成功量统计。
	CallbackSuccessCount *uint64 `json:"CallbackSuccessCount,omitempty" name:"CallbackSuccessCount"`

	// 运营商内部错误统计。
	InternalErrorCount *uint64 `json:"InternalErrorCount,omitempty" name:"InternalErrorCount"`

	// 号码无效或空号统计。
	InvalidNumberCount *uint64 `json:"InvalidNumberCount,omitempty" name:"InvalidNumberCount"`

	// 停机、关机等错误统计。
	ShutdownErrorCount *uint64 `json:"ShutdownErrorCount,omitempty" name:"ShutdownErrorCount"`

	// 号码拉入黑名单统计。
	BlackListCount *uint64 `json:"BlackListCount,omitempty" name:"BlackListCount"`

	// 运营商频率限制统计。
	FrequencyLimitCount *uint64 `json:"FrequencyLimitCount,omitempty" name:"FrequencyLimitCount"`
}

type CallbackStatusStatisticsRequest

type CallbackStatusStatisticsRequest struct {
	*tchttp.BaseRequest

	// 开始时间,yyyymmddhh 需要拉取的起始时间,精确到小时。
	StartDateTime *uint64 `json:"StartDateTime,omitempty" name:"StartDateTime"`

	// 结束时间,yyyymmddhh 需要拉取的截止时间,精确到小时。
	// 注:EndDataTime 必须大于 StartDateTime。
	EndDataTime *uint64 `json:"EndDataTime,omitempty" name:"EndDataTime"`

	// 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,示例如1400006666。
	SmsSdkAppid *string `json:"SmsSdkAppid,omitempty" name:"SmsSdkAppid"`

	// 最大上限。
	// 注:目前固定设置为0。
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// 偏移量。
	// 注:目前固定设置为0。
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
}

func NewCallbackStatusStatisticsRequest

func NewCallbackStatusStatisticsRequest() (request *CallbackStatusStatisticsRequest)

func (*CallbackStatusStatisticsRequest) FromJsonString

func (r *CallbackStatusStatisticsRequest) FromJsonString(s string) error

func (*CallbackStatusStatisticsRequest) ToJsonString

func (r *CallbackStatusStatisticsRequest) ToJsonString() string

type CallbackStatusStatisticsResponse

type CallbackStatusStatisticsResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 回执数据统计响应包体。
		CallbackStatusStatistics *CallbackStatusStatistics `json:"CallbackStatusStatistics,omitempty" name:"CallbackStatusStatistics"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewCallbackStatusStatisticsResponse

func NewCallbackStatusStatisticsResponse() (response *CallbackStatusStatisticsResponse)

func (*CallbackStatusStatisticsResponse) FromJsonString

func (r *CallbackStatusStatisticsResponse) FromJsonString(s string) error

func (*CallbackStatusStatisticsResponse) ToJsonString

func (r *CallbackStatusStatisticsResponse) ToJsonString() string

type Client

type Client struct {
	common.Client
}

func NewClient

func NewClient(credential *common.Credential, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) AddSmsSign

func (c *Client) AddSmsSign(request *AddSmsSignRequest) (response *AddSmsSignResponse, err error)

1. 添加短信签名,申请之前请先认真参阅 [腾讯云短信签名审核标准](https://cloud.tencent.com/document/product/382/39022)。 2. ⚠️注意:个人认证用户不支持使用 API 申请短信签名,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),如果为个人认证请登录控制台申请短信签名。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。

func (*Client) AddSmsTemplate

func (c *Client) AddSmsTemplate(request *AddSmsTemplateRequest) (response *AddSmsTemplateResponse, err error)

1. 添加短信模版,申请之前请先认真参阅 [腾讯云短信正文模版审核标准](https://cloud.tencent.com/document/product/382/39023)。 2. ⚠️注意:个人认证用户不支持使用 API 申请短信正文模版,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),如果为个人认证请登录 [控制台](https://console.cloud.tencent.com/smsv2) 申请短信正文模版。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。

func (*Client) CallbackStatusStatistics

func (c *Client) CallbackStatusStatistics(request *CallbackStatusStatisticsRequest) (response *CallbackStatusStatisticsResponse, err error)

统计用户回执的数据。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。

func (*Client) DeleteSmsSign

func (c *Client) DeleteSmsSign(request *DeleteSmsSignRequest) (response *DeleteSmsSignResponse, err error)

⚠️注意:个人认证用户不支持使用 API 删除短信签名,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),请登录 [控制台](https://console.cloud.tencent.com/smsv2) 删除短信签名。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。

func (*Client) DeleteSmsTemplate

func (c *Client) DeleteSmsTemplate(request *DeleteSmsTemplateRequest) (response *DeleteSmsTemplateResponse, err error)

⚠️注意:个人认证用户不支持使用 API 删除短信正文模版,请登录 [控制台](https://console.cloud.tencent.com/smsv2) 删除短信正文模版,如需了解请参阅 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。

func (*Client) DescribeSmsSignList

func (c *Client) DescribeSmsSignList(request *DescribeSmsSignListRequest) (response *DescribeSmsSignListResponse, err error)

⚠️注意:个人认证用户不支持使用 API 查询短信签名,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),如果为个人认证请登录 [控制台](https://console.cloud.tencent.com/smsv2) 查询短信签名。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。

func (*Client) DescribeSmsTemplateList

func (c *Client) DescribeSmsTemplateList(request *DescribeSmsTemplateListRequest) (response *DescribeSmsTemplateListResponse, err error)

⚠️注意:个人认证用户不支持使用 API 查询短信正文模版,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。

func (*Client) ModifySmsSign

func (c *Client) ModifySmsSign(request *ModifySmsSignRequest) (response *ModifySmsSignResponse, err error)

1. 修改短信签名,修改之前请先认证参阅 [腾讯云短信签名审核标准](https://cloud.tencent.com/document/product/382/39022)。 2. ⚠️注意:个人认证用户不支持使用 API 修改短信签名,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),如果为个人认证请登录 [控制台](https://console.cloud.tencent.com/smsv2) 修改短信签名。 3. 修改短信签名,仅当签名为**待审核**或**已拒绝**状态时,才能进行修改,**已审核通过**的签名不支持修改。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。

func (*Client) ModifySmsTemplate

func (c *Client) ModifySmsTemplate(request *ModifySmsTemplateRequest) (response *ModifySmsTemplateResponse, err error)

1. 修改短信正文模版,修改之前请先认真参阅 [腾讯云短信正文模版审核标准](https://cloud.tencent.com/document/product/382/39023)。 2. ⚠️注意:个人认证用户不支持使用 API 修改短信正文模版,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),如果为个人认证请登录 [控制台](https://console.cloud.tencent.com/smsv2) 修改短信正文模版。 3. 修改短信签名,仅当正文模版为**待审核**或**已拒绝**状态时,才能进行修改,**已审核通过**的正文模版不支持修改。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。

func (*Client) PullSmsReplyStatus

func (c *Client) PullSmsReplyStatus(request *PullSmsReplyStatusRequest) (response *PullSmsReplyStatusResponse, err error)

拉取短信回复状态。 目前也支持 [配置回复回调](https://cloud.tencent.com/document/product/382/42907) 的方式来获取上行回复。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。

func (*Client) PullSmsReplyStatusByPhoneNumber

func (c *Client) PullSmsReplyStatusByPhoneNumber(request *PullSmsReplyStatusByPhoneNumberRequest) (response *PullSmsReplyStatusByPhoneNumberResponse, err error)

拉取单个号码短信回复状态。 目前也支持 [配置回复回调](https://cloud.tencent.com/document/product/382/42907) 的方式来获取上行回复。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。

func (*Client) PullSmsSendStatus

func (c *Client) PullSmsSendStatus(request *PullSmsSendStatusRequest) (response *PullSmsSendStatusResponse, err error)

拉取短信下发状态。 目前也支持 [配置回调](https://cloud.tencent.com/document/product/382/37809#.E8.AE.BE.E7.BD.AE.E4.BA.8B.E4.BB.B6.E5.9B.9E.E8.B0.83.E9.85.8D.E7.BD.AE) 的方式来获取下发状态。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。

func (*Client) PullSmsSendStatusByPhoneNumber

func (c *Client) PullSmsSendStatusByPhoneNumber(request *PullSmsSendStatusByPhoneNumberRequest) (response *PullSmsSendStatusByPhoneNumberResponse, err error)

拉取单个号码短信下发状态。 目前也支持 [配置回调](https://cloud.tencent.com/document/product/382/37809#.E8.AE.BE.E7.BD.AE.E4.BA.8B.E4.BB.B6.E5.9B.9E.E8.B0.83.E9.85.8D.E7.BD.AE) 的方式来获取下发状态。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。

func (*Client) SendSms

func (c *Client) SendSms(request *SendSmsRequest) (response *SendSmsResponse, err error)

短信发送接口,用户给用户发短信验证码、通知类短信或营销短信。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。

func (*Client) SendStatusStatistics

func (c *Client) SendStatusStatistics(request *SendStatusStatisticsRequest) (response *SendStatusStatisticsResponse, err error)

统计用户发送短信的数据。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。

func (*Client) SmsPackagesStatistics

func (c *Client) SmsPackagesStatistics(request *SmsPackagesStatisticsRequest) (response *SmsPackagesStatisticsResponse, err error)

用户套餐包信息统计。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。

type DeleteSignStatus

type DeleteSignStatus struct {

	// 删除状态信息。
	DeleteStatus *string `json:"DeleteStatus,omitempty" name:"DeleteStatus"`

	// 删除时间,UNIX 时间戳(单位:秒)。
	DeleteTime *uint64 `json:"DeleteTime,omitempty" name:"DeleteTime"`
}

type DeleteSmsSignRequest

type DeleteSmsSignRequest struct {
	*tchttp.BaseRequest

	// 待删除的签名 ID。
	SignId *uint64 `json:"SignId,omitempty" name:"SignId"`
}

func NewDeleteSmsSignRequest

func NewDeleteSmsSignRequest() (request *DeleteSmsSignRequest)

func (*DeleteSmsSignRequest) FromJsonString

func (r *DeleteSmsSignRequest) FromJsonString(s string) error

func (*DeleteSmsSignRequest) ToJsonString

func (r *DeleteSmsSignRequest) ToJsonString() string

type DeleteSmsSignResponse

type DeleteSmsSignResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 删除签名响应
		DeleteSignStatus *DeleteSignStatus `json:"DeleteSignStatus,omitempty" name:"DeleteSignStatus"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDeleteSmsSignResponse

func NewDeleteSmsSignResponse() (response *DeleteSmsSignResponse)

func (*DeleteSmsSignResponse) FromJsonString

func (r *DeleteSmsSignResponse) FromJsonString(s string) error

func (*DeleteSmsSignResponse) ToJsonString

func (r *DeleteSmsSignResponse) ToJsonString() string

type DeleteSmsTemplateRequest

type DeleteSmsTemplateRequest struct {
	*tchttp.BaseRequest

	// 待删除的模板 ID。
	TemplateId *uint64 `json:"TemplateId,omitempty" name:"TemplateId"`
}

func NewDeleteSmsTemplateRequest

func NewDeleteSmsTemplateRequest() (request *DeleteSmsTemplateRequest)

func (*DeleteSmsTemplateRequest) FromJsonString

func (r *DeleteSmsTemplateRequest) FromJsonString(s string) error

func (*DeleteSmsTemplateRequest) ToJsonString

func (r *DeleteSmsTemplateRequest) ToJsonString() string

type DeleteSmsTemplateResponse

type DeleteSmsTemplateResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 删除模板响应
		DeleteTemplateStatus *DeleteTemplateStatus `json:"DeleteTemplateStatus,omitempty" name:"DeleteTemplateStatus"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDeleteSmsTemplateResponse

func NewDeleteSmsTemplateResponse() (response *DeleteSmsTemplateResponse)

func (*DeleteSmsTemplateResponse) FromJsonString

func (r *DeleteSmsTemplateResponse) FromJsonString(s string) error

func (*DeleteSmsTemplateResponse) ToJsonString

func (r *DeleteSmsTemplateResponse) ToJsonString() string

type DeleteTemplateStatus

type DeleteTemplateStatus struct {

	// 删除状态信息。
	DeleteStatus *string `json:"DeleteStatus,omitempty" name:"DeleteStatus"`

	// 删除时间,UNIX 时间戳(单位:秒)。
	DeleteTime *uint64 `json:"DeleteTime,omitempty" name:"DeleteTime"`
}

type DescribeSignListStatus

type DescribeSignListStatus struct {

	// 签名Id
	SignId *uint64 `json:"SignId,omitempty" name:"SignId"`

	// 是否国际/港澳台短信:
	// 0:表示国内短信。
	// 1:表示国际/港澳台短信。
	International *uint64 `json:"International,omitempty" name:"International"`

	// 申请签名状态。其中:
	// 0:表示审核通过。
	// 1:表示审核中。
	// -1:表示审核未通过或审核失败。
	StatusCode *int64 `json:"StatusCode,omitempty" name:"StatusCode"`

	// 审核回复,审核人员审核后给出的回复,通常是审核未通过的原因。
	ReviewReply *string `json:"ReviewReply,omitempty" name:"ReviewReply"`

	// 签名名称。
	SignName *string `json:"SignName,omitempty" name:"SignName"`

	// 提交审核时间,UNIX 时间戳(单位:秒)。
	CreateTime *uint64 `json:"CreateTime,omitempty" name:"CreateTime"`
}

type DescribeSmsSignListRequest

type DescribeSmsSignListRequest struct {
	*tchttp.BaseRequest

	// 签名 ID 数组。
	SignIdSet []*uint64 `json:"SignIdSet,omitempty" name:"SignIdSet" list`

	// 是否国际/港澳台短信:
	// 0:表示国内短信。
	// 1:表示国际/港澳台短信。
	International *uint64 `json:"International,omitempty" name:"International"`
}

func NewDescribeSmsSignListRequest

func NewDescribeSmsSignListRequest() (request *DescribeSmsSignListRequest)

func (*DescribeSmsSignListRequest) FromJsonString

func (r *DescribeSmsSignListRequest) FromJsonString(s string) error

func (*DescribeSmsSignListRequest) ToJsonString

func (r *DescribeSmsSignListRequest) ToJsonString() string

type DescribeSmsSignListResponse

type DescribeSmsSignListResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 获取签名信息响应
		DescribeSignListStatusSet []*DescribeSignListStatus `json:"DescribeSignListStatusSet,omitempty" name:"DescribeSignListStatusSet" list`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeSmsSignListResponse

func NewDescribeSmsSignListResponse() (response *DescribeSmsSignListResponse)

func (*DescribeSmsSignListResponse) FromJsonString

func (r *DescribeSmsSignListResponse) FromJsonString(s string) error

func (*DescribeSmsSignListResponse) ToJsonString

func (r *DescribeSmsSignListResponse) ToJsonString() string

type DescribeSmsTemplateListRequest

type DescribeSmsTemplateListRequest struct {
	*tchttp.BaseRequest

	// 模板 ID 数组。
	TemplateIdSet []*uint64 `json:"TemplateIdSet,omitempty" name:"TemplateIdSet" list`

	// 是否国际/港澳台短信:
	// 0:表示国内短信。
	// 1:表示国际/港澳台短信。
	International *uint64 `json:"International,omitempty" name:"International"`
}

func NewDescribeSmsTemplateListRequest

func NewDescribeSmsTemplateListRequest() (request *DescribeSmsTemplateListRequest)

func (*DescribeSmsTemplateListRequest) FromJsonString

func (r *DescribeSmsTemplateListRequest) FromJsonString(s string) error

func (*DescribeSmsTemplateListRequest) ToJsonString

func (r *DescribeSmsTemplateListRequest) ToJsonString() string

type DescribeSmsTemplateListResponse

type DescribeSmsTemplateListResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 获取短信模板信息响应
		DescribeTemplateStatusSet []*DescribeTemplateListStatus `json:"DescribeTemplateStatusSet,omitempty" name:"DescribeTemplateStatusSet" list`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeSmsTemplateListResponse

func NewDescribeSmsTemplateListResponse() (response *DescribeSmsTemplateListResponse)

func (*DescribeSmsTemplateListResponse) FromJsonString

func (r *DescribeSmsTemplateListResponse) FromJsonString(s string) error

func (*DescribeSmsTemplateListResponse) ToJsonString

func (r *DescribeSmsTemplateListResponse) ToJsonString() string

type DescribeTemplateListStatus

type DescribeTemplateListStatus struct {

	// 模板Id
	TemplateId *uint64 `json:"TemplateId,omitempty" name:"TemplateId"`

	// 是否国际/港澳台短信:
	// 0:表示国内短信。
	// 1:表示国际/港澳台短信。
	International *uint64 `json:"International,omitempty" name:"International"`

	// 申请签名状态。其中:
	// 0:表示审核通过。
	// 1:表示审核中。
	// -1:表示审核未通过或审核失败。
	StatusCode *int64 `json:"StatusCode,omitempty" name:"StatusCode"`

	// 审核回复,审核人员审核后给出的回复,通常是审核未通过的原因。
	ReviewReply *string `json:"ReviewReply,omitempty" name:"ReviewReply"`

	// 模板名称。
	TemplateName *string `json:"TemplateName,omitempty" name:"TemplateName"`

	// 提交审核时间,UNIX 时间戳(单位:秒)。
	CreateTime *uint64 `json:"CreateTime,omitempty" name:"CreateTime"`
}

type ModifySignStatus

type ModifySignStatus struct {

	// 签名Id
	SignId *uint64 `json:"SignId,omitempty" name:"SignId"`

	// 签名修改申请Id
	SignApplyId *string `json:"SignApplyId,omitempty" name:"SignApplyId"`
}

type ModifySmsSignRequest

type ModifySmsSignRequest struct {
	*tchttp.BaseRequest

	// 待修改的签名 ID。
	SignId *uint64 `json:"SignId,omitempty" name:"SignId"`

	// 签名名称。
	SignName *string `json:"SignName,omitempty" name:"SignName"`

	// 签名类型。其中每种类型后面标注了其可选的 DocumentType(证明类型):
	// 0:公司(0,1,2,3)。
	// 1:APP(0,1,2,3,4) 。
	// 2:网站(0,1,2,3,5)。
	// 3:公众号或者小程序(0,1,2,3,6)。
	// 4:商标(7)。
	// 5:政府/机关事业单位/其他机构(2,3)。
	// 注:必须按照对应关系选择证明类型,否则会审核失败。
	SignType *uint64 `json:"SignType,omitempty" name:"SignType"`

	// 证明类型:
	// 0:三证合一。
	// 1:企业营业执照。
	// 2:组织机构代码证书。
	// 3:社会信用代码证书。
	// 4:应用后台管理截图(个人开发APP)。
	// 5:网站备案后台截图(个人开发网站)。
	// 6:小程序设置页面截图(个人认证小程序)。
	// 7:商标注册书。
	DocumentType *uint64 `json:"DocumentType,omitempty" name:"DocumentType"`

	// 是否国际/港澳台短信:
	// 0:表示国内短信。
	// 1:表示国际/港澳台短信。
	International *uint64 `json:"International,omitempty" name:"International"`

	// 签名用途:
	// 0:自用。
	// 1:他用。
	UsedMethod *uint64 `json:"UsedMethod,omitempty" name:"UsedMethod"`

	// 签名对应的资质证明图片需先进行 base64 编码格式转换,将转换后的字符串去掉前缀`data:image/jpeg;base64,`再赋值给该参数。
	ProofImage *string `json:"ProofImage,omitempty" name:"ProofImage"`

	// 委托授权证明。选择 UsedMethod 为他用之后需要提交委托的授权证明。
	// 图片需先进行 base64 编码格式转换,将转换后的字符串去掉前缀`data:image/jpeg;base64,`再赋值给该参数。
	// 注:只有 UsedMethod 在选择为 1(他用)时,这个字段才会生效。
	CommissionImage *string `json:"CommissionImage,omitempty" name:"CommissionImage"`

	// 签名的申请备注。
	Remark *string `json:"Remark,omitempty" name:"Remark"`
}

func NewModifySmsSignRequest

func NewModifySmsSignRequest() (request *ModifySmsSignRequest)

func (*ModifySmsSignRequest) FromJsonString

func (r *ModifySmsSignRequest) FromJsonString(s string) error

func (*ModifySmsSignRequest) ToJsonString

func (r *ModifySmsSignRequest) ToJsonString() string

type ModifySmsSignResponse

type ModifySmsSignResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 修改签名响应
		ModifySignStatus *ModifySignStatus `json:"ModifySignStatus,omitempty" name:"ModifySignStatus"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewModifySmsSignResponse

func NewModifySmsSignResponse() (response *ModifySmsSignResponse)

func (*ModifySmsSignResponse) FromJsonString

func (r *ModifySmsSignResponse) FromJsonString(s string) error

func (*ModifySmsSignResponse) ToJsonString

func (r *ModifySmsSignResponse) ToJsonString() string

type ModifySmsTemplateRequest

type ModifySmsTemplateRequest struct {
	*tchttp.BaseRequest

	// 待修改的模板的模板 ID。
	TemplateId *uint64 `json:"TemplateId,omitempty" name:"TemplateId"`

	// 新的模板名称。
	TemplateName *string `json:"TemplateName,omitempty" name:"TemplateName"`

	// 新的模板内容。
	TemplateContent *string `json:"TemplateContent,omitempty" name:"TemplateContent"`

	// 短信类型,0表示普通短信, 1表示营销短信。
	SmsType *uint64 `json:"SmsType,omitempty" name:"SmsType"`

	// 是否国际/港澳台短信:
	// 0:表示国内短信。
	// 1:表示国际/港澳台短信。
	International *uint64 `json:"International,omitempty" name:"International"`

	// 模板备注,例如申请原因,使用场景等。
	Remark *string `json:"Remark,omitempty" name:"Remark"`
}

func NewModifySmsTemplateRequest

func NewModifySmsTemplateRequest() (request *ModifySmsTemplateRequest)

func (*ModifySmsTemplateRequest) FromJsonString

func (r *ModifySmsTemplateRequest) FromJsonString(s string) error

func (*ModifySmsTemplateRequest) ToJsonString

func (r *ModifySmsTemplateRequest) ToJsonString() string

type ModifySmsTemplateResponse

type ModifySmsTemplateResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 修改模板参数响应
		ModifyTemplateStatus *ModifyTemplateStatus `json:"ModifyTemplateStatus,omitempty" name:"ModifyTemplateStatus"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewModifySmsTemplateResponse

func NewModifySmsTemplateResponse() (response *ModifySmsTemplateResponse)

func (*ModifySmsTemplateResponse) FromJsonString

func (r *ModifySmsTemplateResponse) FromJsonString(s string) error

func (*ModifySmsTemplateResponse) ToJsonString

func (r *ModifySmsTemplateResponse) ToJsonString() string

type ModifyTemplateStatus

type ModifyTemplateStatus struct {

	// 模板参数
	TemplateId *uint64 `json:"TemplateId,omitempty" name:"TemplateId"`
}

type PullSmsReplyStatus

type PullSmsReplyStatus struct {

	// 短信码号扩展号,默认未开通,如需开通请联系 [sms helper](https://cloud.tencent.com/document/product/382/3773)。
	ExtendCode *string `json:"ExtendCode,omitempty" name:"ExtendCode"`

	// 国家(或地区)码。
	NationCode *string `json:"NationCode,omitempty" name:"NationCode"`

	// 手机号码,e.164标准,+[国家或地区码][手机号] ,示例如:+8613711112222, 其中前面有一个+号 ,86为国家码,13711112222为手机号。
	PhoneNumber *string `json:"PhoneNumber,omitempty" name:"PhoneNumber"`

	// 短信签名。
	Sign *string `json:"Sign,omitempty" name:"Sign"`

	// 用户回复的内容。
	ReplyContent *string `json:"ReplyContent,omitempty" name:"ReplyContent"`

	// 回复时间(例如:2019-10-08 17:18:37)。
	ReplyTime *string `json:"ReplyTime,omitempty" name:"ReplyTime"`

	// 回复时间,UNIX 时间戳(单位:秒)。
	ReplyUnixTime *uint64 `json:"ReplyUnixTime,omitempty" name:"ReplyUnixTime"`
}

type PullSmsReplyStatusByPhoneNumberRequest

type PullSmsReplyStatusByPhoneNumberRequest struct {
	*tchttp.BaseRequest

	// 拉取起始时间,UNIX 时间戳(时间:秒)。
	// 注:最大可拉取当前时期7天前的数据。
	SendDateTime *uint64 `json:"SendDateTime,omitempty" name:"SendDateTime"`

	// 偏移量。
	// 注:目前固定设置为0。
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// 拉取最大条数,最多 100。
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// 下发目的手机号码,依据 e.164 标准为:+[国家(或地区)码][手机号] ,示例如:+8613711112222, 其中前面有一个+号 ,86为国家码,13711112222为手机号。
	PhoneNumber *string `json:"PhoneNumber,omitempty" name:"PhoneNumber"`

	// 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,例如1400006666。
	SmsSdkAppid *string `json:"SmsSdkAppid,omitempty" name:"SmsSdkAppid"`

	// 拉取截止时间,UNIX 时间戳(时间:秒)。
	EndDateTime *uint64 `json:"EndDateTime,omitempty" name:"EndDateTime"`
}

func NewPullSmsReplyStatusByPhoneNumberRequest

func NewPullSmsReplyStatusByPhoneNumberRequest() (request *PullSmsReplyStatusByPhoneNumberRequest)

func (*PullSmsReplyStatusByPhoneNumberRequest) FromJsonString

func (*PullSmsReplyStatusByPhoneNumberRequest) ToJsonString

type PullSmsReplyStatusByPhoneNumberResponse

type PullSmsReplyStatusByPhoneNumberResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 回复状态响应集合。
		PullSmsReplyStatusSet []*PullSmsReplyStatus `json:"PullSmsReplyStatusSet,omitempty" name:"PullSmsReplyStatusSet" list`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewPullSmsReplyStatusByPhoneNumberResponse

func NewPullSmsReplyStatusByPhoneNumberResponse() (response *PullSmsReplyStatusByPhoneNumberResponse)

func (*PullSmsReplyStatusByPhoneNumberResponse) FromJsonString

func (*PullSmsReplyStatusByPhoneNumberResponse) ToJsonString

type PullSmsReplyStatusRequest

type PullSmsReplyStatusRequest struct {
	*tchttp.BaseRequest

	// 拉取最大条数,最多100条。
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// 短信 SdkAppid 在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际 SdkAppid,例如1400006666。
	SmsSdkAppid *string `json:"SmsSdkAppid,omitempty" name:"SmsSdkAppid"`
}

func NewPullSmsReplyStatusRequest

func NewPullSmsReplyStatusRequest() (request *PullSmsReplyStatusRequest)

func (*PullSmsReplyStatusRequest) FromJsonString

func (r *PullSmsReplyStatusRequest) FromJsonString(s string) error

func (*PullSmsReplyStatusRequest) ToJsonString

func (r *PullSmsReplyStatusRequest) ToJsonString() string

type PullSmsReplyStatusResponse

type PullSmsReplyStatusResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 回复状态响应集合。
		PullSmsReplyStatusSet []*PullSmsReplyStatus `json:"PullSmsReplyStatusSet,omitempty" name:"PullSmsReplyStatusSet" list`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewPullSmsReplyStatusResponse

func NewPullSmsReplyStatusResponse() (response *PullSmsReplyStatusResponse)

func (*PullSmsReplyStatusResponse) FromJsonString

func (r *PullSmsReplyStatusResponse) FromJsonString(s string) error

func (*PullSmsReplyStatusResponse) ToJsonString

func (r *PullSmsReplyStatusResponse) ToJsonString() string

type PullSmsSendStatus

type PullSmsSendStatus struct {

	// 用户实际接收到短信的时间。
	UserReceiveTime *string `json:"UserReceiveTime,omitempty" name:"UserReceiveTime"`

	// 用户实际接收到短信的时间,UNIX 时间戳(单位:秒)。
	UserReceiveUnixTime *uint64 `json:"UserReceiveUnixTime,omitempty" name:"UserReceiveUnixTime"`

	// 国家(或地区)码。
	NationCode *string `json:"NationCode,omitempty" name:"NationCode"`

	// 手机号码,e.164标准,+[国家或地区码][手机号] ,示例如:+8613711112222, 其中前面有一个+号 ,86为国家码,13711112222为手机号。
	PurePhoneNumber *string `json:"PurePhoneNumber,omitempty" name:"PurePhoneNumber"`

	// 手机号码,普通格式,示例如:13711112222。
	PhoneNumber *string `json:"PhoneNumber,omitempty" name:"PhoneNumber"`

	// 本次发送标识 ID。
	SerialNo *string `json:"SerialNo,omitempty" name:"SerialNo"`

	// 实际是否收到短信接收状态,SUCCESS(成功)、FAIL(失败)。
	ReportStatus *string `json:"ReportStatus,omitempty" name:"ReportStatus"`

	// 用户接收短信状态描述。
	Description *string `json:"Description,omitempty" name:"Description"`
}

type PullSmsSendStatusByPhoneNumberRequest

type PullSmsSendStatusByPhoneNumberRequest struct {
	*tchttp.BaseRequest

	// 拉取起始时间,UNIX 时间戳(时间:秒)。
	// 注:最大可拉取当前时期7天前的数据。
	SendDateTime *uint64 `json:"SendDateTime,omitempty" name:"SendDateTime"`

	// 偏移量。
	// 注:目前固定设置为0。
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// 拉取最大条数,最多 100。
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// 下发目的手机号码,依据 e.164 标准为:+[国家(或地区)码][手机号] ,示例如:+8613711112222, 其中前面有一个+号 ,86为国家码,13711112222为手机号。
	PhoneNumber *string `json:"PhoneNumber,omitempty" name:"PhoneNumber"`

	// 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,例如1400006666。
	SmsSdkAppid *string `json:"SmsSdkAppid,omitempty" name:"SmsSdkAppid"`

	// 拉取截止时间,UNIX 时间戳(时间:秒)。
	EndDateTime *uint64 `json:"EndDateTime,omitempty" name:"EndDateTime"`
}

func NewPullSmsSendStatusByPhoneNumberRequest

func NewPullSmsSendStatusByPhoneNumberRequest() (request *PullSmsSendStatusByPhoneNumberRequest)

func (*PullSmsSendStatusByPhoneNumberRequest) FromJsonString

func (r *PullSmsSendStatusByPhoneNumberRequest) FromJsonString(s string) error

func (*PullSmsSendStatusByPhoneNumberRequest) ToJsonString

type PullSmsSendStatusByPhoneNumberResponse

type PullSmsSendStatusByPhoneNumberResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 下发状态响应集合。
		PullSmsSendStatusSet []*PullSmsSendStatus `json:"PullSmsSendStatusSet,omitempty" name:"PullSmsSendStatusSet" list`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewPullSmsSendStatusByPhoneNumberResponse

func NewPullSmsSendStatusByPhoneNumberResponse() (response *PullSmsSendStatusByPhoneNumberResponse)

func (*PullSmsSendStatusByPhoneNumberResponse) FromJsonString

func (*PullSmsSendStatusByPhoneNumberResponse) ToJsonString

type PullSmsSendStatusRequest

type PullSmsSendStatusRequest struct {
	*tchttp.BaseRequest

	// 拉取最大条数,最多100条。
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,例如1400006666。
	SmsSdkAppid *string `json:"SmsSdkAppid,omitempty" name:"SmsSdkAppid"`
}

func NewPullSmsSendStatusRequest

func NewPullSmsSendStatusRequest() (request *PullSmsSendStatusRequest)

func (*PullSmsSendStatusRequest) FromJsonString

func (r *PullSmsSendStatusRequest) FromJsonString(s string) error

func (*PullSmsSendStatusRequest) ToJsonString

func (r *PullSmsSendStatusRequest) ToJsonString() string

type PullSmsSendStatusResponse

type PullSmsSendStatusResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 下发状态响应集合。
		PullSmsSendStatusSet []*PullSmsSendStatus `json:"PullSmsSendStatusSet,omitempty" name:"PullSmsSendStatusSet" list`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewPullSmsSendStatusResponse

func NewPullSmsSendStatusResponse() (response *PullSmsSendStatusResponse)

func (*PullSmsSendStatusResponse) FromJsonString

func (r *PullSmsSendStatusResponse) FromJsonString(s string) error

func (*PullSmsSendStatusResponse) ToJsonString

func (r *PullSmsSendStatusResponse) ToJsonString() string

type SendSmsRequest

type SendSmsRequest struct {
	*tchttp.BaseRequest

	// 下发手机号码,采用 e.164 标准,格式为+[国家或地区码][手机号],单次请求最多支持200个手机号且要求全为境内手机号或全为境外手机号。
	// 例如:+8613711112222, 其中前面有一个+号 ,86为国家码,13711112222为手机号。
	PhoneNumberSet []*string `json:"PhoneNumberSet,omitempty" name:"PhoneNumberSet" list`

	// 模板 ID,必须填写已审核通过的模板 ID。模板ID可登录 [短信控制台](https://console.cloud.tencent.com/smsv2) 查看。
	TemplateID *string `json:"TemplateID,omitempty" name:"TemplateID"`

	// 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2)  添加应用后生成的实际SdkAppid,示例如1400006666。
	SmsSdkAppid *string `json:"SmsSdkAppid,omitempty" name:"SmsSdkAppid"`

	// 短信签名内容,使用 UTF-8 编码,必须填写已审核通过的签名,签名信息可登录 [短信控制台](https://console.cloud.tencent.com/smsv2)  查看。注:国内短信为必填参数。
	Sign *string `json:"Sign,omitempty" name:"Sign"`

	// 模板参数,若无模板参数,则设置为空。
	TemplateParamSet []*string `json:"TemplateParamSet,omitempty" name:"TemplateParamSet" list`

	// 短信码号扩展号,默认未开通,如需开通请联系 [sms helper](https://cloud.tencent.com/document/product/382/3773)。
	ExtendCode *string `json:"ExtendCode,omitempty" name:"ExtendCode"`

	// 用户的 session 内容,可以携带用户侧 ID 等上下文信息,server 会原样返回。
	SessionContext *string `json:"SessionContext,omitempty" name:"SessionContext"`

	// 国际/港澳台短信 senderid,国内短信填空,默认未开通,如需开通请联系 [sms helper](https://cloud.tencent.com/document/product/382/3773)。
	SenderId *string `json:"SenderId,omitempty" name:"SenderId"`
}

func NewSendSmsRequest

func NewSendSmsRequest() (request *SendSmsRequest)

func (*SendSmsRequest) FromJsonString

func (r *SendSmsRequest) FromJsonString(s string) error

func (*SendSmsRequest) ToJsonString

func (r *SendSmsRequest) ToJsonString() string

type SendSmsResponse

type SendSmsResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 短信发送状态。
		SendStatusSet []*SendStatus `json:"SendStatusSet,omitempty" name:"SendStatusSet" list`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewSendSmsResponse

func NewSendSmsResponse() (response *SendSmsResponse)

func (*SendSmsResponse) FromJsonString

func (r *SendSmsResponse) FromJsonString(s string) error

func (*SendSmsResponse) ToJsonString

func (r *SendSmsResponse) ToJsonString() string

type SendStatus

type SendStatus struct {

	// 发送流水号。
	SerialNo *string `json:"SerialNo,omitempty" name:"SerialNo"`

	// 手机号码,e.164标准,+[国家或地区码][手机号] ,示例如:+8613711112222, 其中前面有一个+号 ,86为国家码,13711112222为手机号。
	PhoneNumber *string `json:"PhoneNumber,omitempty" name:"PhoneNumber"`

	// 计费条数,计费规则请查询 [计费策略](https://cloud.tencent.com/document/product/382/36135)。
	Fee *uint64 `json:"Fee,omitempty" name:"Fee"`

	// 用户Session内容。
	SessionContext *string `json:"SessionContext,omitempty" name:"SessionContext"`

	// 短信请求错误码,具体含义请参考错误码。
	Code *string `json:"Code,omitempty" name:"Code"`

	// 短信请求错误码描述。
	Message *string `json:"Message,omitempty" name:"Message"`

	// 国家码或地区码,例如CN,US等,对于未识别出国家码或者地区码,默认返回DEF,具体支持列表请参考国际/港澳台计费总览。
	IsoCode *string `json:"IsoCode,omitempty" name:"IsoCode"`
}

type SendStatusStatistics

type SendStatusStatistics struct {

	// 短信计费条数统计,例如提交成功量为100条,其中有20条是长短信(长度为80字)被拆分成2条,则计费条数为: “`80 * 1 + 20 * 2 = 120“` 条。
	FeeCount *uint64 `json:"FeeCount,omitempty" name:"FeeCount"`

	// 短信提交量统计。
	RequestCount *uint64 `json:"RequestCount,omitempty" name:"RequestCount"`

	// 短信提交成功量统计。
	RequestSuccessCount *uint64 `json:"RequestSuccessCount,omitempty" name:"RequestSuccessCount"`
}

type SendStatusStatisticsRequest

type SendStatusStatisticsRequest struct {
	*tchttp.BaseRequest

	// 拉取起始时间,yyyymmddhh 需要拉取的起始时间,精确到小时。
	StartDateTime *uint64 `json:"StartDateTime,omitempty" name:"StartDateTime"`

	// 结束时间,yyyymmddhh 需要拉取的截止时间,精确到小时
	// 注:EndDataTime 必须大于 StartDateTime。
	EndDataTime *uint64 `json:"EndDataTime,omitempty" name:"EndDataTime"`

	// 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,示例如1400006666。
	SmsSdkAppid *string `json:"SmsSdkAppid,omitempty" name:"SmsSdkAppid"`

	// 最大上限。
	// 注:目前固定设置为0。
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// 偏移量。
	// 注:目前固定设置为0。
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
}

func NewSendStatusStatisticsRequest

func NewSendStatusStatisticsRequest() (request *SendStatusStatisticsRequest)

func (*SendStatusStatisticsRequest) FromJsonString

func (r *SendStatusStatisticsRequest) FromJsonString(s string) error

func (*SendStatusStatisticsRequest) ToJsonString

func (r *SendStatusStatisticsRequest) ToJsonString() string

type SendStatusStatisticsResponse

type SendStatusStatisticsResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 发送数据统计响应包体。
		SendStatusStatistics *SendStatusStatistics `json:"SendStatusStatistics,omitempty" name:"SendStatusStatistics"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewSendStatusStatisticsResponse

func NewSendStatusStatisticsResponse() (response *SendStatusStatisticsResponse)

func (*SendStatusStatisticsResponse) FromJsonString

func (r *SendStatusStatisticsResponse) FromJsonString(s string) error

func (*SendStatusStatisticsResponse) ToJsonString

func (r *SendStatusStatisticsResponse) ToJsonString() string

type SmsPackagesStatistics

type SmsPackagesStatistics struct {

	// 套餐包创建时间,标准时间,例如:2019-10-08 17:18:37。
	PackageCreateTime *string `json:"PackageCreateTime,omitempty" name:"PackageCreateTime"`

	// 套餐包创建时间,UNIX 时间戳(单位:秒)。
	PackageCreateUnixTime *uint64 `json:"PackageCreateUnixTime,omitempty" name:"PackageCreateUnixTime"`

	// 套餐包生效时间,标准时间,例如:2019-10-08 17:18:37。
	PackageEffectiveTime *string `json:"PackageEffectiveTime,omitempty" name:"PackageEffectiveTime"`

	// 套餐包生效时间,UNIX 时间戳(单位:秒)。
	PackageEffectiveUnixTime *uint64 `json:"PackageEffectiveUnixTime,omitempty" name:"PackageEffectiveUnixTime"`

	// 套餐包过期时间,标准时间,例如:2019-10-08 17:18:37。
	PackageExpiredTime *string `json:"PackageExpiredTime,omitempty" name:"PackageExpiredTime"`

	// 套餐包过期时间,UNIX 时间戳(单位:秒)。
	PackageExpiredUnixTime *uint64 `json:"PackageExpiredUnixTime,omitempty" name:"PackageExpiredUnixTime"`

	// 套餐包条数。
	AmountOfPackage *uint64 `json:"AmountOfPackage,omitempty" name:"AmountOfPackage"`

	// 0表示赠送套餐包,1表示购买套餐包。
	TypeOfPackage *uint64 `json:"TypeOfPackage,omitempty" name:"TypeOfPackage"`

	// 套餐包 ID。
	PackageId *uint64 `json:"PackageId,omitempty" name:"PackageId"`

	// 当前使用量。
	CurrentUsage *uint64 `json:"CurrentUsage,omitempty" name:"CurrentUsage"`
}

type SmsPackagesStatisticsRequest

type SmsPackagesStatisticsRequest struct {
	*tchttp.BaseRequest

	// 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,示例如1400006666。
	SmsSdkAppid *string `json:"SmsSdkAppid,omitempty" name:"SmsSdkAppid"`

	// 最大上限(需要拉取的套餐包个数)。
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// 偏移量。
	// 注:目前固定设置为0。
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
}

func NewSmsPackagesStatisticsRequest

func NewSmsPackagesStatisticsRequest() (request *SmsPackagesStatisticsRequest)

func (*SmsPackagesStatisticsRequest) FromJsonString

func (r *SmsPackagesStatisticsRequest) FromJsonString(s string) error

func (*SmsPackagesStatisticsRequest) ToJsonString

func (r *SmsPackagesStatisticsRequest) ToJsonString() string

type SmsPackagesStatisticsResponse

type SmsPackagesStatisticsResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 发送数据统计响应包体。
		SmsPackagesStatisticsSet []*SmsPackagesStatistics `json:"SmsPackagesStatisticsSet,omitempty" name:"SmsPackagesStatisticsSet" list`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewSmsPackagesStatisticsResponse

func NewSmsPackagesStatisticsResponse() (response *SmsPackagesStatisticsResponse)

func (*SmsPackagesStatisticsResponse) FromJsonString

func (r *SmsPackagesStatisticsResponse) FromJsonString(s string) error

func (*SmsPackagesStatisticsResponse) ToJsonString

func (r *SmsPackagesStatisticsResponse) ToJsonString() string

Jump to

Keyboard shortcuts

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