com.tencentcloudapi.sms.v20210111.models

Class ModifySmsSignRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.sms.v20210111.models.ModifySmsSignRequest

public class ModifySmsSignRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
ModifySmsSignRequest()
ModifySmsSignRequest(ModifySmsSignRequest 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	getCommissionImage() Get Power of attorney, which should be submitted if `SignPurpose` is for use by others.
Long	getDocumentType() Get Identity certificate type: 0: three-in-one.
Long	getInternational() Get A parameter used to specify whether it is Global SMS: `0`: Chinese mainland SMS.
String	getProofImage() Get You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix `data:image/jpeg;base64,` from the resulted string, and then use it as the value of this parameter.
String	getRemark() Get Signature application remarks.
Long	getSignId() Get ID of the signature to be modified.
String	getSignName() Get Signature name.
Long	getSignPurpose() Get Signature purpose: 0: for personal use.
Long	getSignType() Get Signature type.
void	setCommissionImage(String CommissionImage) Set Power of attorney, which should be submitted if `SignPurpose` is for use by others.
void	setDocumentType(Long DocumentType) Set Identity certificate type: 0: three-in-one.
void	setInternational(Long International) Set A parameter used to specify whether it is Global SMS: `0`: Chinese mainland SMS.
void	setProofImage(String ProofImage) Set You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix `data:image/jpeg;base64,` from the resulted string, and then use it as the value of this parameter.
void	setRemark(String Remark) Set Signature application remarks.
void	setSignId(Long SignId) Set ID of the signature to be modified.
void	setSignName(String SignName) Set Signature name.
void	setSignPurpose(Long SignPurpose) Set Signature purpose: 0: for personal use.
void	setSignType(Long SignType) Set Signature type.
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

ModifySmsSignRequest

public ModifySmsSignRequest()

ModifySmsSignRequest

public ModifySmsSignRequest(ModifySmsSignRequest 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

getSignId

public Long getSignId()

Get ID of the signature to be modified.

Returns:

SignId ID of the signature to be modified.

setSignId

public void setSignId(Long SignId)

Set ID of the signature to be modified.

Parameters:

SignId - ID of the signature to be modified.

getSignName

public String getSignName()

Get Signature name.

Returns:

SignName Signature name.

setSignName

public void setSignName(String SignName)

Set Signature name.

Parameters:

SignName - Signature name.

getSignType

public Long getSignType()

Get Signature type. Each of these types is followed by their `DocumentType` (identity certificate type) option: 0: company. Valid values of `DocumentType` include 0 and 1. 1: app. Valid values of `DocumentType` include 0, 1, 2, 3, and 4. 2: website. Valid values of `DocumentType` include 0, 1, 2, 3, and 5. 3: WeChat Official Account. Valid values of `DocumentType` include 0, 1, 2, 3, and 8. 4: trademark. Valid values of `DocumentType` include 7. 5: government/public institution/other. Valid values of `DocumentType` include 2 and 3. 6: WeChat Mini Program. Valid values of `DocumentType` include 0, 1, 2, 3, and 6. Note: the identity certificate type must be selected according to the correspondence; otherwise, the review will fail.

Returns:

SignType Signature type. Each of these types is followed by their `DocumentType` (identity certificate type) option: 0: company. Valid values of `DocumentType` include 0 and 1. 1: app. Valid values of `DocumentType` include 0, 1, 2, 3, and 4. 2: website. Valid values of `DocumentType` include 0, 1, 2, 3, and 5. 3: WeChat Official Account. Valid values of `DocumentType` include 0, 1, 2, 3, and 8. 4: trademark. Valid values of `DocumentType` include 7. 5: government/public institution/other. Valid values of `DocumentType` include 2 and 3. 6: WeChat Mini Program. Valid values of `DocumentType` include 0, 1, 2, 3, and 6. Note: the identity certificate type must be selected according to the correspondence; otherwise, the review will fail.

setSignType

public void setSignType(Long SignType)

Set Signature type. Each of these types is followed by their `DocumentType` (identity certificate type) option: 0: company. Valid values of `DocumentType` include 0 and 1. 1: app. Valid values of `DocumentType` include 0, 1, 2, 3, and 4. 2: website. Valid values of `DocumentType` include 0, 1, 2, 3, and 5. 3: WeChat Official Account. Valid values of `DocumentType` include 0, 1, 2, 3, and 8. 4: trademark. Valid values of `DocumentType` include 7. 5: government/public institution/other. Valid values of `DocumentType` include 2 and 3. 6: WeChat Mini Program. Valid values of `DocumentType` include 0, 1, 2, 3, and 6. Note: the identity certificate type must be selected according to the correspondence; otherwise, the review will fail.

Parameters:

SignType - Signature type. Each of these types is followed by their `DocumentType` (identity certificate type) option: 0: company. Valid values of `DocumentType` include 0 and 1. 1: app. Valid values of `DocumentType` include 0, 1, 2, 3, and 4. 2: website. Valid values of `DocumentType` include 0, 1, 2, 3, and 5. 3: WeChat Official Account. Valid values of `DocumentType` include 0, 1, 2, 3, and 8. 4: trademark. Valid values of `DocumentType` include 7. 5: government/public institution/other. Valid values of `DocumentType` include 2 and 3. 6: WeChat Mini Program. Valid values of `DocumentType` include 0, 1, 2, 3, and 6. Note: the identity certificate type must be selected according to the correspondence; otherwise, the review will fail.

getDocumentType

public Long getDocumentType()

Get Identity certificate type: 0: three-in-one. 1: business license. 2: organization code certificate. 3: social credit code certificate. 4: screenshot of application backend management (for personal app). 5: screenshot of website ICP filing backend (for personal website). 6: screenshot of WeChat Mini Program settings page (for personal WeChat Mini Program). 7: trademark registration certificate. 8: screenshot of WeChat Official Account settings page (for personal WeChat Official Account).

Returns:

DocumentType Identity certificate type: 0: three-in-one. 1: business license. 2: organization code certificate. 3: social credit code certificate. 4: screenshot of application backend management (for personal app). 5: screenshot of website ICP filing backend (for personal website). 6: screenshot of WeChat Mini Program settings page (for personal WeChat Mini Program). 7: trademark registration certificate. 8: screenshot of WeChat Official Account settings page (for personal WeChat Official Account).

setDocumentType

public void setDocumentType(Long DocumentType)

Set Identity certificate type: 0: three-in-one. 1: business license. 2: organization code certificate. 3: social credit code certificate. 4: screenshot of application backend management (for personal app). 5: screenshot of website ICP filing backend (for personal website). 6: screenshot of WeChat Mini Program settings page (for personal WeChat Mini Program). 7: trademark registration certificate. 8: screenshot of WeChat Official Account settings page (for personal WeChat Official Account).

Parameters:

DocumentType - Identity certificate type: 0: three-in-one. 1: business license. 2: organization code certificate. 3: social credit code certificate. 4: screenshot of application backend management (for personal app). 5: screenshot of website ICP filing backend (for personal website). 6: screenshot of WeChat Mini Program settings page (for personal WeChat Mini Program). 7: trademark registration certificate. 8: screenshot of WeChat Official Account settings page (for personal WeChat Official Account).

getInternational

public Long getInternational()

Get A parameter used to specify whether it is Global SMS: `0`: Chinese mainland SMS. `1`: Global SMS. Note: the value of this parameter must be consistent with the `International` value of the signature to be modified. This parameter cannot be used to directly change a Chinese mainland signature to an international signature.

Returns:

International A parameter used to specify whether it is Global SMS: `0`: Chinese mainland SMS. `1`: Global SMS. Note: the value of this parameter must be consistent with the `International` value of the signature to be modified. This parameter cannot be used to directly change a Chinese mainland signature to an international signature.

setInternational

public void setInternational(Long International)

Set A parameter used to specify whether it is Global SMS: `0`: Chinese mainland SMS. `1`: Global SMS. Note: the value of this parameter must be consistent with the `International` value of the signature to be modified. This parameter cannot be used to directly change a Chinese mainland signature to an international signature.

Parameters:

International - A parameter used to specify whether it is Global SMS: `0`: Chinese mainland SMS. `1`: Global SMS. Note: the value of this parameter must be consistent with the `International` value of the signature to be modified. This parameter cannot be used to directly change a Chinese mainland signature to an international signature.

getSignPurpose

public Long getSignPurpose()

Get Signature purpose: 0: for personal use. 1: for others.

Returns:

SignPurpose Signature purpose: 0: for personal use. 1: for others.

setSignPurpose

public void setSignPurpose(Long SignPurpose)

Set Signature purpose: 0: for personal use. 1: for others.

Parameters:

SignPurpose - Signature purpose: 0: for personal use. 1: for others.

getProofImage

public String getProofImage()

Get You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix `data:image/jpeg;base64,` from the resulted string, and then use it as the value of this parameter.

Returns:

ProofImage You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix `data:image/jpeg;base64,` from the resulted string, and then use it as the value of this parameter.

setProofImage

public void setProofImage(String ProofImage)

Set You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix `data:image/jpeg;base64,` from the resulted string, and then use it as the value of this parameter.

Parameters:

ProofImage - You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix `data:image/jpeg;base64,` from the resulted string, and then use it as the value of this parameter.

getCommissionImage

public String getCommissionImage()

Get Power of attorney, which should be submitted if `SignPurpose` is for use by others. You should Base64-encode the image first, remove the prefix `data:image/jpeg;base64,` from the resulted string, and then use it as the value of this parameter. Note: this field will take effect only when `SignPurpose` is 1 (for user by others).

Returns:

CommissionImage Power of attorney, which should be submitted if `SignPurpose` is for use by others. You should Base64-encode the image first, remove the prefix `data:image/jpeg;base64,` from the resulted string, and then use it as the value of this parameter. Note: this field will take effect only when `SignPurpose` is 1 (for user by others).

setCommissionImage

public void setCommissionImage(String CommissionImage)

Set Power of attorney, which should be submitted if `SignPurpose` is for use by others. You should Base64-encode the image first, remove the prefix `data:image/jpeg;base64,` from the resulted string, and then use it as the value of this parameter. Note: this field will take effect only when `SignPurpose` is 1 (for user by others).

Parameters:

CommissionImage - Power of attorney, which should be submitted if `SignPurpose` is for use by others. You should Base64-encode the image first, remove the prefix `data:image/jpeg;base64,` from the resulted string, and then use it as the value of this parameter. Note: this field will take effect only when `SignPurpose` is 1 (for user by others).

getRemark

public String getRemark()

Get Signature application remarks.

Returns:

Remark Signature application remarks.

setRemark

public void setRemark(String Remark)

Set Signature application remarks.

Parameters:

Remark - Signature application remarks.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel