com.tencentcloudapi.captcha.v20190722.models

Class DescribeCaptchaResultResponse

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.captcha.v20190722.models.DescribeCaptchaResultResponse

public class DescribeCaptchaResultResponse
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribeCaptchaResultResponse()
DescribeCaptchaResultResponse(DescribeCaptchaResultResponse 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
Long	getCaptchaCode() Get `1 OK`: Verification passed `7 captcha no match`: The passed in `Randstr` is invalid.
String	getCaptchaMsg() Get Status description and verification error message Note: This field may return `null`, indicating that no valid value was found.
Long	getEvilBitmap() Get Blocking type Note: This field may return null, indicating that no valid values can be obtained.
Long	getEvilLevel() Get This parameter returns the result of imperceptible verification.
Long	getGetCaptchaTime() Get The timestamp when the frontend obtains the CAPTCHA.
String	getRequestId() Get The unique request ID, which is returned for each request.
Long	getSubmitCaptchaTime() Get The time when the CAPTCHA is submitted.
void	setCaptchaCode(Long CaptchaCode) Set `1 OK`: Verification passed `7 captcha no match`: The passed in `Randstr` is invalid.
void	setCaptchaMsg(String CaptchaMsg) Set Status description and verification error message Note: This field may return `null`, indicating that no valid value was found.
void	setEvilBitmap(Long EvilBitmap) Set Blocking type Note: This field may return null, indicating that no valid values can be obtained.
void	setEvilLevel(Long EvilLevel) Set This parameter returns the result of imperceptible verification.
void	setGetCaptchaTime(Long GetCaptchaTime) Set The timestamp when the frontend obtains the CAPTCHA.
void	setRequestId(String RequestId) Set The unique request ID, which is returned for each request.
void	setSubmitCaptchaTime(Long SubmitCaptchaTime) Set The time when the CAPTCHA is submitted.
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, GetHeader, getMultipartRequestParams, getSkipSign, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeCaptchaResultResponse

public DescribeCaptchaResultResponse()

DescribeCaptchaResultResponse

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

getCaptchaCode

public Long getCaptchaCode()

Get `1 OK`: Verification passed `7 captcha no match`: The passed in `Randstr` is invalid. Make sure it is the same as the `Randstr` returned from the frontend. `8 ticket expired`: The `Ticket` has expired. A ticket is valid for five minutes. Please generate a new `Ticket` and `Randstr`. `9 ticket reused`: The specified `Ticket` has been used. Please generate a new `Ticket` and `Randstr`. `15 decrypt fail`: The specified `Ticket` is invalid. Make sure it’s the same as the Ticket returned from the frontend. `16 appid-ticket mismatch`: The specified `CaptchaAppId` is invalid. Make sure it’s the same as the `CaptchaAppId` returned from the frontend. You can obtain it from the CAPTCHA console in **Verification management** > **Basic configuration**. `21 diff`. Ticket verification error. Possible reasons: 1) If the ticket contains the `terror` prefix, it’s usually the case that a disaster recovery ticket is generated due to the network connection problems of the user. You can choose to ignore it or verify again. 2) If the ticket does not include the `terror` prefix, Captcha detects security risk on this request . You can choose to block it or not. `100 appid-secretkey-ticket mismatch`: Parameter error. 1) Make sure `CaptchaAppId` and `AppSecretKey` are correct. `CaptchaAppId` and `AppSecretKey` in the CAPTACHA console under **Verification management** > **Basic configuration**. 2) Make sure the passed-in `Ticket` is generated by using the passed-in `CaptchaAppId`.

Returns:

CaptchaCode `1 OK`: Verification passed `7 captcha no match`: The passed in `Randstr` is invalid. Make sure it is the same as the `Randstr` returned from the frontend. `8 ticket expired`: The `Ticket` has expired. A ticket is valid for five minutes. Please generate a new `Ticket` and `Randstr`. `9 ticket reused`: The specified `Ticket` has been used. Please generate a new `Ticket` and `Randstr`. `15 decrypt fail`: The specified `Ticket` is invalid. Make sure it’s the same as the Ticket returned from the frontend. `16 appid-ticket mismatch`: The specified `CaptchaAppId` is invalid. Make sure it’s the same as the `CaptchaAppId` returned from the frontend. You can obtain it from the CAPTCHA console in **Verification management** > **Basic configuration**. `21 diff`. Ticket verification error. Possible reasons: 1) If the ticket contains the `terror` prefix, it’s usually the case that a disaster recovery ticket is generated due to the network connection problems of the user. You can choose to ignore it or verify again. 2) If the ticket does not include the `terror` prefix, Captcha detects security risk on this request . You can choose to block it or not. `100 appid-secretkey-ticket mismatch`: Parameter error. 1) Make sure `CaptchaAppId` and `AppSecretKey` are correct. `CaptchaAppId` and `AppSecretKey` in the CAPTACHA console under **Verification management** > **Basic configuration**. 2) Make sure the passed-in `Ticket` is generated by using the passed-in `CaptchaAppId`.

setCaptchaCode

public void setCaptchaCode(Long CaptchaCode)

Set `1 OK`: Verification passed `7 captcha no match`: The passed in `Randstr` is invalid. Make sure it is the same as the `Randstr` returned from the frontend. `8 ticket expired`: The `Ticket` has expired. A ticket is valid for five minutes. Please generate a new `Ticket` and `Randstr`. `9 ticket reused`: The specified `Ticket` has been used. Please generate a new `Ticket` and `Randstr`. `15 decrypt fail`: The specified `Ticket` is invalid. Make sure it’s the same as the Ticket returned from the frontend. `16 appid-ticket mismatch`: The specified `CaptchaAppId` is invalid. Make sure it’s the same as the `CaptchaAppId` returned from the frontend. You can obtain it from the CAPTCHA console in **Verification management** > **Basic configuration**. `21 diff`. Ticket verification error. Possible reasons: 1) If the ticket contains the `terror` prefix, it’s usually the case that a disaster recovery ticket is generated due to the network connection problems of the user. You can choose to ignore it or verify again. 2) If the ticket does not include the `terror` prefix, Captcha detects security risk on this request . You can choose to block it or not. `100 appid-secretkey-ticket mismatch`: Parameter error. 1) Make sure `CaptchaAppId` and `AppSecretKey` are correct. `CaptchaAppId` and `AppSecretKey` in the CAPTACHA console under **Verification management** > **Basic configuration**. 2) Make sure the passed-in `Ticket` is generated by using the passed-in `CaptchaAppId`.

Parameters:

CaptchaCode - `1 OK`: Verification passed `7 captcha no match`: The passed in `Randstr` is invalid. Make sure it is the same as the `Randstr` returned from the frontend. `8 ticket expired`: The `Ticket` has expired. A ticket is valid for five minutes. Please generate a new `Ticket` and `Randstr`. `9 ticket reused`: The specified `Ticket` has been used. Please generate a new `Ticket` and `Randstr`. `15 decrypt fail`: The specified `Ticket` is invalid. Make sure it’s the same as the Ticket returned from the frontend. `16 appid-ticket mismatch`: The specified `CaptchaAppId` is invalid. Make sure it’s the same as the `CaptchaAppId` returned from the frontend. You can obtain it from the CAPTCHA console in **Verification management** > **Basic configuration**. `21 diff`. Ticket verification error. Possible reasons: 1) If the ticket contains the `terror` prefix, it’s usually the case that a disaster recovery ticket is generated due to the network connection problems of the user. You can choose to ignore it or verify again. 2) If the ticket does not include the `terror` prefix, Captcha detects security risk on this request . You can choose to block it or not. `100 appid-secretkey-ticket mismatch`: Parameter error. 1) Make sure `CaptchaAppId` and `AppSecretKey` are correct. `CaptchaAppId` and `AppSecretKey` in the CAPTACHA console under **Verification management** > **Basic configuration**. 2) Make sure the passed-in `Ticket` is generated by using the passed-in `CaptchaAppId`.

getCaptchaMsg

public String getCaptchaMsg()

Get Status description and verification error message Note: This field may return `null`, indicating that no valid value was found.

Returns:

CaptchaMsg Status description and verification error message Note: This field may return `null`, indicating that no valid value was found.

setCaptchaMsg

public void setCaptchaMsg(String CaptchaMsg)

Set Status description and verification error message Note: This field may return `null`, indicating that no valid value was found.

Parameters:

CaptchaMsg - Status description and verification error message Note: This field may return `null`, indicating that no valid value was found.

getEvilLevel

public Long getEvilLevel()

Get This parameter returns the result of imperceptible verification. This parameter is not available for Tencent Cloud International yet. `0`: The request is trusted. `100`: The request is malicious. Note: This field may return `null`, indicating that no valid value was found.

Returns:

EvilLevel This parameter returns the result of imperceptible verification. This parameter is not available for Tencent Cloud International yet. `0`: The request is trusted. `100`: The request is malicious. Note: This field may return `null`, indicating that no valid value was found.

setEvilLevel

public void setEvilLevel(Long EvilLevel)

Set This parameter returns the result of imperceptible verification. This parameter is not available for Tencent Cloud International yet. `0`: The request is trusted. `100`: The request is malicious. Note: This field may return `null`, indicating that no valid value was found.

Parameters:

EvilLevel - This parameter returns the result of imperceptible verification. This parameter is not available for Tencent Cloud International yet. `0`: The request is trusted. `100`: The request is malicious. Note: This field may return `null`, indicating that no valid value was found.

getGetCaptchaTime

public Long getGetCaptchaTime()

Get The timestamp when the frontend obtains the CAPTCHA. Note: This field may return `null`, indicating that no valid value was found.

Returns:

GetCaptchaTime The timestamp when the frontend obtains the CAPTCHA. Note: This field may return `null`, indicating that no valid value was found.

setGetCaptchaTime

public void setGetCaptchaTime(Long GetCaptchaTime)

Set The timestamp when the frontend obtains the CAPTCHA. Note: This field may return `null`, indicating that no valid value was found.

Parameters:

GetCaptchaTime - The timestamp when the frontend obtains the CAPTCHA. Note: This field may return `null`, indicating that no valid value was found.

getEvilBitmap

public Long getEvilBitmap()

Get Blocking type Note: This field may return null, indicating that no valid values can be obtained.

Returns:

EvilBitmap Blocking type Note: This field may return null, indicating that no valid values can be obtained.

setEvilBitmap

public void setEvilBitmap(Long EvilBitmap)

Set Blocking type Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

EvilBitmap - Blocking type Note: This field may return null, indicating that no valid values can be obtained.

getSubmitCaptchaTime

public Long getSubmitCaptchaTime()

Get The time when the CAPTCHA is submitted.

Returns:

SubmitCaptchaTime The time when the CAPTCHA is submitted.

setSubmitCaptchaTime

public void setSubmitCaptchaTime(Long SubmitCaptchaTime)

Set The time when the CAPTCHA is submitted.

Parameters:

SubmitCaptchaTime - The time when the CAPTCHA is submitted.

getRequestId

public String getRequestId()

Get The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Returns:

RequestId The unique request ID, which is returned for each request. RequestId is required for locating a problem.

setRequestId

public void setRequestId(String RequestId)

Set The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Parameters:

RequestId - The unique request ID, which is returned for each request. RequestId is required for locating a problem.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel