com.tencentcloudapi.sms.v20210111.SmsClient Maven / Gradle / Ivy
/*
* Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.tencentcloudapi.sms.v20210111;
import java.lang.reflect.Type;
import com.google.gson.JsonSyntaxException;
import com.google.gson.reflect.TypeToken;
import com.tencentcloudapi.common.exception.TencentCloudSDKException;
import com.tencentcloudapi.common.AbstractClient;
import com.tencentcloudapi.common.profile.ClientProfile;
import com.tencentcloudapi.common.JsonResponseModel;
import com.tencentcloudapi.common.Credential;
import com.tencentcloudapi.sms.v20210111.models.*;
public class SmsClient extends AbstractClient{
private static String endpoint = "sms.tencentcloudapi.com";
private static String service = "sms";
private static String version = "2021-01-11";
public SmsClient(Credential credential, String region) {
this(credential, region, new ClientProfile());
}
public SmsClient(Credential credential, String region, ClientProfile profile) {
super(SmsClient.endpoint, SmsClient.version, credential, region, profile);
}
/**
*本接口 (AddSmsSign) 用于添加短信签名。
说明：- 添加短信签名前，请先认真参阅 腾讯云短信签名审核标准。
- 个人认证用户不支持使用 API 申请短信签名，请参阅了解 实名认证基本介绍，如果为个人认证请登录 控制台 申请短信签名。
* @param req AddSmsSignRequest
* @return AddSmsSignResponse
* @throws TencentCloudSDKException
*/
public AddSmsSignResponse AddSmsSign(AddSmsSignRequest req) throws TencentCloudSDKException{
req.setSkipSign(false);
return this.internalRequest(req, "AddSmsSign", AddSmsSignResponse.class);
}
/**
*本接口 (AddSmsTemplate) 用于创建短信模板。
说明：- 申请短信模板前，请先认真参阅 腾讯云短信正文模板审核标准。
- 个人认证用户不支持使用 API 申请短信正文模板，请参阅了解 实名认证基本介绍，如果为个人认证请登录 控制台 申请短信正文模板。
* @param req AddSmsTemplateRequest
* @return AddSmsTemplateResponse
* @throws TencentCloudSDKException
*/
public AddSmsTemplateResponse AddSmsTemplate(AddSmsTemplateRequest req) throws TencentCloudSDKException{
req.setSkipSign(false);
return this.internalRequest(req, "AddSmsTemplate", AddSmsTemplateResponse.class);
}
/**
*本接口 (CallbackStatusStatistics) 用于统计用户回执的数据。
* @param req CallbackStatusStatisticsRequest
* @return CallbackStatusStatisticsResponse
* @throws TencentCloudSDKException
*/
public CallbackStatusStatisticsResponse CallbackStatusStatistics(CallbackStatusStatisticsRequest req) throws TencentCloudSDKException{
req.setSkipSign(false);
return this.internalRequest(req, "CallbackStatusStatistics", CallbackStatusStatisticsResponse.class);
}
/**
*本接口 (DeleteSmsSign) 用于删除短信签名。
说明：
* @param req DeleteSmsSignRequest
* @return DeleteSmsSignResponse
* @throws TencentCloudSDKException
*/
public DeleteSmsSignResponse DeleteSmsSign(DeleteSmsSignRequest req) throws TencentCloudSDKException{
req.setSkipSign(false);
return this.internalRequest(req, "DeleteSmsSign", DeleteSmsSignResponse.class);
}
/**
*本接口 (DeleteSmsTemplate) 用于删除短信模板。
说明：
* @param req DeleteSmsTemplateRequest
* @return DeleteSmsTemplateResponse
* @throws TencentCloudSDKException
*/
public DeleteSmsTemplateResponse DeleteSmsTemplate(DeleteSmsTemplateRequest req) throws TencentCloudSDKException{
req.setSkipSign(false);
return this.internalRequest(req, "DeleteSmsTemplate", DeleteSmsTemplateResponse.class);
}
/**
*本接口 (DescribePhoneNumberInfo) 用于提供电话号码的信息查询，包括国家（或地区）码、规范的 E.164 格式号码等。
- 例如：查询号码 +86018501234444，可以得到国家码 86、规范的 E.164 号码 +8618501234444 等信息。
* @param req DescribePhoneNumberInfoRequest
* @return DescribePhoneNumberInfoResponse
* @throws TencentCloudSDKException
*/
public DescribePhoneNumberInfoResponse DescribePhoneNumberInfo(DescribePhoneNumberInfoRequest req) throws TencentCloudSDKException{
req.setSkipSign(false);
return this.internalRequest(req, "DescribePhoneNumberInfo", DescribePhoneNumberInfoResponse.class);
}
/**
*本接口 (DescribeSmsSignList) 用于查询短信签名状态。
说明：
* @param req DescribeSmsSignListRequest
* @return DescribeSmsSignListResponse
* @throws TencentCloudSDKException
*/
public DescribeSmsSignListResponse DescribeSmsSignList(DescribeSmsSignListRequest req) throws TencentCloudSDKException{
req.setSkipSign(false);
return this.internalRequest(req, "DescribeSmsSignList", DescribeSmsSignListResponse.class);
}
/**
*本接口 (DescribeSmsTemplateList) 用于查询短信模板状态。
说明：
* @param req DescribeSmsTemplateListRequest
* @return DescribeSmsTemplateListResponse
* @throws TencentCloudSDKException
*/
public DescribeSmsTemplateListResponse DescribeSmsTemplateList(DescribeSmsTemplateListRequest req) throws TencentCloudSDKException{
req.setSkipSign(false);
return this.internalRequest(req, "DescribeSmsTemplateList", DescribeSmsTemplateListResponse.class);
}
/**
*本接口 (ModifySmsSign) 用于修改短信签名。
说明：- 修改短信签名前，请先认真参阅 腾讯云短信签名审核标准。
- 个人认证用户不支持使用 API 修改短信签名，请参阅了解 实名认证基本介绍，如果为个人认证请登录 控制台 修改短信签名。
- 修改短信签名，仅当签名为待审核或已拒绝状态时，才能进行修改，已审核通过的签名不支持修改。
* @param req ModifySmsSignRequest
* @return ModifySmsSignResponse
* @throws TencentCloudSDKException
*/
public ModifySmsSignResponse ModifySmsSign(ModifySmsSignRequest req) throws TencentCloudSDKException{
req.setSkipSign(false);
return this.internalRequest(req, "ModifySmsSign", ModifySmsSignResponse.class);
}
/**
*本接口 (ModifySmsTemplate) 用于修改短信模板。
说明：- 修改短信正文模板前，请先认真参阅 腾讯云短信正文模板审核标准。
- 个人认证用户不支持使用 API 修改短信正文模板，请参阅了解 实名认证基本介绍，如果为个人认证请登录 控制台 修改短信正文模板。
- 修改短信模板，仅当正文模板为待审核或已拒绝状态时，才能进行修改，已审核通过的正文模板不支持修改。
* @param req ModifySmsTemplateRequest
* @return ModifySmsTemplateResponse
* @throws TencentCloudSDKException
*/
public ModifySmsTemplateResponse ModifySmsTemplate(ModifySmsTemplateRequest req) throws TencentCloudSDKException{
req.setSkipSign(false);
return this.internalRequest(req, "ModifySmsTemplate", ModifySmsTemplateResponse.class);
}
/**
*本接口 (PullSmsReplyStatus) 用于拉取短信回复状态。
说明：
* @param req PullSmsReplyStatusRequest
* @return PullSmsReplyStatusResponse
* @throws TencentCloudSDKException
*/
public PullSmsReplyStatusResponse PullSmsReplyStatus(PullSmsReplyStatusRequest req) throws TencentCloudSDKException{
req.setSkipSign(false);
return this.internalRequest(req, "PullSmsReplyStatus", PullSmsReplyStatusResponse.class);
}
/**
*本接口 (PullSmsReplyStatusByPhoneNumber) 用于拉取单个号码短信回复状态。
说明：- 上行回复也支持 配置回复回调 的方式获取。
* @param req PullSmsReplyStatusByPhoneNumberRequest
* @return PullSmsReplyStatusByPhoneNumberResponse
* @throws TencentCloudSDKException
*/
public PullSmsReplyStatusByPhoneNumberResponse PullSmsReplyStatusByPhoneNumber(PullSmsReplyStatusByPhoneNumberRequest req) throws TencentCloudSDKException{
req.setSkipSign(false);
return this.internalRequest(req, "PullSmsReplyStatusByPhoneNumber", PullSmsReplyStatusByPhoneNumberResponse.class);
}
/**
*本接口 (PullSmsSendStatus) 用于拉取短信下发状态。
说明：
* @param req PullSmsSendStatusRequest
* @return PullSmsSendStatusResponse
* @throws TencentCloudSDKException
*/
public PullSmsSendStatusResponse PullSmsSendStatus(PullSmsSendStatusRequest req) throws TencentCloudSDKException{
req.setSkipSign(false);
return this.internalRequest(req, "PullSmsSendStatus", PullSmsSendStatusResponse.class);
}
/**
*本接口 (PullSmsSendStatusByPhoneNumber) 用于拉取单个号码短信下发状态。
说明：- 下发状态也支持 配置回调 的方式获取。
* @param req PullSmsSendStatusByPhoneNumberRequest
* @return PullSmsSendStatusByPhoneNumberResponse
* @throws TencentCloudSDKException
*/
public PullSmsSendStatusByPhoneNumberResponse PullSmsSendStatusByPhoneNumber(PullSmsSendStatusByPhoneNumberRequest req) throws TencentCloudSDKException{
req.setSkipSign(false);
return this.internalRequest(req, "PullSmsSendStatusByPhoneNumber", PullSmsSendStatusByPhoneNumberResponse.class);
}
/**
*本接口 (ReportConversion) 用于短信转化率上报。将已接收到短信的流水号上报到腾讯云短信服务。
说明：- 该接口当前以白名单方式对外开放，如有需要请联系 腾讯云短信小助手 开通。
* @param req ReportConversionRequest
* @return ReportConversionResponse
* @throws TencentCloudSDKException
*/
public ReportConversionResponse ReportConversion(ReportConversionRequest req) throws TencentCloudSDKException{
req.setSkipSign(false);
return this.internalRequest(req, "ReportConversion", ReportConversionResponse.class);
}
/**
*本接口 (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)。
* @param req SendSmsRequest
* @return SendSmsResponse
* @throws TencentCloudSDKException
*/
public SendSmsResponse SendSms(SendSmsRequest req) throws TencentCloudSDKException{
req.setSkipSign(false);
return this.internalRequest(req, "SendSms", SendSmsResponse.class);
}
/**
*本接口 (SendStatusStatistics) 用于统计用户发送短信的数据。
* @param req SendStatusStatisticsRequest
* @return SendStatusStatisticsResponse
* @throws TencentCloudSDKException
*/
public SendStatusStatisticsResponse SendStatusStatistics(SendStatusStatisticsRequest req) throws TencentCloudSDKException{
req.setSkipSign(false);
return this.internalRequest(req, "SendStatusStatistics", SendStatusStatisticsResponse.class);
}
/**
*本接口 (SmsPackagesStatistics) 用于统计用户套餐包数据。
* @param req SmsPackagesStatisticsRequest
* @return SmsPackagesStatisticsResponse
* @throws TencentCloudSDKException
*/
public SmsPackagesStatisticsResponse SmsPackagesStatistics(SmsPackagesStatisticsRequest req) throws TencentCloudSDKException{
req.setSkipSign(false);
return this.internalRequest(req, "SmsPackagesStatistics", SmsPackagesStatisticsResponse.class);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy