com.tencentcloudapi.sms.v20190711.models

Class SendSmsRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.sms.v20190711.models.SendSmsRequest

public class SendSmsRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
SendSmsRequest()
SendSmsRequest(SendSmsRequest source) 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.

Method Summary

Modifier and Type	Method and Description
String	getExtendCode() Get SMS code number extension, which is not activated by default.
String[]	getPhoneNumberSet() Get Target mobile number in the e.164 standard in the format of +[country/region code][mobile number].
String	getSenderId() Get `senderid` for Global SMS, which is not activated by default.
String	getSessionContext() Get User session content, which can carry context information such as user-side ID and will be returned as-is by the server.
String	getSign() Get The content of SMS signature should be encoded in UTF-8.
String	getSmsSdkAppid() Get SMS `SdkAppid` actually generated after an application is added in the [SMS Console](https://console.cloud.tencent.com/sms/smslist), such as 1400006666.
String	getTemplateID() Get Template ID.
String[]	getTemplateParamSet() Get Template parameter.
void	setExtendCode(String ExtendCode) Set SMS code number extension, which is not activated by default.
void	setPhoneNumberSet(String[] PhoneNumberSet) Set Target mobile number in the e.164 standard in the format of +[country/region code][mobile number].
void	setSenderId(String SenderId) Set `senderid` for Global SMS, which is not activated by default.
void	setSessionContext(String SessionContext) Set User session content, which can carry context information such as user-side ID and will be returned as-is by the server.
void	setSign(String Sign) Set The content of SMS signature should be encoded in UTF-8.
void	setSmsSdkAppid(String SmsSdkAppid) Set SMS `SdkAppid` actually generated after an application is added in the [SMS Console](https://console.cloud.tencent.com/sms/smslist), such as 1400006666.
void	setTemplateID(String TemplateID) Set Template ID.
void	setTemplateParamSet(String[] TemplateParamSet) Set Template parameter.
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SendSmsRequest

public SendSmsRequest()

SendSmsRequest

public SendSmsRequest(SendSmsRequest source)

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.

Method Detail

getPhoneNumberSet

public String[] getPhoneNumberSet()

Get Target mobile number in the e.164 standard in the format of +[country/region code][mobile number]. Up to 200 mobile numbers are supported in one request (which should be all Mainland China mobile numbers or all global mobile numbers). Example: +8613711112222, which has a + sign followed by 86 (country/region code) and then by 13711112222 (mobile number).

Returns:

PhoneNumberSet Target mobile number in the e.164 standard in the format of +[country/region code][mobile number]. Up to 200 mobile numbers are supported in one request (which should be all Mainland China mobile numbers or all global mobile numbers). Example: +8613711112222, which has a + sign followed by 86 (country/region code) and then by 13711112222 (mobile number).

setPhoneNumberSet

public void setPhoneNumberSet(String[] PhoneNumberSet)

Set Target mobile number in the e.164 standard in the format of +[country/region code][mobile number]. Up to 200 mobile numbers are supported in one request (which should be all Mainland China mobile numbers or all global mobile numbers). Example: +8613711112222, which has a + sign followed by 86 (country/region code) and then by 13711112222 (mobile number).

Parameters:

PhoneNumberSet - Target mobile number in the e.164 standard in the format of +[country/region code][mobile number]. Up to 200 mobile numbers are supported in one request (which should be all Mainland China mobile numbers or all global mobile numbers). Example: +8613711112222, which has a + sign followed by 86 (country/region code) and then by 13711112222 (mobile number).

getTemplateID

public String getTemplateID()

Get Template ID. You must enter the ID of an approved template, which can be viewed in the [SMS Console](https://console.cloud.tencent.com/sms/smslist).

Returns:

TemplateID Template ID. You must enter the ID of an approved template, which can be viewed in the [SMS Console](https://console.cloud.tencent.com/sms/smslist).

setTemplateID

public void setTemplateID(String TemplateID)

Set Template ID. You must enter the ID of an approved template, which can be viewed in the [SMS Console](https://console.cloud.tencent.com/sms/smslist).

Parameters:

TemplateID - Template ID. You must enter the ID of an approved template, which can be viewed in the [SMS Console](https://console.cloud.tencent.com/sms/smslist).

getSmsSdkAppid

public String getSmsSdkAppid()

Get SMS `SdkAppid` actually generated after an application is added in the [SMS Console](https://console.cloud.tencent.com/sms/smslist), such as 1400006666.

Returns:

SmsSdkAppid SMS `SdkAppid` actually generated after an application is added in the [SMS Console](https://console.cloud.tencent.com/sms/smslist), such as 1400006666.

setSmsSdkAppid

public void setSmsSdkAppid(String SmsSdkAppid)

Set SMS `SdkAppid` actually generated after an application is added in the [SMS Console](https://console.cloud.tencent.com/sms/smslist), such as 1400006666.

Parameters:

SmsSdkAppid - SMS `SdkAppid` actually generated after an application is added in the [SMS Console](https://console.cloud.tencent.com/sms/smslist), such as 1400006666.

getSign

public String getSign()

Get The content of SMS signature should be encoded in UTF-8. You must enter an approved signature, which can be viewed in the [SMS Console](https://console.cloud.tencent.com/sms/smslist). Note: this parameter is required for Mainland China SMS.

Returns:

Sign The content of SMS signature should be encoded in UTF-8. You must enter an approved signature, which can be viewed in the [SMS Console](https://console.cloud.tencent.com/sms/smslist). Note: this parameter is required for Mainland China SMS.

setSign

public void setSign(String Sign)

Set The content of SMS signature should be encoded in UTF-8. You must enter an approved signature, which can be viewed in the [SMS Console](https://console.cloud.tencent.com/sms/smslist). Note: this parameter is required for Mainland China SMS.

Parameters:

Sign - The content of SMS signature should be encoded in UTF-8. You must enter an approved signature, which can be viewed in the [SMS Console](https://console.cloud.tencent.com/sms/smslist). Note: this parameter is required for Mainland China SMS.

getTemplateParamSet

public String[] getTemplateParamSet()

Get Template parameter. If there is no template parameter, leave this parameter blank.

Returns:

TemplateParamSet Template parameter. If there is no template parameter, leave this parameter blank.

setTemplateParamSet

public void setTemplateParamSet(String[] TemplateParamSet)

Set Template parameter. If there is no template parameter, leave this parameter blank.

Parameters:

TemplateParamSet - Template parameter. If there is no template parameter, leave this parameter blank.

getExtendCode

public String getExtendCode()

Get SMS code number extension, which is not activated by default. If you need to activate it, please contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1).

Returns:

ExtendCode SMS code number extension, which is not activated by default. If you need to activate it, please contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1).

setExtendCode

public void setExtendCode(String ExtendCode)

Set SMS code number extension, which is not activated by default. If you need to activate it, please contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1).

Parameters:

ExtendCode - SMS code number extension, which is not activated by default. If you need to activate it, please contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1).

getSessionContext

public String getSessionContext()

Get User session content, which can carry context information such as user-side ID and will be returned as-is by the server.

Returns:

SessionContext User session content, which can carry context information such as user-side ID and will be returned as-is by the server.

setSessionContext

public void setSessionContext(String SessionContext)

Set User session content, which can carry context information such as user-side ID and will be returned as-is by the server.

Parameters:

SessionContext - User session content, which can carry context information such as user-side ID and will be returned as-is by the server.

getSenderId

public String getSenderId()

Get `senderid` for Global SMS, which is not activated by default. If you need to activate it, please contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1) for assistance. This parameter should be empty for Mainland China SMS.

Returns:

SenderId `senderid` for Global SMS, which is not activated by default. If you need to activate it, please contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1) for assistance. This parameter should be empty for Mainland China SMS.

setSenderId

public void setSenderId(String SenderId)

Set `senderid` for Global SMS, which is not activated by default. If you need to activate it, please contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1) for assistance. This parameter should be empty for Mainland China SMS.

Parameters:

SenderId - `senderid` for Global SMS, which is not activated by default. If you need to activate it, please contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1) for assistance. This parameter should be empty for Mainland China SMS.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel