v20190722

Documentation

Index

• Constants
• type Client
  • func NewClient(credential *common.Credential, 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)
• type DescribeCaptchaResultRequest
  • func NewDescribeCaptchaResultRequest() (request *DescribeCaptchaResultRequest)
  • func (r *DescribeCaptchaResultRequest) FromJsonString(s string) error
  • func (r *DescribeCaptchaResultRequest) ToJsonString() string
• type DescribeCaptchaResultResponse
  • func NewDescribeCaptchaResultResponse() (response *DescribeCaptchaResultResponse)
  • func (r *DescribeCaptchaResultResponse) FromJsonString(s string) error
  • func (r *DescribeCaptchaResultResponse) ToJsonString() string

Constants

const APIVersion = "2019-07-22"

Types

type Client

type Client struct {
	common.Client
}

func NewClient

func NewClient(credential *common.Credential, 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)

核查验证码票据结果

type DescribeCaptchaResultRequest

type DescribeCaptchaResultRequest struct {
	*tchttp.BaseRequest

	// 验证码类型，9：滑块验证码
	CaptchaType *uint64 `json:"CaptchaType,omitempty" name:"CaptchaType"`

	// 验证码返回给用户的票据
	Ticket *string `json:"Ticket,omitempty" name:"Ticket"`

	// 用户操作来源的外网 IP
	UserIp *string `json:"UserIp,omitempty" name:"UserIp"`

	// 验证票据需要的随机字符串
	Randstr *string `json:"Randstr,omitempty" name:"Randstr"`

	// 验证码应用ID
	CaptchaAppId *uint64 `json:"CaptchaAppId,omitempty" name:"CaptchaAppId"`

	// 用于服务器端校验验证码票据的验证密钥，请妥善保密，请勿泄露给第三方
	AppSecretKey *string `json:"AppSecretKey,omitempty" name:"AppSecretKey"`

	// 业务 ID，网站或应用在多个业务中使用此服务，通过此 ID 区分统计数据
	BusinessId *uint64 `json:"BusinessId,omitempty" name:"BusinessId"`

	// 场景 ID，网站或应用的业务下有多个场景使用此服务，通过此 ID 区分统计数据
	SceneId *uint64 `json:"SceneId,omitempty" name:"SceneId"`

	// mac 地址或设备唯一标识
	MacAddress *string `json:"MacAddress,omitempty" name:"MacAddress"`

	// 手机设备号
	Imei *string `json:"Imei,omitempty" name:"Imei"`
}

func NewDescribeCaptchaResultRequest

func NewDescribeCaptchaResultRequest() (request *DescribeCaptchaResultRequest)

func (*DescribeCaptchaResultRequest) FromJsonString

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

func (*DescribeCaptchaResultRequest) ToJsonString

func (r *DescribeCaptchaResultRequest) ToJsonString() string

type DescribeCaptchaResultResponse

type DescribeCaptchaResultResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 1:验证成功，0:验证失败，100:AppSecretKey参数校验错误
		CaptchaCode *int64 `json:"CaptchaCode,omitempty" name:"CaptchaCode"`

		// 状态描述及验证错误信息
		// 注意：此字段可能返回 null，表示取不到有效值。
		CaptchaMsg *string `json:"CaptchaMsg,omitempty" name:"CaptchaMsg"`

		// [0,100]，恶意等级
		// 注意：此字段可能返回 null，表示取不到有效值。
		EvilLevel *int64 `json:"EvilLevel,omitempty" name:"EvilLevel"`

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeCaptchaResultResponse

func NewDescribeCaptchaResultResponse() (response *DescribeCaptchaResultResponse)

func (*DescribeCaptchaResultResponse) FromJsonString

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

func (*DescribeCaptchaResultResponse) ToJsonString

func (r *DescribeCaptchaResultResponse) ToJsonString() string