SmsClient (tencentcloud-sdk-java-intl-en 3.0.523 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.sms.v20210111.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddSmsSignResponse`	`AddSmsSign(AddSmsSignRequest req)` 1.
`AddSmsTemplateResponse`	`AddSmsTemplate(AddSmsTemplateRequest req)` 1.
`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.
`DescribePhoneNumberInfoResponse`	`DescribePhoneNumberInfo(DescribePhoneNumberInfoRequest req)` This API is used to query the information of a phone number, including country/region code and standardized E.164 format number.
`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)` 1.
`ModifySmsTemplateResponse`	`ModifySmsTemplate(ModifySmsTemplateRequest req)` 1.
`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.
`ReportConversionResponse`	`ReportConversion(ReportConversionRequest req)` This API is used to report the SMS conversion rate (SMS conversion rate = the number of returned verification codes / the number of verification codes sent) and report the serial numbers of received SMS messages to Tencent Cloud SMS.
`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 messages sent by users.

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

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
```
    1. This API is used to add an SMS signature. You need to read the [Tencent Cloud SMS Signature Review Standards](https://intl.cloud.tencent.com/zh/document/product/382/40658) before starting an application. 2. ⚠️ Note: individual users cannot use this API to apply for SMS signatures. For more information, 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 apply for SMS signatures. >- Note: because of the improved security of **TencentCloud API 3.0**, **API authentication** is more complicated. We recommend you use the Tencent Cloud SMS service with the SDK. >- You can run this API directly in [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
    
    Parameters:
    
    req - AddSmsSignRequest
    
    Returns:
    
    AddSmsSignResponse
    
    Throws:
    
    TencentCloudSDKException
  - AddSmsTemplate
```
public AddSmsTemplateResponse AddSmsTemplate(AddSmsTemplateRequest req)
                                      throws TencentCloudSDKException
```
    1. This API is used to add an SMS template. You need to read the [Tencent Cloud SMS Body Template Review Standards](https://intl.cloud.tencent.com/zh/document/product/382/40659) before starting an application. 2. ⚠️ Note: individual users cannot use this API to apply for SMS body templates. For more information, see [Identity Verification Overview](https://intl.cloud.tencent.com/zh/document/product/378/3629). If your account identity is individual, you can log in to the [console](https://console.cloud.tencent.com/smsv2) to apply for SMS body templates. >- Note: because of the improved security of **TencentCloud API 3.0**, **API authentication** is more complicated. We recommend you use the Tencent Cloud SMS service with the SDK. >- You can run this API directly in [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
    
    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. >- Note: because of the improved security of **TencentCloud API 3.0**, **API authentication** is more complicated. We recommend you use the Tencent Cloud SMS service with the SDK. >- You can run this API directly in [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
    
    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). Please log in to the [console](https://console.cloud.tencent.com/smsv2) to delete SMS signatures. >- Note: because of the improved security of **TencentCloud API 3.0**, **API authentication** is more complicated. We recommend you use the Tencent Cloud SMS service with the SDK. >- You can run this API directly in [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
    
    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. Please log in to the [console](https://console.cloud.tencent.com/smsv2) to do so. For more information, please see [Identity Verification Overview](https://intl.cloud.tencent.com/document/product/378/3629?from_cn_redirect=1). >- Note: because of the improved security of **TencentCloud API 3.0**, **API authentication** is more complicated. We recommend you use the Tencent Cloud SMS service with the SDK. >- You can run this API directly in [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
    
    Parameters:
    
    req - DeleteSmsTemplateRequest
    
    Returns:
    
    DeleteSmsTemplateResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribePhoneNumberInfo
```
public DescribePhoneNumberInfoResponse DescribePhoneNumberInfo(DescribePhoneNumberInfoRequest req)
                                                        throws TencentCloudSDKException
```
    This API is used to query the information of a phone number, including country/region code and standardized E.164 format number. >- For example, if you query the number +86018845720123, you can get the country/region code 86 and the standardized E.164 number +8618845720123.
    
    Parameters:
    
    req - DescribePhoneNumberInfoRequest
    
    Returns:
    
    DescribePhoneNumberInfoResponse
    
    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). If your account identity is individual, you can log in to the [console](https://console.cloud.tencent.com/smsv2) to query SMS signatures. >- Note: because of the improved security of **TencentCloud API 3.0**, **API authentication** is more complicated. We recommend you use the Tencent Cloud SMS service with the SDK. >- You can run this API directly in [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
    
    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). >- Note: because of the improved security of **TencentCloud API 3.0**, **API authentication** is more complicated. We recommend you use the Tencent Cloud SMS service with the SDK. >- You can run this API directly in [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
    
    Parameters:
    
    req - DescribeSmsTemplateListRequest
    
    Returns:
    
    DescribeSmsTemplateListResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifySmsSign
```
public ModifySmsSignResponse ModifySmsSign(ModifySmsSignRequest req)
                                    throws TencentCloudSDKException
```
    1. This API is used to modify an SMS signature. Read the [Tencent Cloud SMS signature review standards](https://intl.cloud.tencent.com/document/product/382/40658) before making a modification. 2. ⚠️ Note: Individual users cannot use this API to modify SMS signatures. For more information, see [Identity Verification Guide](https://intl.cloud.tencent.com/document/product/378/3629). If your account identity is individual, you can log in to the [console](https://console.cloud.tencent.com/smsv2) to modify SMS signatures. 3. Modifications can be made only if the signature status is **Pending Review** or **Rejected**. **Approved** signatures cannot be modified. >- Note: Because of the improved security of **TencentCloud API 3.0**, **API authentication** is more complicated. We recommend you use the Tencent Cloud SMS service with the SDK. >- You can run this API directly in [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
    
    Parameters:
    
    req - ModifySmsSignRequest
    
    Returns:
    
    ModifySmsSignResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifySmsTemplate
```
public ModifySmsTemplateResponse ModifySmsTemplate(ModifySmsTemplateRequest req)
                                            throws TencentCloudSDKException
```
    1. 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. 2. ⚠️ 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](https://console.cloud.tencent.com/smsv2) to modify SMS body templates. 3. Modifications can be made only if the body template status is **Pending Review** or **Rejected**. **Approved** body templates cannot be modified. >- Note: because of the improved security of **TencentCloud API 3.0**, **API authentication** is more complicated. We recommend you use the Tencent Cloud SMS service with the SDK. >- You can run this API directly in [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
    
    Parameters:
    
    req - ModifySmsTemplateRequest
    
    Returns:
    
    ModifySmsTemplateResponse
    
    Throws:
    
    TencentCloudSDKException
  - PullSmsReplyStatus
```
public PullSmsReplyStatusResponse PullSmsReplyStatus(PullSmsReplyStatusRequest req)
                                              throws TencentCloudSDKException
```
    This API is used to pull SMS reply status. Currently, you can also [configure the reply callback](https://intl.cloud.tencent.com/document/product/382/42907?from_cn_redirect=1) to get replies. >- Note: You need to contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) to activate this API. >- Note: Because of the improved security of **TencentCloud API 3.0**, **API authentication** is more complicated. We recommend you use the Tencent Cloud SMS service with the SDK. >- You can run this API directly in [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
    
    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. Currently, you can also [configure the reply callback](https://intl.cloud.tencent.com/document/product/382/42907?from_cn_redirect=1) to get replies. >- Note: because of the improved security of **TencentCloud API 3.0**, **API authentication** is more complicated. We recommend you use the Tencent Cloud SMS service with the SDK. >- You can run this API directly in [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
    
    Parameters:
    
    req - PullSmsReplyStatusByPhoneNumberRequest
    
    Returns:
    
    PullSmsReplyStatusByPhoneNumberResponse
    
    Throws:
    
    TencentCloudSDKException
  - PullSmsSendStatus
```
public PullSmsSendStatusResponse PullSmsSendStatus(PullSmsSendStatusRequest req)
                                            throws TencentCloudSDKException
```
    This API is used to pull SMS delivery status. Currently, you can also [configure the callback](https://intl.cloud.tencent.com/document/product/382/37809?from_cn_redirect=1#.E8.AE.BE.E7.BD.AE.E4.BA.8B.E4.BB.B6.E5.9B.9E.E8.B0.83.E9.85.8D.E7.BD.AE) to get the delivery status. >- Note: you need to contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) to activate this API. >- Note: because of the improved security of **TencentCloud API 3.0**, **API authentication** is more complicated. We recommend you use the Tencent Cloud SMS service with the SDK. >- You can run this API directly in [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
    
    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. Currently, you can also [configure the callback](https://intl.cloud.tencent.com/document/product/382/37809?from_cn_redirect=1#.E8.AE.BE.E7.BD.AE.E4.BA.8B.E4.BB.B6.E5.9B.9E.E8.B0.83.E9.85.8D.E7.BD.AE) to get the delivery status. >- Note: because of the improved security of **TencentCloud API 3.0**, **API authentication** is more complicated. We recommend you use the Tencent Cloud SMS service with the SDK. >- You can run this API directly in [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) to eliminate the need to calculate signatures. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
    
    Parameters:
    
    req - PullSmsSendStatusByPhoneNumberRequest
    
    Returns:
    
    PullSmsSendStatusByPhoneNumberResponse
    
    Throws:
    
    TencentCloudSDKException
  - ReportConversion
```
public ReportConversionResponse ReportConversion(ReportConversionRequest req)
                                          throws TencentCloudSDKException
```
    This API is used to report the SMS conversion rate (SMS conversion rate = the number of returned verification codes / the number of verification codes sent) and report the serial numbers of received SMS messages to Tencent Cloud SMS. >- Note: To call this API, you need to be added to the allowlist first. If you have any questions, contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81).
    
    Parameters:
    
    req - ReportConversionRequest
    
    Returns:
    
    ReportConversionResponse
    
    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. >- Note: Because of the improved security of **TencentCloud API 3.0**, **API authentication** is more complicated. We recommend you use the Tencent Cloud SMS service with the [SDK](https://intl.cloud.tencent.com/document/product/382/43193?from_cn_redirect=1). >- Note: You can run this API directly in [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples. >- Note: This API is currently on the 2021-01-11 version. If you are still using the [2019-07-11 version](https://intl.cloud.tencent.com/document/product/382/38778?from_cn_redirect=1), we recommend you use this latest version. For version differences, see [Version description](https://intl.cloud.tencent.com/document/product/382/63195?from_cn_redirect=1#.E7.89.88.E6.9C.AC.E6.8F.8F.E8.BF.B0).
    
    Parameters:
    
    req - SendSmsRequest
    
    Returns:
    
    SendSmsResponse
    
    Throws:
    
    TencentCloudSDKException
  - SendStatusStatistics
```
public SendStatusStatisticsResponse SendStatusStatistics(SendStatusStatisticsRequest req)
                                                  throws TencentCloudSDKException
```
    This API is used to collect statistics on SMS messages sent by users. >- Note: because of the improved security of **TencentCloud API 3.0**, **API authentication** is more complicated. We recommend you use the Tencent Cloud SMS service with the SDK. >- You can run this API directly in [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
    
    Parameters:
    
    req - SendStatusStatisticsRequest
    
    Returns:
    
    SendStatusStatisticsResponse
    
    Throws:
    
    TencentCloudSDKException

Class SmsClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

SmsClient

SmsClient

Method Detail

AddSmsSign

AddSmsTemplate

CallbackStatusStatistics

DeleteSmsSign

DeleteSmsTemplate

DescribePhoneNumberInfo

DescribeSmsSignList

DescribeSmsTemplateList

ModifySmsSign

ModifySmsTemplate

PullSmsReplyStatus

PullSmsReplyStatusByPhoneNumber

PullSmsSendStatus

PullSmsSendStatusByPhoneNumber

ReportConversion

SendSms

SendStatusStatistics