public class SmsClient extends AbstractClient
gson, HTTP_RSP_OK, SDK_VERSION
Constructor and Description |
---|
SmsClient(Credential credential,
String region) |
SmsClient(Credential credential,
String region,
ClientProfile profile) |
Modifier and Type | Method and Description |
---|---|
AddSmsSignResponse |
AddSmsSign(AddSmsSignRequest req)
1.
|
AddSmsTemplateResponse |
AddSmsTemplate(AddSmsTemplateRequest req)
1.
|
CallbackStatusStatisticsResponse |
CallbackStatusStatistics(CallbackStatusStatisticsRequest req)
统计用户回执的数据。
>- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
|
DeleteSmsSignResponse |
DeleteSmsSign(DeleteSmsSignRequest req)
⚠️注意:个人认证用户不支持使用 API 删除短信签名,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),请登录 [控制台](https://console.cloud.tencent.com/smsv2) 删除短信签名。
>- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
|
DeleteSmsTemplateResponse |
DeleteSmsTemplate(DeleteSmsTemplateRequest req)
⚠️注意:个人认证用户不支持使用 API 删除短信正文模板,请登录 [控制台](https://console.cloud.tencent.com/smsv2) 删除短信正文模板,如需了解请参阅 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)。
>- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
|
DescribePhoneNumberInfoResponse |
DescribePhoneNumberInfo(DescribePhoneNumberInfoRequest req)
提供电话号码的信息查询,包括国家(或地区)码、规范的 E.164 格式号码等。
>- 例如:查询号码 +86018845720123,可以得到国家码 86、规范的 E.164 号码 +8618845720123 等信息。
|
DescribeSmsSignListResponse |
DescribeSmsSignList(DescribeSmsSignListRequest req)
⚠️注意:个人认证用户不支持使用 API 查询短信签名,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),如果为个人认证请登录 [控制台](https://console.cloud.tencent.com/smsv2) 查询短信签名。
>- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
|
DescribeSmsTemplateListResponse |
DescribeSmsTemplateList(DescribeSmsTemplateListRequest req)
⚠️注意:个人认证用户不支持使用 API 查询短信正文模板,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)。
>- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
|
ModifySmsSignResponse |
ModifySmsSign(ModifySmsSignRequest req)
1.
|
ModifySmsTemplateResponse |
ModifySmsTemplate(ModifySmsTemplateRequest req)
1.
|
PullSmsReplyStatusResponse |
PullSmsReplyStatus(PullSmsReplyStatusRequest req)
拉取短信回复状态。
目前也支持 [配置回复回调](https://cloud.tencent.com/document/product/382/42907) 的方式来获取上行回复。
>- 注:此接口需要联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 开通。
>- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
|
PullSmsReplyStatusByPhoneNumberResponse |
PullSmsReplyStatusByPhoneNumber(PullSmsReplyStatusByPhoneNumberRequest req)
拉取单个号码短信回复状态。
目前也支持 [配置回复回调](https://cloud.tencent.com/document/product/382/42907) 的方式来获取上行回复。
>- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
|
PullSmsSendStatusResponse |
PullSmsSendStatus(PullSmsSendStatusRequest req)
拉取短信下发状态。
目前也支持 [配置回调](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) 的方式来获取下发状态。
>- 注:此接口需要联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 开通。
>- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
|
PullSmsSendStatusByPhoneNumberResponse |
PullSmsSendStatusByPhoneNumber(PullSmsSendStatusByPhoneNumberRequest req)
拉取单个号码短信下发状态。
目前也支持 [配置回调](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 来使用云短信服务。
>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
|
ReportConversionResponse |
ReportConversion(ReportConversionRequest req)
短信转化率上报。将已接收到短信的流水号上报到腾讯云短信服务。
>- 注:当前接口以白名单方式对外开放,如有需要请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 开通。
|
SendSmsResponse |
SendSms(SendSmsRequest req)
短信发送接口,用于给用户发短信验证码、通知类短信或营销短信。
>- 注:由于云 **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=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
>- 注:当前接口属于 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)
统计用户发送短信的数据。
>- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
|
SmsPackagesStatisticsResponse |
SmsPackagesStatistics(SmsPackagesStatisticsRequest req)
用户套餐包信息统计。
>- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
|
call, callOctetStream, getClientProfile, getCredential, getRegion, internalRequest, retry, setClientProfile, setCredential, setRegion
public SmsClient(Credential credential, String region)
public SmsClient(Credential credential, String region, ClientProfile profile)
public AddSmsSignResponse AddSmsSign(AddSmsSignRequest req) throws TencentCloudSDKException
req
- AddSmsSignRequestTencentCloudSDKException
public AddSmsTemplateResponse AddSmsTemplate(AddSmsTemplateRequest req) throws TencentCloudSDKException
req
- AddSmsTemplateRequestTencentCloudSDKException
public CallbackStatusStatisticsResponse CallbackStatusStatistics(CallbackStatusStatisticsRequest req) throws TencentCloudSDKException
req
- CallbackStatusStatisticsRequestTencentCloudSDKException
public DeleteSmsSignResponse DeleteSmsSign(DeleteSmsSignRequest req) throws TencentCloudSDKException
req
- DeleteSmsSignRequestTencentCloudSDKException
public DeleteSmsTemplateResponse DeleteSmsTemplate(DeleteSmsTemplateRequest req) throws TencentCloudSDKException
req
- DeleteSmsTemplateRequestTencentCloudSDKException
public DescribePhoneNumberInfoResponse DescribePhoneNumberInfo(DescribePhoneNumberInfoRequest req) throws TencentCloudSDKException
req
- DescribePhoneNumberInfoRequestTencentCloudSDKException
public DescribeSmsSignListResponse DescribeSmsSignList(DescribeSmsSignListRequest req) throws TencentCloudSDKException
req
- DescribeSmsSignListRequestTencentCloudSDKException
public DescribeSmsTemplateListResponse DescribeSmsTemplateList(DescribeSmsTemplateListRequest req) throws TencentCloudSDKException
req
- DescribeSmsTemplateListRequestTencentCloudSDKException
public ModifySmsSignResponse ModifySmsSign(ModifySmsSignRequest req) throws TencentCloudSDKException
req
- ModifySmsSignRequestTencentCloudSDKException
public ModifySmsTemplateResponse ModifySmsTemplate(ModifySmsTemplateRequest req) throws TencentCloudSDKException
req
- ModifySmsTemplateRequestTencentCloudSDKException
public PullSmsReplyStatusResponse PullSmsReplyStatus(PullSmsReplyStatusRequest req) throws TencentCloudSDKException
req
- PullSmsReplyStatusRequestTencentCloudSDKException
public PullSmsReplyStatusByPhoneNumberResponse PullSmsReplyStatusByPhoneNumber(PullSmsReplyStatusByPhoneNumberRequest req) throws TencentCloudSDKException
req
- PullSmsReplyStatusByPhoneNumberRequestTencentCloudSDKException
public PullSmsSendStatusResponse PullSmsSendStatus(PullSmsSendStatusRequest req) throws TencentCloudSDKException
req
- PullSmsSendStatusRequestTencentCloudSDKException
public PullSmsSendStatusByPhoneNumberResponse PullSmsSendStatusByPhoneNumber(PullSmsSendStatusByPhoneNumberRequest req) throws TencentCloudSDKException
req
- PullSmsSendStatusByPhoneNumberRequestTencentCloudSDKException
public ReportConversionResponse ReportConversion(ReportConversionRequest req) throws TencentCloudSDKException
req
- ReportConversionRequestTencentCloudSDKException
public SendSmsResponse SendSms(SendSmsRequest req) throws TencentCloudSDKException
req
- SendSmsRequestTencentCloudSDKException
public SendStatusStatisticsResponse SendStatusStatistics(SendStatusStatisticsRequest req) throws TencentCloudSDKException
req
- SendStatusStatisticsRequestTencentCloudSDKException
public SmsPackagesStatisticsResponse SmsPackagesStatistics(SmsPackagesStatisticsRequest req) throws TencentCloudSDKException
req
- SmsPackagesStatisticsRequestTencentCloudSDKException
Copyright © 2022. All rights reserved.