v20190722

Documentation

Index

• Constants
• type Client
  • func NewClient(credential common.CredentialIface, region string, ...) (client *Client, err error)
  • func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)
  • func (c *Client) DescribeCaptchaResult(request *DescribeCaptchaResultRequest) (response *DescribeCaptchaResultResponse, err error)
  • func (c *Client) DescribeCaptchaResultWithContext(ctx context.Context, request *DescribeCaptchaResultRequest) (response *DescribeCaptchaResultResponse, err error)
• type DescribeCaptchaResultRequest
  • func NewDescribeCaptchaResultRequest() (request *DescribeCaptchaResultRequest)
  • func (r *DescribeCaptchaResultRequest) FromJsonString(s string) error
  • func (r *DescribeCaptchaResultRequest) ToJsonString() string
• type DescribeCaptchaResultRequestParams
• type DescribeCaptchaResultResponse
  • func NewDescribeCaptchaResultResponse() (response *DescribeCaptchaResultResponse)
  • func (r *DescribeCaptchaResultResponse) FromJsonString(s string) error
  • func (r *DescribeCaptchaResultResponse) ToJsonString() string
• type DescribeCaptchaResultResponseParams

Constants

const (

	// Internal error.
	INTERNALERROR = "InternalError"

	// Missing parameter.
	MISSINGPARAMETER = "MissingParameter"

	// Authentication failed.
	UNAUTHORIZEDOPERATION_ERRAUTH = "UnauthorizedOperation.ErrAuth"

	// Operation not authorized/No valid package/The account is overdue
	UNAUTHORIZEDOPERATION_UNAUTHORIZED = "UnauthorizedOperation.Unauthorized"
)

const APIVersion = "2019-07-22"

Types

type Client

type Client struct {
	common.Client
}

func NewClient

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) DescribeCaptchaResult

func (c *Client) DescribeCaptchaResult(request *DescribeCaptchaResultRequest) (response *DescribeCaptchaResultResponse, err error)

DescribeCaptchaResult This API is used to query the result of CAPTCHA ticket verification (web and app).

error code that may be returned:

INTERNALERROR = "InternalError"
MISSINGPARAMETER = "MissingParameter"
UNAUTHORIZEDOPERATION_ERRAUTH = "UnauthorizedOperation.ErrAuth"
UNAUTHORIZEDOPERATION_UNAUTHORIZED = "UnauthorizedOperation.Unauthorized"

func (*Client) DescribeCaptchaResultWithContext

func (c *Client) DescribeCaptchaResultWithContext(ctx context.Context, request *DescribeCaptchaResultRequest) (response *DescribeCaptchaResultResponse, err error)

DescribeCaptchaResult This API is used to query the result of CAPTCHA ticket verification (web and app).

error code that may be returned:

INTERNALERROR = "InternalError"
MISSINGPARAMETER = "MissingParameter"
UNAUTHORIZEDOPERATION_ERRAUTH = "UnauthorizedOperation.ErrAuth"
UNAUTHORIZEDOPERATION_UNAUTHORIZED = "UnauthorizedOperation.Unauthorized"

type DescribeCaptchaResultRequest

type DescribeCaptchaResultRequest struct {
	*tchttp.BaseRequest

	// It must be `9` here. You can configure the CAPTCHA types in the console.
	CaptchaType *uint64 `json:"CaptchaType,omitempty" name:"CaptchaType"`

	// The user verification ticket returned by the frontend callback function
	Ticket *string `json:"Ticket,omitempty" name:"Ticket"`

	// The user public IP obtained from the customer backend server
	UserIp *string `json:"UserIp,omitempty" name:"UserIp"`

	// A random string returned by the frontend callback function
	Randstr *string `json:"Randstr,omitempty" name:"Randstr"`

	// CAPTCHA's app ID. Log in to the [Captcha console](https://console.cloud.tencent.com/captcha/graphical) and you can view the CaptchaAppId in the "Key" column of the CAPTCHA list.
	CaptchaAppId *uint64 `json:"CaptchaAppId,omitempty" name:"CaptchaAppId"`

	// CAPTCHA's app key. Log in to the [Captcha console](https://console.cloud.tencent.com/captcha/graphical) and you can view the AppSecretKey in the "Key" column of the CAPTCHA list. AppSecretKey is the key for CAPTCHA ticket verification performed by the server. Please keep it confidential and do not disclose it to any third parties.
	AppSecretKey *string `json:"AppSecretKey,omitempty" name:"AppSecretKey"`

	// Business ID, which is used to differentiate statistical data when this service is used in multiple businesses of a website or an app.
	BusinessId *uint64 `json:"BusinessId,omitempty" name:"BusinessId"`

	// Scenario ID, which is used to differentiate statistical data when this service is used in multiple scenarios of a website or an app.
	SceneId *uint64 `json:"SceneId,omitempty" name:"SceneId"`

	// MAC address or unique identifier of a device
	MacAddress *string `json:"MacAddress,omitempty" name:"MacAddress"`

	// Mobile equipment identity number
	Imei *string `json:"Imei,omitempty" name:"Imei"`

	// Indicates whether to return the time when the frontend obtains the CAPTCHA. Valid values: 1 (return the time) and others.
	NeedGetCaptchaTime *int64 `json:"NeedGetCaptchaTime,omitempty" name:"NeedGetCaptchaTime"`
}

func NewDescribeCaptchaResultRequest

func NewDescribeCaptchaResultRequest() (request *DescribeCaptchaResultRequest)

func (*DescribeCaptchaResultRequest) FromJsonString

func (r *DescribeCaptchaResultRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeCaptchaResultRequest) ToJsonString

func (r *DescribeCaptchaResultRequest) ToJsonString() string

type DescribeCaptchaResultRequestParams

type DescribeCaptchaResultRequestParams struct {
	// It must be `9` here. You can configure the CAPTCHA types in the console.
	CaptchaType *uint64 `json:"CaptchaType,omitempty" name:"CaptchaType"`

	// The user verification ticket returned by the frontend callback function
	Ticket *string `json:"Ticket,omitempty" name:"Ticket"`

	// The user public IP obtained from the customer backend server
	UserIp *string `json:"UserIp,omitempty" name:"UserIp"`

	// A random string returned by the frontend callback function
	Randstr *string `json:"Randstr,omitempty" name:"Randstr"`

	// CAPTCHA's app ID. Log in to the [Captcha console](https://console.cloud.tencent.com/captcha/graphical) and you can view the CaptchaAppId in the "Key" column of the CAPTCHA list.
	CaptchaAppId *uint64 `json:"CaptchaAppId,omitempty" name:"CaptchaAppId"`

	// CAPTCHA's app key. Log in to the [Captcha console](https://console.cloud.tencent.com/captcha/graphical) and you can view the AppSecretKey in the "Key" column of the CAPTCHA list. AppSecretKey is the key for CAPTCHA ticket verification performed by the server. Please keep it confidential and do not disclose it to any third parties.
	AppSecretKey *string `json:"AppSecretKey,omitempty" name:"AppSecretKey"`

	// Business ID, which is used to differentiate statistical data when this service is used in multiple businesses of a website or an app.
	BusinessId *uint64 `json:"BusinessId,omitempty" name:"BusinessId"`

	// Scenario ID, which is used to differentiate statistical data when this service is used in multiple scenarios of a website or an app.
	SceneId *uint64 `json:"SceneId,omitempty" name:"SceneId"`

	// MAC address or unique identifier of a device
	MacAddress *string `json:"MacAddress,omitempty" name:"MacAddress"`

	// Mobile equipment identity number
	Imei *string `json:"Imei,omitempty" name:"Imei"`

	// Indicates whether to return the time when the frontend obtains the CAPTCHA. Valid values: 1 (return the time) and others.
	NeedGetCaptchaTime *int64 `json:"NeedGetCaptchaTime,omitempty" name:"NeedGetCaptchaTime"`
}

Predefined struct for user

type DescribeCaptchaResultResponse

type DescribeCaptchaResultResponse struct {
	*tchttp.BaseResponse
	Response *DescribeCaptchaResultResponseParams `json:"Response"`
}

func NewDescribeCaptchaResultResponse

func NewDescribeCaptchaResultResponse() (response *DescribeCaptchaResultResponse)

func (*DescribeCaptchaResultResponse) FromJsonString

func (r *DescribeCaptchaResultResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeCaptchaResultResponse) ToJsonString

func (r *DescribeCaptchaResultResponse) ToJsonString() string

type DescribeCaptchaResultResponseParams

type DescribeCaptchaResultResponseParams struct {
	//
	//
	//
	//
	//
	//
	//
	//
	//
	//
	//
	//
	//
	//
	//
	//
	//
	//
	//
	//
	//
	//
	//
	//
	CaptchaCode *int64 `json:"CaptchaCode,omitempty" name:"CaptchaCode"`

	// Status description and verification error message
	// Note: This field may return `null`, indicating that no valid value was found.
	CaptchaMsg *string `json:"CaptchaMsg,omitempty" name:"CaptchaMsg"`

	// 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.
	EvilLevel *int64 `json:"EvilLevel,omitempty" name:"EvilLevel"`

	// The timestamp when the frontend obtains the CAPTCHA.
	// Note: This field may return `null`, indicating that no valid value was found.
	GetCaptchaTime *int64 `json:"GetCaptchaTime,omitempty" name:"GetCaptchaTime"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user