SmsClient (tencentcloud-sdk-java 3.1.14 API)

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddSmsSignResponse`	`AddSmsSign(AddSmsSignRequest req)` 添加短信签名，申请之前请先认证参阅 [腾讯云短信签名审核标准](https://cloud.tencent.com/document/product/382/39022)。 >⚠️注意：个人认证用户不支持使用 API 申请短信签名，请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)，如果为个人认证请登录控制台申请短信签名，具体操作请参阅 [创建短信签名](https://cloud.tencent.com/document/product/382/36136#Sign)。
`AddSmsTemplateResponse`	`AddSmsTemplate(AddSmsTemplateRequest req)` 添加短信模版，申请之前请先认证参阅 [腾讯云短信正文模版审核标准](https://cloud.tencent.com/document/product/382/39023)。 >⚠️注意：个人认证用户不支持使用 API 申请短信正文模版，请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)，如果为个人认证请登录控制台申请短信正文模版，具体操作请参阅 [创建短信正文模版](https://cloud.tencent.com/document/product/382/36136#Template)。
`CallbackStatusStatisticsResponse`	`CallbackStatusStatistics(CallbackStatusStatisticsRequest req)` 统计用户回执的数据。
`DeleteSmsSignResponse`	`DeleteSmsSign(DeleteSmsSignRequest req)` >⚠️注意：个人认证用户不支持使用 API 删除短信签名，请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)，请登录控制台删除短信签名，具体操作请参阅 [短信签名操作](https://cloud.tencent.com/document/product/382/36136#Sign) 中查看删除短信签名须知。
`DeleteSmsTemplateResponse`	`DeleteSmsTemplate(DeleteSmsTemplateRequest req)` >⚠️注意：个人认证用户不支持使用 API 删除短信正文模版，请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)，请登录控制台删除短信正文模版，具体操作请参阅 [短信正文模版操作](https://cloud.tencent.com/document/product/382/36136#Template) 中查看删除短信正文模版须知。
`DescribeSmsSignListResponse`	`DescribeSmsSignList(DescribeSmsSignListRequest req)` >⚠️注意：个人认证用户不支持使用 API 查询短信签名，请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)。
`DescribeSmsTemplateListResponse`	`DescribeSmsTemplateList(DescribeSmsTemplateListRequest req)` >⚠️注意：个人认证用户不支持使用 API 查询短信正文模版，请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)。
`ModifySmsSignResponse`	`ModifySmsSign(ModifySmsSignRequest req)` 修改短信签名，修改之前请先认证参阅 [腾讯云短信签名审核标准](https://cloud.tencent.com/document/product/382/39022)。 >- ⚠️注意：个人认证用户不支持使用 API 修改短信签名，请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)，如果为个人认证请登录控制台修改短信签名。 >- 修改短信签名，仅当签名为待审核或已拒绝状态时，才能进行修改，已审核通过的签名不支持修改。
`ModifySmsTemplateResponse`	`ModifySmsTemplate(ModifySmsTemplateRequest req)` 修改短信正文模版，修改之前请先认真参阅 [腾讯云短信正文模版审核标准](https://cloud.tencent.com/document/product/382/39023)。 >- ⚠️注意：个人认证用户不支持使用 API 修改短信正文模版，请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)，如果为个人认证请登录控制台申请短信正文模版。 >- 修改短信签名，仅当正文模版为待审核或已拒绝状态时，才能进行修改，已审核通过的正文模版不支持修改。
`PullSmsReplyStatusResponse`	`PullSmsReplyStatus(PullSmsReplyStatusRequest req)` 拉取短信回复状态。
`PullSmsReplyStatusByPhoneNumberResponse`	`PullSmsReplyStatusByPhoneNumber(PullSmsReplyStatusByPhoneNumberRequest req)` 拉取单个号码短信回复状态。
`PullSmsSendStatusResponse`	`PullSmsSendStatus(PullSmsSendStatusRequest req)` 拉取短信下发状态。
`PullSmsSendStatusByPhoneNumberResponse`	`PullSmsSendStatusByPhoneNumber(PullSmsSendStatusByPhoneNumberRequest req)` 拉取单个号码短信下发状态。
`SendSmsResponse`	`SendSms(SendSmsRequest req)` 短信发送接口，用户给用户发短信验证码、通知类短信或营销短信。
`SendStatusStatisticsResponse`	`SendStatusStatistics(SendStatusStatisticsRequest req)` 统计用户发送短信的数据。
`SmsPackagesStatisticsResponse`	`SmsPackagesStatistics(SmsPackagesStatisticsRequest req)` 用户套餐包信息统计。

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
```
    添加短信签名，申请之前请先认证参阅 [腾讯云短信签名审核标准](https://cloud.tencent.com/document/product/382/39022)。 >⚠️注意：个人认证用户不支持使用 API 申请短信签名，请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)，如果为个人认证请登录控制台申请短信签名，具体操作请参阅 [创建短信签名](https://cloud.tencent.com/document/product/382/36136#Sign)。
    
    Parameters:
    
    req - AddSmsSignRequest
    
    Returns:
    
    AddSmsSignResponse
    
    Throws:
    
    TencentCloudSDKException
  - AddSmsTemplate
```
public AddSmsTemplateResponse AddSmsTemplate(AddSmsTemplateRequest req)
                                      throws TencentCloudSDKException
```
    添加短信模版，申请之前请先认证参阅 [腾讯云短信正文模版审核标准](https://cloud.tencent.com/document/product/382/39023)。 >⚠️注意：个人认证用户不支持使用 API 申请短信正文模版，请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)，如果为个人认证请登录控制台申请短信正文模版，具体操作请参阅 [创建短信正文模版](https://cloud.tencent.com/document/product/382/36136#Template)。
    
    Parameters:
    
    req - AddSmsTemplateRequest
    
    Returns:
    
    AddSmsTemplateResponse
    
    Throws:
    
    TencentCloudSDKException
  - CallbackStatusStatistics
```
public CallbackStatusStatisticsResponse CallbackStatusStatistics(CallbackStatusStatisticsRequest req)
                                                          throws TencentCloudSDKException
```
    统计用户回执的数据。
    
    Parameters:
    
    req - CallbackStatusStatisticsRequest
    
    Returns:
    
    CallbackStatusStatisticsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteSmsSign
```
public DeleteSmsSignResponse DeleteSmsSign(DeleteSmsSignRequest req)
                                    throws TencentCloudSDKException
```
    >⚠️注意：个人认证用户不支持使用 API 删除短信签名，请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)，请登录控制台删除短信签名，具体操作请参阅 [短信签名操作](https://cloud.tencent.com/document/product/382/36136#Sign) 中查看删除短信签名须知。
    
    Parameters:
    
    req - DeleteSmsSignRequest
    
    Returns:
    
    DeleteSmsSignResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteSmsTemplate
```
public DeleteSmsTemplateResponse DeleteSmsTemplate(DeleteSmsTemplateRequest req)
                                            throws TencentCloudSDKException
```
    >⚠️注意：个人认证用户不支持使用 API 删除短信正文模版，请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)，请登录控制台删除短信正文模版，具体操作请参阅 [短信正文模版操作](https://cloud.tencent.com/document/product/382/36136#Template) 中查看删除短信正文模版须知。
    
    Parameters:
    
    req - DeleteSmsTemplateRequest
    
    Returns:
    
    DeleteSmsTemplateResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSmsSignList
```
public DescribeSmsSignListResponse DescribeSmsSignList(DescribeSmsSignListRequest req)
                                                throws TencentCloudSDKException
```
    >⚠️注意：个人认证用户不支持使用 API 查询短信签名，请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)。
    
    Parameters:
    
    req - DescribeSmsSignListRequest
    
    Returns:
    
    DescribeSmsSignListResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSmsTemplateList
```
public DescribeSmsTemplateListResponse DescribeSmsTemplateList(DescribeSmsTemplateListRequest req)
                                                        throws TencentCloudSDKException
```
    >⚠️注意：个人认证用户不支持使用 API 查询短信正文模版，请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)。
    
    Parameters:
    
    req - DescribeSmsTemplateListRequest
    
    Returns:
    
    DescribeSmsTemplateListResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifySmsSign
```
public ModifySmsSignResponse ModifySmsSign(ModifySmsSignRequest req)
                                    throws TencentCloudSDKException
```
    修改短信签名，修改之前请先认证参阅 [腾讯云短信签名审核标准](https://cloud.tencent.com/document/product/382/39022)。 >- ⚠️注意：个人认证用户不支持使用 API 修改短信签名，请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)，如果为个人认证请登录控制台修改短信签名。 >- 修改短信签名，仅当签名为待审核或已拒绝状态时，才能进行修改，已审核通过的签名不支持修改。
    
    Parameters:
    
    req - ModifySmsSignRequest
    
    Returns:
    
    ModifySmsSignResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifySmsTemplate
```
public ModifySmsTemplateResponse ModifySmsTemplate(ModifySmsTemplateRequest req)
                                            throws TencentCloudSDKException
```
    修改短信正文模版，修改之前请先认真参阅 [腾讯云短信正文模版审核标准](https://cloud.tencent.com/document/product/382/39023)。 >- ⚠️注意：个人认证用户不支持使用 API 修改短信正文模版，请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)，如果为个人认证请登录控制台申请短信正文模版。 >- 修改短信签名，仅当正文模版为待审核或已拒绝状态时，才能进行修改，已审核通过的正文模版不支持修改。
    
    Parameters:
    
    req - ModifySmsTemplateRequest
    
    Returns:
    
    ModifySmsTemplateResponse
    
    Throws:
    
    TencentCloudSDKException
  - PullSmsReplyStatus
```
public PullSmsReplyStatusResponse PullSmsReplyStatus(PullSmsReplyStatusRequest req)
                                              throws TencentCloudSDKException
```
    拉取短信回复状态。
    
    Parameters:
    
    req - PullSmsReplyStatusRequest
    
    Returns:
    
    PullSmsReplyStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - PullSmsReplyStatusByPhoneNumber
```
public PullSmsReplyStatusByPhoneNumberResponse PullSmsReplyStatusByPhoneNumber(PullSmsReplyStatusByPhoneNumberRequest req)
                                                                        throws TencentCloudSDKException
```
    拉取单个号码短信回复状态。
    
    Parameters:
    
    req - PullSmsReplyStatusByPhoneNumberRequest
    
    Returns:
    
    PullSmsReplyStatusByPhoneNumberResponse
    
    Throws:
    
    TencentCloudSDKException
  - PullSmsSendStatus
```
public PullSmsSendStatusResponse PullSmsSendStatus(PullSmsSendStatusRequest req)
                                            throws TencentCloudSDKException
```
    拉取短信下发状态。
    
    Parameters:
    
    req - PullSmsSendStatusRequest
    
    Returns:
    
    PullSmsSendStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - PullSmsSendStatusByPhoneNumber
```
public PullSmsSendStatusByPhoneNumberResponse PullSmsSendStatusByPhoneNumber(PullSmsSendStatusByPhoneNumberRequest req)
                                                                      throws TencentCloudSDKException
```
    拉取单个号码短信下发状态。
    
    Parameters:
    
    req - PullSmsSendStatusByPhoneNumberRequest
    
    Returns:
    
    PullSmsSendStatusByPhoneNumberResponse
    
    Throws:
    
    TencentCloudSDKException
  - SendSms
```
public SendSmsResponse SendSms(SendSmsRequest req)
                        throws TencentCloudSDKException
```
    短信发送接口，用户给用户发短信验证码、通知类短信或营销短信。
    
    Parameters:
    
    req - SendSmsRequest
    
    Returns:
    
    SendSmsResponse
    
    Throws:
    
    TencentCloudSDKException
  - SendStatusStatistics
```
public SendStatusStatisticsResponse SendStatusStatistics(SendStatusStatisticsRequest req)
                                                  throws TencentCloudSDKException
```
    统计用户发送短信的数据。
    
    Parameters:
    
    req - SendStatusStatisticsRequest
    
    Returns:
    
    SendStatusStatisticsResponse
    
    Throws:
    
    TencentCloudSDKException
  - SmsPackagesStatistics
```
public SmsPackagesStatisticsResponse SmsPackagesStatistics(SmsPackagesStatisticsRequest req)
                                                    throws TencentCloudSDKException
```
    用户套餐包信息统计。
    
    Parameters:
    
    req - SmsPackagesStatisticsRequest
    
    Returns:
    
    SmsPackagesStatisticsResponse
    
    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

DescribeSmsSignList

DescribeSmsTemplateList

ModifySmsSign

ModifySmsTemplate

PullSmsReplyStatus

PullSmsReplyStatusByPhoneNumber

PullSmsSendStatus

PullSmsSendStatusByPhoneNumber

SendSms

SendStatusStatistics

SmsPackagesStatistics