com.tencentcloudapi.sms.v20210111.models

Class SendSmsRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.sms.v20210111.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 This parameter is not required for Mainland China SMS.
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	getSignName() Get Content of the SMS signature, which should be encoded in UTF-8.
String	getSmsSdkAppId() Get The SMS `SdkAppId` generated after an application is added in the [SMS console](https://console.cloud.tencent.com/smsv2/app-manage), 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 This parameter is not required for Mainland China SMS.
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	setSignName(String SignName) Set Content of the SMS signature, which should be encoded in UTF-8.
void	setSmsSdkAppId(String SmsSdkAppId) Set The SMS `SdkAppId` generated after an application is added in the [SMS console](https://console.cloud.tencent.com/smsv2/app-manage), 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).

getSmsSdkAppId

public String getSmsSdkAppId()

Get The SMS `SdkAppId` generated after an application is added in the [SMS console](https://console.cloud.tencent.com/smsv2/app-manage), such as 1400006666.

Returns:

SmsSdkAppId The SMS `SdkAppId` generated after an application is added in the [SMS console](https://console.cloud.tencent.com/smsv2/app-manage), such as 1400006666.

setSmsSdkAppId

public void setSmsSdkAppId(String SmsSdkAppId)

Set The SMS `SdkAppId` generated after an application is added in the [SMS console](https://console.cloud.tencent.com/smsv2/app-manage), such as 1400006666.

Parameters:

SmsSdkAppId - The SMS `SdkAppId` generated after an application is added in the [SMS console](https://console.cloud.tencent.com/smsv2/app-manage), such as 1400006666.

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/smsv2). If you need to send SMS messages to global mobile numbers, you can only use a Global SMS template.

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/smsv2). If you need to send SMS messages to global mobile numbers, you can only use a Global SMS template.

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/smsv2). If you need to send SMS messages to global mobile numbers, you can only use a Global SMS template.

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/smsv2). If you need to send SMS messages to global mobile numbers, you can only use a Global SMS template.

getSignName

public String getSignName()

Get Content of the SMS signature, which should be encoded in UTF-8. You must enter an approved signature, such as Tencent Cloud. The signature information can be viewed in the [SMS console](https://console.cloud.tencent.com/smsv2). Note: this parameter is required for Mainland China SMS.

Returns:

SignName Content of the SMS signature, which should be encoded in UTF-8. You must enter an approved signature, such as Tencent Cloud. The signature information can be viewed in the [SMS console](https://console.cloud.tencent.com/smsv2). Note: this parameter is required for Mainland China SMS.

setSignName

public void setSignName(String SignName)

Set Content of the SMS signature, which should be encoded in UTF-8. You must enter an approved signature, such as Tencent Cloud. The signature information can be viewed in the [SMS console](https://console.cloud.tencent.com/smsv2). Note: this parameter is required for Mainland China SMS.

Parameters:

SignName - Content of the SMS signature, which should be encoded in UTF-8. You must enter an approved signature, such as Tencent Cloud. The signature information can be viewed in the [SMS console](https://console.cloud.tencent.com/smsv2). 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#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81).

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#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81).

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#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81).

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#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81).

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 This parameter is not required for Mainland China SMS. For Global SMS, if you have applied for a separate `SenderId`, this parameter is required. By default, the public `SenderId` is used, in which case you don't need to enter this parameter. Note: if your monthly usage reaches the specified threshold, you can apply for an independent `SenderId`. For more information, please contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81).

Returns:

SenderId This parameter is not required for Mainland China SMS. For Global SMS, if you have applied for a separate `SenderId`, this parameter is required. By default, the public `SenderId` is used, in which case you don't need to enter this parameter. Note: if your monthly usage reaches the specified threshold, you can apply for an independent `SenderId`. For more information, please contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81).

setSenderId

public void setSenderId(String SenderId)

Set This parameter is not required for Mainland China SMS. For Global SMS, if you have applied for a separate `SenderId`, this parameter is required. By default, the public `SenderId` is used, in which case you don't need to enter this parameter. Note: if your monthly usage reaches the specified threshold, you can apply for an independent `SenderId`. For more information, please contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81).

Parameters:

SenderId - This parameter is not required for Mainland China SMS. For Global SMS, if you have applied for a separate `SenderId`, this parameter is required. By default, the public `SenderId` is used, in which case you don't need to enter this parameter. Note: if your monthly usage reaches the specified threshold, you can apply for an independent `SenderId`. For more information, please contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81).

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel