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 OK indicates verification passed.
String	getCaptchaMsg() Get Status description and verification error message.
String	getDeviceRiskCategory() Get Device risk category.
Long	getEvilBitmap() Get Blocking type Note: This field may return null, indicating that no valid values can be obtained.
Long	getEvilLevel() Get In invisible verification mode, this parameter returns the verification result.
Long	getGetCaptchaTime() Get Frontend retrieval time of the captcha-intl, timestamp format.
String	getRequestId() Get The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId).
Long	getScore() Get CAPTCHA-Intl score.
Long	getSubmitCaptchaTime() Get The time when the CAPTCHA is submitted.
void	setCaptchaCode(Long CaptchaCode) Set OK indicates verification passed.
void	setCaptchaMsg(String CaptchaMsg) Set Status description and verification error message.
void	setDeviceRiskCategory(String DeviceRiskCategory) Set Device risk category.
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 In invisible verification mode, this parameter returns the verification result.
void	setGetCaptchaTime(Long GetCaptchaTime) Set Frontend retrieval time of the captcha-intl, timestamp format.
void	setRequestId(String RequestId) Set The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId).
void	setScore(Long Score) Set CAPTCHA-Intl score.
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, isStream, 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 OK indicates verification passed. 7 captcha no match. the passed in Randstr is invalid. please check if the Randstr is consistent with the Randstr returned by the frontend. The passed-in ticket has expired (the valid period of the ticket is 5 minutes). generate the ticket and Randstr again for validation. The passed-in ticket is reused. generate the ticket and Randstr again for verification. 15 decrypt fail. the passed-in Ticket is invalid. please check if the Ticket is consistent with the Ticket returned by the frontend. 16 appid-ticket mismatch. the passed in CaptchaAppId is incorrect. please check if the CaptchaAppId is consistent with the CaptchaAppId passed in by the frontend, and ensure that the CaptchaAppId is obtained from the verification code console [verification management] -> [basic configuration]. 21 diff invoice verification exception. possible reasons: (1) if the Ticket contains the trerror prefix, generally because the user has a poor network connection, resulting in the frontend's automatic disaster recovery and generation of a disaster recovery Ticket. the business side may skip or post-process as needed. (2) if the Ticket does not include the trerror prefix, it is because the security risk of the request was detected by the CAPTCHA-intl risk control system. the business side may intercept as needed. 100 appid-secretkey-ticket mismatch. parameter validation error. (1) please check whether the CaptchaAppId and AppSecretKey are correct. the CaptchaAppId and AppSecretKey need to be obtained from verification code console > verification management > basic configuration. (2) please check whether the passed-in ticket is generated by the passed-in CaptchaAppId.

Returns:

CaptchaCode OK indicates verification passed. 7 captcha no match. the passed in Randstr is invalid. please check if the Randstr is consistent with the Randstr returned by the frontend. The passed-in ticket has expired (the valid period of the ticket is 5 minutes). generate the ticket and Randstr again for validation. The passed-in ticket is reused. generate the ticket and Randstr again for verification. 15 decrypt fail. the passed-in Ticket is invalid. please check if the Ticket is consistent with the Ticket returned by the frontend. 16 appid-ticket mismatch. the passed in CaptchaAppId is incorrect. please check if the CaptchaAppId is consistent with the CaptchaAppId passed in by the frontend, and ensure that the CaptchaAppId is obtained from the verification code console [verification management] -> [basic configuration]. 21 diff invoice verification exception. possible reasons: (1) if the Ticket contains the trerror prefix, generally because the user has a poor network connection, resulting in the frontend's automatic disaster recovery and generation of a disaster recovery Ticket. the business side may skip or post-process as needed. (2) if the Ticket does not include the trerror prefix, it is because the security risk of the request was detected by the CAPTCHA-intl risk control system. the business side may intercept as needed. 100 appid-secretkey-ticket mismatch. parameter validation error. (1) please check whether the CaptchaAppId and AppSecretKey are correct. the CaptchaAppId and AppSecretKey need to be obtained from verification code console > verification management > basic configuration. (2) please check whether the passed-in ticket is generated by the passed-in CaptchaAppId.

setCaptchaCode

public void setCaptchaCode(Long CaptchaCode)

Set OK indicates verification passed. 7 captcha no match. the passed in Randstr is invalid. please check if the Randstr is consistent with the Randstr returned by the frontend. The passed-in ticket has expired (the valid period of the ticket is 5 minutes). generate the ticket and Randstr again for validation. The passed-in ticket is reused. generate the ticket and Randstr again for verification. 15 decrypt fail. the passed-in Ticket is invalid. please check if the Ticket is consistent with the Ticket returned by the frontend. 16 appid-ticket mismatch. the passed in CaptchaAppId is incorrect. please check if the CaptchaAppId is consistent with the CaptchaAppId passed in by the frontend, and ensure that the CaptchaAppId is obtained from the verification code console [verification management] -> [basic configuration]. 21 diff invoice verification exception. possible reasons: (1) if the Ticket contains the trerror prefix, generally because the user has a poor network connection, resulting in the frontend's automatic disaster recovery and generation of a disaster recovery Ticket. the business side may skip or post-process as needed. (2) if the Ticket does not include the trerror prefix, it is because the security risk of the request was detected by the CAPTCHA-intl risk control system. the business side may intercept as needed. 100 appid-secretkey-ticket mismatch. parameter validation error. (1) please check whether the CaptchaAppId and AppSecretKey are correct. the CaptchaAppId and AppSecretKey need to be obtained from verification code console > verification management > basic configuration. (2) please check whether the passed-in ticket is generated by the passed-in CaptchaAppId.

Parameters:

CaptchaCode - OK indicates verification passed. 7 captcha no match. the passed in Randstr is invalid. please check if the Randstr is consistent with the Randstr returned by the frontend. The passed-in ticket has expired (the valid period of the ticket is 5 minutes). generate the ticket and Randstr again for validation. The passed-in ticket is reused. generate the ticket and Randstr again for verification. 15 decrypt fail. the passed-in Ticket is invalid. please check if the Ticket is consistent with the Ticket returned by the frontend. 16 appid-ticket mismatch. the passed in CaptchaAppId is incorrect. please check if the CaptchaAppId is consistent with the CaptchaAppId passed in by the frontend, and ensure that the CaptchaAppId is obtained from the verification code console [verification management] -> [basic configuration]. 21 diff invoice verification exception. possible reasons: (1) if the Ticket contains the trerror prefix, generally because the user has a poor network connection, resulting in the frontend's automatic disaster recovery and generation of a disaster recovery Ticket. the business side may skip or post-process as needed. (2) if the Ticket does not include the trerror prefix, it is because the security risk of the request was detected by the CAPTCHA-intl risk control system. the business side may intercept as needed. 100 appid-secretkey-ticket mismatch. parameter validation error. (1) please check whether the CaptchaAppId and AppSecretKey are correct. the CaptchaAppId and AppSecretKey need to be obtained from verification code console > verification management > basic configuration. (2) please check whether the passed-in ticket is generated by the passed-in CaptchaAppId.

getCaptchaMsg

public String getCaptchaMsg()

Get Status description and verification error message.

Returns:

CaptchaMsg Status description and verification error message.

setCaptchaMsg

public void setCaptchaMsg(String CaptchaMsg)

Set Status description and verification error message.

Parameters:

CaptchaMsg - Status description and verification error message.

getEvilLevel

public Long getEvilLevel()

Get In invisible verification mode, this parameter returns the verification result. EvilLevel=0 indicates that the request is not malicious. The parameter EvilLevel = 100 indicates that the request is malicious.

Returns:

EvilLevel In invisible verification mode, this parameter returns the verification result. EvilLevel=0 indicates that the request is not malicious. The parameter EvilLevel = 100 indicates that the request is malicious.

setEvilLevel

public void setEvilLevel(Long EvilLevel)

Set In invisible verification mode, this parameter returns the verification result. EvilLevel=0 indicates that the request is not malicious. The parameter EvilLevel = 100 indicates that the request is malicious.

Parameters:

EvilLevel - In invisible verification mode, this parameter returns the verification result. EvilLevel=0 indicates that the request is not malicious. The parameter EvilLevel = 100 indicates that the request is malicious.

getGetCaptchaTime

public Long getGetCaptchaTime()

Get Frontend retrieval time of the captcha-intl, timestamp format.

Returns:

GetCaptchaTime Frontend retrieval time of the captcha-intl, timestamp format.

setGetCaptchaTime

public void setGetCaptchaTime(Long GetCaptchaTime)

Set Frontend retrieval time of the captcha-intl, timestamp format.

Parameters:

GetCaptchaTime - Frontend retrieval time of the captcha-intl, timestamp format.

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.

getDeviceRiskCategory

public String getDeviceRiskCategory()

Get Device risk category. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

DeviceRiskCategory Device risk category. Note: This field may return null, indicating that no valid values can be obtained.

setDeviceRiskCategory

public void setDeviceRiskCategory(String DeviceRiskCategory)

Set Device risk category. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

DeviceRiskCategory - Device risk category. Note: This field may return null, indicating that no valid values can be obtained.

getScore

public Long getScore()

Get CAPTCHA-Intl score. Note:The score ranges from 0 to 100 (e.g., 20, 70, 90). A higher score indicates a greater probability that the interaction was initiated by a bot or represents a bot attack. A lower score indicates a greater probability that the interaction was performed by a real human user.

Returns:

Score CAPTCHA-Intl score. Note:The score ranges from 0 to 100 (e.g., 20, 70, 90). A higher score indicates a greater probability that the interaction was initiated by a bot or represents a bot attack. A lower score indicates a greater probability that the interaction was performed by a real human user.

setScore

public void setScore(Long Score)

Set CAPTCHA-Intl score. Note:The score ranges from 0 to 100 (e.g., 20, 70, 90). A higher score indicates a greater probability that the interaction was initiated by a bot or represents a bot attack. A lower score indicates a greater probability that the interaction was performed by a real human user.

Parameters:

Score - CAPTCHA-Intl score. Note:The score ranges from 0 to 100 (e.g., 20, 70, 90). A higher score indicates a greater probability that the interaction was initiated by a bot or represents a bot attack. A lower score indicates a greater probability that the interaction was performed by a real human user.

getRequestId

public String getRequestId()

Get The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Returns:

RequestId The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

setRequestId

public void setRequestId(String RequestId)

Set The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Parameters:

RequestId - The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). 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

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.