
com.tencentcloudapi.sms.v20190711.models.SendSmsRequest 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.v20190711.models;
import com.tencentcloudapi.common.AbstractModel;
import com.tencentcloudapi.common.SSEResponseModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;
public class SendSmsRequest extends AbstractModel {
/**
* 下发手机号码,采用 E.164 标准,格式为+[国家或地区码][手机号],单次请求最多支持200个手机号且要求全为境内手机号或全为境外手机号。
例如:+8618501234444, 其中前面有一个+号 ,86为国家码,18501234444为手机号。
*/
@SerializedName("PhoneNumberSet")
@Expose
private String [] PhoneNumberSet;
/**
* 模板 ID,必须填写已审核通过的模板 ID。模板ID可登录 [短信控制台](https://console.cloud.tencent.com/smsv2) 查看,若向境外手机号发送短信,仅支持使用国际/港澳台短信模板。
*/
@SerializedName("TemplateID")
@Expose
private String TemplateID;
/**
* 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,示例如1400006666。
*/
@SerializedName("SmsSdkAppid")
@Expose
private String SmsSdkAppid;
/**
* 短信签名内容,使用 UTF-8 编码,必须填写已审核通过的签名,签名信息可登录 [短信控制台](https://console.cloud.tencent.com/smsv2) 查看。注:国内短信为必填参数。
*/
@SerializedName("Sign")
@Expose
private String Sign;
/**
* 模板参数,若无模板参数,则设置为空。
*/
@SerializedName("TemplateParamSet")
@Expose
private String [] TemplateParamSet;
/**
* 短信码号扩展号,默认未开通,如需开通请联系 [sms helper](https://cloud.tencent.com/document/product/382/3773)。
*/
@SerializedName("ExtendCode")
@Expose
private String ExtendCode;
/**
* 用户的 session 内容,可以携带用户侧 ID 等上下文信息,server 会原样返回。注意长度需小于512字节。
*/
@SerializedName("SessionContext")
@Expose
private String SessionContext;
/**
* 国内短信无senderid,无需填写该项;若需开通国际/港澳台短信senderid,请联系smshelper。
*/
@SerializedName("SenderId")
@Expose
private String SenderId;
/**
* Get 下发手机号码,采用 E.164 标准,格式为+[国家或地区码][手机号],单次请求最多支持200个手机号且要求全为境内手机号或全为境外手机号。
例如:+8618501234444, 其中前面有一个+号 ,86为国家码,18501234444为手机号。
* @return PhoneNumberSet 下发手机号码,采用 E.164 标准,格式为+[国家或地区码][手机号],单次请求最多支持200个手机号且要求全为境内手机号或全为境外手机号。
例如:+8618501234444, 其中前面有一个+号 ,86为国家码,18501234444为手机号。
*/
public String [] getPhoneNumberSet() {
return this.PhoneNumberSet;
}
/**
* Set 下发手机号码,采用 E.164 标准,格式为+[国家或地区码][手机号],单次请求最多支持200个手机号且要求全为境内手机号或全为境外手机号。
例如:+8618501234444, 其中前面有一个+号 ,86为国家码,18501234444为手机号。
* @param PhoneNumberSet 下发手机号码,采用 E.164 标准,格式为+[国家或地区码][手机号],单次请求最多支持200个手机号且要求全为境内手机号或全为境外手机号。
例如:+8618501234444, 其中前面有一个+号 ,86为国家码,18501234444为手机号。
*/
public void setPhoneNumberSet(String [] PhoneNumberSet) {
this.PhoneNumberSet = PhoneNumberSet;
}
/**
* Get 模板 ID,必须填写已审核通过的模板 ID。模板ID可登录 [短信控制台](https://console.cloud.tencent.com/smsv2) 查看,若向境外手机号发送短信,仅支持使用国际/港澳台短信模板。
* @return TemplateID 模板 ID,必须填写已审核通过的模板 ID。模板ID可登录 [短信控制台](https://console.cloud.tencent.com/smsv2) 查看,若向境外手机号发送短信,仅支持使用国际/港澳台短信模板。
*/
public String getTemplateID() {
return this.TemplateID;
}
/**
* Set 模板 ID,必须填写已审核通过的模板 ID。模板ID可登录 [短信控制台](https://console.cloud.tencent.com/smsv2) 查看,若向境外手机号发送短信,仅支持使用国际/港澳台短信模板。
* @param TemplateID 模板 ID,必须填写已审核通过的模板 ID。模板ID可登录 [短信控制台](https://console.cloud.tencent.com/smsv2) 查看,若向境外手机号发送短信,仅支持使用国际/港澳台短信模板。
*/
public void setTemplateID(String TemplateID) {
this.TemplateID = TemplateID;
}
/**
* Get 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,示例如1400006666。
* @return SmsSdkAppid 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,示例如1400006666。
*/
public String getSmsSdkAppid() {
return this.SmsSdkAppid;
}
/**
* Set 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,示例如1400006666。
* @param SmsSdkAppid 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,示例如1400006666。
*/
public void setSmsSdkAppid(String SmsSdkAppid) {
this.SmsSdkAppid = SmsSdkAppid;
}
/**
* Get 短信签名内容,使用 UTF-8 编码,必须填写已审核通过的签名,签名信息可登录 [短信控制台](https://console.cloud.tencent.com/smsv2) 查看。注:国内短信为必填参数。
* @return Sign 短信签名内容,使用 UTF-8 编码,必须填写已审核通过的签名,签名信息可登录 [短信控制台](https://console.cloud.tencent.com/smsv2) 查看。注:国内短信为必填参数。
*/
public String getSign() {
return this.Sign;
}
/**
* Set 短信签名内容,使用 UTF-8 编码,必须填写已审核通过的签名,签名信息可登录 [短信控制台](https://console.cloud.tencent.com/smsv2) 查看。注:国内短信为必填参数。
* @param Sign 短信签名内容,使用 UTF-8 编码,必须填写已审核通过的签名,签名信息可登录 [短信控制台](https://console.cloud.tencent.com/smsv2) 查看。注:国内短信为必填参数。
*/
public void setSign(String Sign) {
this.Sign = Sign;
}
/**
* Get 模板参数,若无模板参数,则设置为空。
* @return TemplateParamSet 模板参数,若无模板参数,则设置为空。
*/
public String [] getTemplateParamSet() {
return this.TemplateParamSet;
}
/**
* Set 模板参数,若无模板参数,则设置为空。
* @param TemplateParamSet 模板参数,若无模板参数,则设置为空。
*/
public void setTemplateParamSet(String [] TemplateParamSet) {
this.TemplateParamSet = TemplateParamSet;
}
/**
* Get 短信码号扩展号,默认未开通,如需开通请联系 [sms helper](https://cloud.tencent.com/document/product/382/3773)。
* @return ExtendCode 短信码号扩展号,默认未开通,如需开通请联系 [sms helper](https://cloud.tencent.com/document/product/382/3773)。
*/
public String getExtendCode() {
return this.ExtendCode;
}
/**
* Set 短信码号扩展号,默认未开通,如需开通请联系 [sms helper](https://cloud.tencent.com/document/product/382/3773)。
* @param ExtendCode 短信码号扩展号,默认未开通,如需开通请联系 [sms helper](https://cloud.tencent.com/document/product/382/3773)。
*/
public void setExtendCode(String ExtendCode) {
this.ExtendCode = ExtendCode;
}
/**
* Get 用户的 session 内容,可以携带用户侧 ID 等上下文信息,server 会原样返回。注意长度需小于512字节。
* @return SessionContext 用户的 session 内容,可以携带用户侧 ID 等上下文信息,server 会原样返回。注意长度需小于512字节。
*/
public String getSessionContext() {
return this.SessionContext;
}
/**
* Set 用户的 session 内容,可以携带用户侧 ID 等上下文信息,server 会原样返回。注意长度需小于512字节。
* @param SessionContext 用户的 session 内容,可以携带用户侧 ID 等上下文信息,server 会原样返回。注意长度需小于512字节。
*/
public void setSessionContext(String SessionContext) {
this.SessionContext = SessionContext;
}
/**
* Get 国内短信无senderid,无需填写该项;若需开通国际/港澳台短信senderid,请联系smshelper。
* @return SenderId 国内短信无senderid,无需填写该项;若需开通国际/港澳台短信senderid,请联系smshelper。
*/
public String getSenderId() {
return this.SenderId;
}
/**
* Set 国内短信无senderid,无需填写该项;若需开通国际/港澳台短信senderid,请联系smshelper。
* @param SenderId 国内短信无senderid,无需填写该项;若需开通国际/港澳台短信senderid,请联系smshelper。
*/
public void setSenderId(String SenderId) {
this.SenderId = SenderId;
}
public SendSmsRequest() {
}
/**
* NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
* and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
*/
public SendSmsRequest(SendSmsRequest source) {
if (source.PhoneNumberSet != null) {
this.PhoneNumberSet = new String[source.PhoneNumberSet.length];
for (int i = 0; i < source.PhoneNumberSet.length; i++) {
this.PhoneNumberSet[i] = new String(source.PhoneNumberSet[i]);
}
}
if (source.TemplateID != null) {
this.TemplateID = new String(source.TemplateID);
}
if (source.SmsSdkAppid != null) {
this.SmsSdkAppid = new String(source.SmsSdkAppid);
}
if (source.Sign != null) {
this.Sign = new String(source.Sign);
}
if (source.TemplateParamSet != null) {
this.TemplateParamSet = new String[source.TemplateParamSet.length];
for (int i = 0; i < source.TemplateParamSet.length; i++) {
this.TemplateParamSet[i] = new String(source.TemplateParamSet[i]);
}
}
if (source.ExtendCode != null) {
this.ExtendCode = new String(source.ExtendCode);
}
if (source.SessionContext != null) {
this.SessionContext = new String(source.SessionContext);
}
if (source.SenderId != null) {
this.SenderId = new String(source.SenderId);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamArraySimple(map, prefix + "PhoneNumberSet.", this.PhoneNumberSet);
this.setParamSimple(map, prefix + "TemplateID", this.TemplateID);
this.setParamSimple(map, prefix + "SmsSdkAppid", this.SmsSdkAppid);
this.setParamSimple(map, prefix + "Sign", this.Sign);
this.setParamArraySimple(map, prefix + "TemplateParamSet.", this.TemplateParamSet);
this.setParamSimple(map, prefix + "ExtendCode", this.ExtendCode);
this.setParamSimple(map, prefix + "SessionContext", this.SessionContext);
this.setParamSimple(map, prefix + "SenderId", this.SenderId);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy