SmsClient (tencentcloud-sdk-java-sms 3.1.1281 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.sms.v20210111.SmsClient

public class SmsClient
extends com.tencentcloudapi.common.AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor and Description
`SmsClient(com.tencentcloudapi.common.Credential credential, String region)`
`SmsClient(com.tencentcloudapi.common.Credential credential, String region, com.tencentcloudapi.common.profile.ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddSmsSignResponse`	`AddSmsSign(AddSmsSignRequest req)` 本接口 (AddSmsSign) 用于添加短信签名。说明：
`AddSmsTemplateResponse`	`AddSmsTemplate(AddSmsTemplateRequest req)` 本接口 (AddSmsTemplate) 用于创建短信模板。说明：
`CallbackStatusStatisticsResponse`	`CallbackStatusStatistics(CallbackStatusStatisticsRequest req)` 本接口 (CallbackStatusStatistics) 用于统计用户回执的数据。
`DeleteSmsSignResponse`	`DeleteSmsSign(DeleteSmsSignRequest req)` 本接口 (DeleteSmsSign) 用于删除短信签名。说明：
`DeleteSmsTemplateResponse`	`DeleteSmsTemplate(DeleteSmsTemplateRequest req)` 本接口 (DeleteSmsTemplate) 用于删除短信模板。说明：
`DescribePhoneNumberInfoResponse`	`DescribePhoneNumberInfo(DescribePhoneNumberInfoRequest req)` 本接口 (DescribePhoneNumberInfo) 用于提供电话号码的信息查询，包括国家（或地区）码、规范的 E.164 格式号码等。 - 例如：查询号码 +86018501234444，可以得到国家码 86、规范的 E.164 号码 +8618501234444 等信息。
`DescribeSmsSignListResponse`	`DescribeSmsSignList(DescribeSmsSignListRequest req)` 本接口 (DescribeSmsSignList) 用于查询短信签名状态。说明：
`DescribeSmsTemplateListResponse`	`DescribeSmsTemplateList(DescribeSmsTemplateListRequest req)` 本接口 (DescribeSmsTemplateList) 用于查询短信模板状态。说明：
`ModifySmsSignResponse`	`ModifySmsSign(ModifySmsSignRequest req)` 本接口 (ModifySmsSign) 用于修改短信签名。说明：
`ModifySmsTemplateResponse`	`ModifySmsTemplate(ModifySmsTemplateRequest req)` 本接口 (ModifySmsTemplate) 用于修改短信模板。说明：
`PullSmsReplyStatusResponse`	`PullSmsReplyStatus(PullSmsReplyStatusRequest req)` 本接口 (PullSmsReplyStatus) 用于拉取短信回复状态。说明：
`PullSmsReplyStatusByPhoneNumberResponse`	`PullSmsReplyStatusByPhoneNumber(PullSmsReplyStatusByPhoneNumberRequest req)` 本接口 (PullSmsReplyStatusByPhoneNumber) 用于拉取单个号码短信回复状态。说明：
`PullSmsSendStatusResponse`	`PullSmsSendStatus(PullSmsSendStatusRequest req)` 本接口 (PullSmsSendStatus) 用于拉取短信下发状态。说明：
`PullSmsSendStatusByPhoneNumberResponse`	`PullSmsSendStatusByPhoneNumber(PullSmsSendStatusByPhoneNumberRequest req)` 本接口 (PullSmsSendStatusByPhoneNumber) 用于拉取单个号码短信下发状态。说明：
`ReportConversionResponse`	`ReportConversion(ReportConversionRequest req)` 本接口 (ReportConversion) 用于短信转化率上报。将已接收到短信的流水号上报到腾讯云短信服务。说明：
`SendSmsResponse`	`SendSms(SendSmsRequest req)` 本接口 (SendSms) 用于发送验证码、通知类短信和营销短信。支持国内短信与国际/港澳台短信。 - 当前接口属于 2021-01-11 版本，如果您仍在使用 [2019-07-11 版本](https://cloud.tencent.com/document/product/382/38778)，建议您使用当前最新版本的接口，版本差异可参考[版本描述](https://cloud.tencent.com/document/product/382/63195#.E7.89.88.E6.9C.AC.E6.8F.8F.E8.BF.B0)。
`SendStatusStatisticsResponse`	`SendStatusStatistics(SendStatusStatisticsRequest req)` 本接口 (SendStatusStatistics) 用于统计用户发送短信的数据。
`SmsPackagesStatisticsResponse`	`SmsPackagesStatistics(SmsPackagesStatisticsRequest req)` 本接口 (SmsPackagesStatistics) 用于统计用户套餐包数据。

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(com.tencentcloudapi.common.Credential credential,
                 String region)
```
  - SmsClient
```
public SmsClient(com.tencentcloudapi.common.Credential credential,
                 String region,
                 com.tencentcloudapi.common.profile.ClientProfile profile)
```
- Method Detail
  - AddSmsSign
```
public AddSmsSignResponse AddSmsSign(AddSmsSignRequest req)
                              throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    本接口 (AddSmsSign) 用于添加短信签名。
    说明：
    添加短信签名前，请先认真参阅腾讯云短信签名审核标准。
    个人认证用户不支持使用 API 申请短信签名，请参阅了解实名认证基本介绍，如果为个人认证请登录控制台申请短信签名。
    Parameters:
    
    req - AddSmsSignRequest
    
    Returns:
    
    AddSmsSignResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - AddSmsTemplate
```
public AddSmsTemplateResponse AddSmsTemplate(AddSmsTemplateRequest req)
                                      throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    本接口 (AddSmsTemplate) 用于创建短信模板。
    说明：
    申请短信模板前，请先认真参阅腾讯云短信正文模板审核标准。
    个人认证用户不支持使用 API 申请短信正文模板，请参阅了解实名认证基本介绍，如果为个人认证请登录控制台申请短信正文模板。
    Parameters:
    
    req - AddSmsTemplateRequest
    
    Returns:
    
    AddSmsTemplateResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - CallbackStatusStatistics
```
public CallbackStatusStatisticsResponse CallbackStatusStatistics(CallbackStatusStatisticsRequest req)
                                                          throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    本接口 (CallbackStatusStatistics) 用于统计用户回执的数据。
    
    Parameters:
    
    req - CallbackStatusStatisticsRequest
    
    Returns:
    
    CallbackStatusStatisticsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DeleteSmsSign
```
public DeleteSmsSignResponse DeleteSmsSign(DeleteSmsSignRequest req)
                                    throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    本接口 (DeleteSmsSign) 用于删除短信签名。
    说明：
    个人认证用户不支持使用 API 删除短信签名，请参阅了解实名认证基本介绍，如果为个人认证请登录控制台删除短信签名。
    Parameters:
    
    req - DeleteSmsSignRequest
    
    Returns:
    
    DeleteSmsSignResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DeleteSmsTemplate
```
public DeleteSmsTemplateResponse DeleteSmsTemplate(DeleteSmsTemplateRequest req)
                                            throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    本接口 (DeleteSmsTemplate) 用于删除短信模板。
    说明：
    个人认证用户不支持使用 API 删除短信正文模板，请参阅了解实名认证基本介绍，如果为个人认证请登录控制台删除短信正文模板。
    Parameters:
    
    req - DeleteSmsTemplateRequest
    
    Returns:
    
    DeleteSmsTemplateResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribePhoneNumberInfo
```
public DescribePhoneNumberInfoResponse DescribePhoneNumberInfo(DescribePhoneNumberInfoRequest req)
                                                        throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    本接口 (DescribePhoneNumberInfo) 用于提供电话号码的信息查询，包括国家（或地区）码、规范的 E.164 格式号码等。 - 例如：查询号码 +86018501234444，可以得到国家码 86、规范的 E.164 号码 +8618501234444 等信息。
    
    Parameters:
    
    req - DescribePhoneNumberInfoRequest
    
    Returns:
    
    DescribePhoneNumberInfoResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeSmsSignList
```
public DescribeSmsSignListResponse DescribeSmsSignList(DescribeSmsSignListRequest req)
                                                throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    本接口 (DescribeSmsSignList) 用于查询短信签名状态。
    说明：
    个人认证用户不支持使用 API 查询短信签名，请参阅了解实名认证基本介绍，如果为个人认证请登录控制台查询短信签名。
    Parameters:
    
    req - DescribeSmsSignListRequest
    
    Returns:
    
    DescribeSmsSignListResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeSmsTemplateList
```
public DescribeSmsTemplateListResponse DescribeSmsTemplateList(DescribeSmsTemplateListRequest req)
                                                        throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    本接口 (DescribeSmsTemplateList) 用于查询短信模板状态。
    说明：
    个人认证用户不支持使用 API 查询短信正文模板，请参阅了解实名认证基本介绍，如果为个人认证请登录控制台查询短信正文模板。
    Parameters:
    
    req - DescribeSmsTemplateListRequest
    
    Returns:
    
    DescribeSmsTemplateListResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ModifySmsSign
```
public ModifySmsSignResponse ModifySmsSign(ModifySmsSignRequest req)
                                    throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    本接口 (ModifySmsSign) 用于修改短信签名。
    说明：
    修改短信签名前，请先认真参阅腾讯云短信签名审核标准。
    个人认证用户不支持使用 API 修改短信签名，请参阅了解实名认证基本介绍，如果为个人认证请登录控制台修改短信签名。
    修改短信签名，仅当签名为待审核或已拒绝状态时，才能进行修改，已审核通过的签名不支持修改。
    Parameters:
    
    req - ModifySmsSignRequest
    
    Returns:
    
    ModifySmsSignResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ModifySmsTemplate
```
public ModifySmsTemplateResponse ModifySmsTemplate(ModifySmsTemplateRequest req)
                                            throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    本接口 (ModifySmsTemplate) 用于修改短信模板。
    说明：
    修改短信正文模板前，请先认真参阅腾讯云短信正文模板审核标准。
    个人认证用户不支持使用 API 修改短信正文模板，请参阅了解实名认证基本介绍，如果为个人认证请登录控制台修改短信正文模板。
    修改短信模板，仅当正文模板为待审核或已拒绝状态时，才能进行修改，已审核通过的正文模板不支持修改。
    Parameters:
    
    req - ModifySmsTemplateRequest
    
    Returns:
    
    ModifySmsTemplateResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - PullSmsReplyStatus
```
public PullSmsReplyStatusResponse PullSmsReplyStatus(PullSmsReplyStatusRequest req)
                                              throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    本接口 (PullSmsReplyStatus) 用于拉取短信回复状态。
    说明：
    此接口需要联系腾讯云短信小助手开通。
    上行回复也支持配置回复回调的方式获取。
    Parameters:
    
    req - PullSmsReplyStatusRequest
    
    Returns:
    
    PullSmsReplyStatusResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - PullSmsReplyStatusByPhoneNumber
```
public PullSmsReplyStatusByPhoneNumberResponse PullSmsReplyStatusByPhoneNumber(PullSmsReplyStatusByPhoneNumberRequest req)
                                                                        throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    本接口 (PullSmsReplyStatusByPhoneNumber) 用于拉取单个号码短信回复状态。
    说明：
    上行回复也支持配置回复回调的方式获取。
    Parameters:
    
    req - PullSmsReplyStatusByPhoneNumberRequest
    
    Returns:
    
    PullSmsReplyStatusByPhoneNumberResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - PullSmsSendStatus
```
public PullSmsSendStatusResponse PullSmsSendStatus(PullSmsSendStatusRequest req)
                                            throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    本接口 (PullSmsSendStatus) 用于拉取短信下发状态。
    说明：
    此接口需要联系腾讯云短信小助手开通。
    下发状态也支持配置回调的方式获取。
    Parameters:
    
    req - PullSmsSendStatusRequest
    
    Returns:
    
    PullSmsSendStatusResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - PullSmsSendStatusByPhoneNumber
```
public PullSmsSendStatusByPhoneNumberResponse PullSmsSendStatusByPhoneNumber(PullSmsSendStatusByPhoneNumberRequest req)
                                                                      throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    本接口 (PullSmsSendStatusByPhoneNumber) 用于拉取单个号码短信下发状态。
    说明：
    下发状态也支持配置回调的方式获取。
    Parameters:
    
    req - PullSmsSendStatusByPhoneNumberRequest
    
    Returns:
    
    PullSmsSendStatusByPhoneNumberResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ReportConversion
```
public ReportConversionResponse ReportConversion(ReportConversionRequest req)
                                          throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    本接口 (ReportConversion) 用于短信转化率上报。将已接收到短信的流水号上报到腾讯云短信服务。
    说明：
    该接口当前以白名单方式对外开放，如有需要请联系腾讯云短信小助手开通。
    Parameters:
    
    req - ReportConversionRequest
    
    Returns:
    
    ReportConversionResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - SendSms
```
public SendSmsResponse SendSms(SendSmsRequest req)
                        throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    本接口 (SendSms) 用于发送验证码、通知类短信和营销短信。支持国内短信与国际/港澳台短信。 - 当前接口属于 2021-01-11 版本，如果您仍在使用 [2019-07-11 版本](https://cloud.tencent.com/document/product/382/38778)，建议您使用当前最新版本的接口，版本差异可参考[版本描述](https://cloud.tencent.com/document/product/382/63195#.E7.89.88.E6.9C.AC.E6.8F.8F.E8.BF.B0)。
    
    Parameters:
    
    req - SendSmsRequest
    
    Returns:
    
    SendSmsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - SendStatusStatistics
```
public SendStatusStatisticsResponse SendStatusStatistics(SendStatusStatisticsRequest req)
                                                  throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    本接口 (SendStatusStatistics) 用于统计用户发送短信的数据。
    
    Parameters:
    
    req - SendStatusStatisticsRequest
    
    Returns:
    
    SendStatusStatisticsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - SmsPackagesStatistics
```
public SmsPackagesStatisticsResponse SmsPackagesStatistics(SmsPackagesStatisticsRequest req)
                                                    throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    本接口 (SmsPackagesStatistics) 用于统计用户套餐包数据。
    
    Parameters:
    
    req - SmsPackagesStatisticsRequest
    
    Returns:
    
    SmsPackagesStatisticsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.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

SmsPackagesStatistics