com.tencentcloudapi.sms.v20190711

Class SmsClient

java.lang.Object

com.tencentcloudapi.common.AbstractClient

com.tencentcloudapi.sms.v20190711.SmsClient

public class SmsClient
extends AbstractClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors

Constructor and Description
SmsClient(Credential credential, String region)
SmsClient(Credential credential, String region, ClientProfile profile)

Method Summary

Modifier and Type	Method and Description
AddSmsSignResponse	AddSmsSign(AddSmsSignRequest req) This API is used to add an SMS signature.
AddSmsTemplateResponse	AddSmsTemplate(AddSmsTemplateRequest req) This API is used to add an SMS template.
CallbackStatusStatisticsResponse	CallbackStatusStatistics(CallbackStatusStatisticsRequest req) This API is used to collect statistics on user receipts.
DeleteSmsSignResponse	DeleteSmsSign(DeleteSmsSignRequest req) > Note: individual users cannot use this API to delete SMS signatures.
DeleteSmsTemplateResponse	DeleteSmsTemplate(DeleteSmsTemplateRequest req) > Note: individual users cannot use this API to delete SMS body templates.
DescribeSmsSignListResponse	DescribeSmsSignList(DescribeSmsSignListRequest req) > Note: individual users cannot use this API to query SMS signatures.
DescribeSmsTemplateListResponse	DescribeSmsTemplateList(DescribeSmsTemplateListRequest req) > Note: individual users cannot use this API to query SMS body templates.
ModifySmsSignResponse	ModifySmsSign(ModifySmsSignRequest req) This API is used to modify an SMS signature.
ModifySmsTemplateResponse	ModifySmsTemplate(ModifySmsTemplateRequest req) This API is used to modify an SMS body template.
PullSmsReplyStatusResponse	PullSmsReplyStatus(PullSmsReplyStatusRequest req) This API is used to pull SMS reply status.
PullSmsReplyStatusByPhoneNumberResponse	PullSmsReplyStatusByPhoneNumber(PullSmsReplyStatusByPhoneNumberRequest req) This API is used to pull SMS reply status for one single number.
PullSmsSendStatusResponse	PullSmsSendStatus(PullSmsSendStatusRequest req) This API is used to pull SMS delivery status.
PullSmsSendStatusByPhoneNumberResponse	PullSmsSendStatusByPhoneNumber(PullSmsSendStatusByPhoneNumberRequest req) This API is used to pull SMS delivery status for one single number.
SendSmsResponse	SendSms(SendSmsRequest req) This API is used to send SMS verification codes, notification, or marketing messages to users.
SendStatusStatisticsResponse	SendStatusStatistics(SendStatusStatisticsRequest req) This API is used to collect statistics on SMS sent by users.
SmsPackagesStatisticsResponse	SmsPackagesStatistics(SmsPackagesStatisticsRequest req) This API is used to collect statistics on user's packages.

Methods inherited from class com.tencentcloudapi.common.AbstractClient

call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, internalRequest, internalRequestRaw, processResponseJson, processResponseSSE, retry, setClientProfile, setCredential, setRegion, setRegionBreaker

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SmsClient

public SmsClient(Credential credential,
                 String region)

SmsClient

public SmsClient(Credential credential,
                 String region,
                 ClientProfile profile)

Method Detail

AddSmsSign

public AddSmsSignResponse AddSmsSign(AddSmsSignRequest req)
                              throws TencentCloudSDKException

This API is used to add an SMS signature. Please read the [Tencent Cloud SMS Signature Review Standards](https://intl.cloud.tencent.com/document/product/382/39022?from_cn_redirect=1) before starting an application. > Note: individual users cannot use this API to apply for SMS signatures. For more information, please see [Identity Verification Overview](https://intl.cloud.tencent.com/document/product/378/3629?from_cn_redirect=1). If your account identity is individual, please log in to the console to apply for SMS signatures. For detailed directions, please see [Creating SMS Signatures](https://intl.cloud.tencent.com/document/product/382/36136?from_cn_redirect=1#Sign).

Parameters:

req - AddSmsSignRequest

Returns:

AddSmsSignResponse

Throws:

TencentCloudSDKException

AddSmsTemplate

public AddSmsTemplateResponse AddSmsTemplate(AddSmsTemplateRequest req)
                                      throws TencentCloudSDKException

This API is used to add an SMS template. Please read the [Tencent Cloud SMS Body Template Review Standards](https://intl.cloud.tencent.com/document/product/382/39023?from_cn_redirect=1) before starting an application. > Note: individual users cannot use this API to apply for SMS body templates. For more information, please see [Identity Verification Overview](https://intl.cloud.tencent.com/document/product/378/3629?from_cn_redirect=1). If your account identity is individual, please log in to the console to apply for SMS body templates. For detailed directions, please see [Creating SMS Body Templates](https://intl.cloud.tencent.com/document/product/382/36136?from_cn_redirect=1#Template).

Parameters:

req - AddSmsTemplateRequest

Returns:

AddSmsTemplateResponse

Throws:

TencentCloudSDKException

CallbackStatusStatistics

public CallbackStatusStatisticsResponse CallbackStatusStatistics(CallbackStatusStatisticsRequest req)
                                                          throws TencentCloudSDKException

This API is used to collect statistics on user receipts.

Parameters:

req - CallbackStatusStatisticsRequest

Returns:

CallbackStatusStatisticsResponse

Throws:

TencentCloudSDKException

DeleteSmsSign

public DeleteSmsSignResponse DeleteSmsSign(DeleteSmsSignRequest req)
                                    throws TencentCloudSDKException

> Note: individual users cannot use this API to delete SMS signatures. For more information, please see [Identity Verification Overview](https://intl.cloud.tencent.com/document/product/378/3629?from_cn_redirect=1). You can log in to the console to delete SMS signatures. For detailed directions, please see the notes on deleting SMS signatures in [SMS Signature Operations](https://intl.cloud.tencent.com/document/product/382/36136?from_cn_redirect=1#Sign).

Parameters:

req - DeleteSmsSignRequest

Returns:

DeleteSmsSignResponse

Throws:

TencentCloudSDKException

DeleteSmsTemplate

public DeleteSmsTemplateResponse DeleteSmsTemplate(DeleteSmsTemplateRequest req)
                                            throws TencentCloudSDKException

> Note: individual users cannot use this API to delete SMS body templates. For more information, please see [Identity Verification Overview](https://intl.cloud.tencent.com/document/product/378/3629?from_cn_redirect=1). You can log in to the console to delete SMS body templates. For detailed directions, please see the notes on deleting SMS body templates in [SMS Body Template Operations](https://intl.cloud.tencent.com/document/product/382/36136?from_cn_redirect=1#Template).

Parameters:

req - DeleteSmsTemplateRequest

Returns:

DeleteSmsTemplateResponse

Throws:

TencentCloudSDKException

DescribeSmsSignList

public DescribeSmsSignListResponse DescribeSmsSignList(DescribeSmsSignListRequest req)
                                                throws TencentCloudSDKException

> Note: individual users cannot use this API to query SMS signatures. For more information, please see [Identity Verification Overview](https://intl.cloud.tencent.com/document/product/378/3629?from_cn_redirect=1).

Parameters:

req - DescribeSmsSignListRequest

Returns:

DescribeSmsSignListResponse

Throws:

TencentCloudSDKException

DescribeSmsTemplateList

public DescribeSmsTemplateListResponse DescribeSmsTemplateList(DescribeSmsTemplateListRequest req)
                                                        throws TencentCloudSDKException

> Note: individual users cannot use this API to query SMS body templates. For more information, please see [Identity Verification Overview](https://intl.cloud.tencent.com/document/product/378/3629?from_cn_redirect=1).

Parameters:

req - DescribeSmsTemplateListRequest

Returns:

DescribeSmsTemplateListResponse

Throws:

TencentCloudSDKException

ModifySmsSign

public ModifySmsSignResponse ModifySmsSign(ModifySmsSignRequest req)
                                    throws TencentCloudSDKException

This API is used to modify an SMS signature. Please read the [Tencent Cloud SMS Signature Review Standards](https://intl.cloud.tencent.com/document/product/382/39022?from_cn_redirect=1) before making a modification. >- Note: individual users cannot use this API to modify SMS signatures. For more information, please see [Identity Verification Overview](https://intl.cloud.tencent.com/document/product/378/3629?from_cn_redirect=1). If your account identity is individual, you can log in to the console to modify SMS signatures. >- Modifications can be made only if the signature status is **pending review** or **rejected**. **Approved** signatures cannot be modified.

Parameters:

req - ModifySmsSignRequest

Returns:

ModifySmsSignResponse

Throws:

TencentCloudSDKException

ModifySmsTemplate

public ModifySmsTemplateResponse ModifySmsTemplate(ModifySmsTemplateRequest req)
                                            throws TencentCloudSDKException

This API is used to modify an SMS body template. Please read the [Tencent Cloud SMS Body Template Review Standards](https://intl.cloud.tencent.com/document/product/382/39023?from_cn_redirect=1) before making a modification. >- Note: individual users cannot use this API to modify SMS body templates. For more information, please see [Identity Verification Overview](https://intl.cloud.tencent.com/document/product/378/3629?from_cn_redirect=1). If your account identity is individual, you can log in to the console to modify SMS body templates. >- Modifications can be made only if the body template status is **pending review** or **rejected**. **Approved** body templates cannot be modified.

Parameters:

req - ModifySmsTemplateRequest

Returns:

ModifySmsTemplateResponse

Throws:

TencentCloudSDKException

PullSmsReplyStatus

public PullSmsReplyStatusResponse PullSmsReplyStatus(PullSmsReplyStatusRequest req)
                                              throws TencentCloudSDKException

This API is used to pull SMS reply status.

Parameters:

req - PullSmsReplyStatusRequest

Returns:

PullSmsReplyStatusResponse

Throws:

TencentCloudSDKException

PullSmsReplyStatusByPhoneNumber

public PullSmsReplyStatusByPhoneNumberResponse PullSmsReplyStatusByPhoneNumber(PullSmsReplyStatusByPhoneNumberRequest req)
                                                                        throws TencentCloudSDKException

This API is used to pull SMS reply status for one single number.

Parameters:

req - PullSmsReplyStatusByPhoneNumberRequest

Returns:

PullSmsReplyStatusByPhoneNumberResponse

Throws:

TencentCloudSDKException

PullSmsSendStatus

public PullSmsSendStatusResponse PullSmsSendStatus(PullSmsSendStatusRequest req)
                                            throws TencentCloudSDKException

This API is used to pull SMS delivery status.

Parameters:

req - PullSmsSendStatusRequest

Returns:

PullSmsSendStatusResponse

Throws:

TencentCloudSDKException

PullSmsSendStatusByPhoneNumber

public PullSmsSendStatusByPhoneNumberResponse PullSmsSendStatusByPhoneNumber(PullSmsSendStatusByPhoneNumberRequest req)
                                                                      throws TencentCloudSDKException

This API is used to pull SMS delivery status for one single number.

Parameters:

req - PullSmsSendStatusByPhoneNumberRequest

Returns:

PullSmsSendStatusByPhoneNumberResponse

Throws:

TencentCloudSDKException

SendSms

public SendSmsResponse SendSms(SendSmsRequest req)
                        throws TencentCloudSDKException

This API is used to send SMS verification codes, notification, or marketing messages to users.

Parameters:

req - SendSmsRequest

Returns:

SendSmsResponse

Throws:

TencentCloudSDKException

SendStatusStatistics

public SendStatusStatisticsResponse SendStatusStatistics(SendStatusStatisticsRequest req)
                                                  throws TencentCloudSDKException

This API is used to collect statistics on SMS sent by users.

Parameters:

req - SendStatusStatisticsRequest

Returns:

SendStatusStatisticsResponse

Throws:

TencentCloudSDKException

SmsPackagesStatistics

public SmsPackagesStatisticsResponse SmsPackagesStatistics(SmsPackagesStatisticsRequest req)
                                                    throws TencentCloudSDKException

This API is used to collect statistics on user's packages.

Parameters:

req - SmsPackagesStatisticsRequest

Returns:

SmsPackagesStatisticsResponse

Throws:

TencentCloudSDKException