apis

Documentation

Index

• type GetSessionIdRequest
  • func NewGetSessionIdRequest() *GetSessionIdRequest
  • func NewGetSessionIdRequestWithAllParams(appId *int64, sceneId *int64, secret *string, uuid *string, ip *string, ...) *GetSessionIdRequest
  • func NewGetSessionIdRequestWithoutParam() *GetSessionIdRequest
  • func (r GetSessionIdRequest) GetRegionId() string
  • func (r *GetSessionIdRequest) SetAppId(appId int64)
  • func (r *GetSessionIdRequest) SetClientType(clientType string)
  • func (r *GetSessionIdRequest) SetClientVersion(clientVersion string)
  • func (r *GetSessionIdRequest) SetFingerPrint(fingerPrint string)
  • func (r *GetSessionIdRequest) SetIp(ip string)
  • func (r *GetSessionIdRequest) SetSceneId(sceneId int64)
  • func (r *GetSessionIdRequest) SetSecret(secret string)
  • func (r *GetSessionIdRequest) SetUserAgent(userAgent string)
  • func (r *GetSessionIdRequest) SetUuid(uuid string)
• type GetSessionIdResponse
• type GetSessionIdResult
• type VerifyTokenRequest
  • func NewVerifyTokenRequest() *VerifyTokenRequest
  • func NewVerifyTokenRequestWithAllParams(verifyToken *string, sessionId *string, appId *int64, sceneId *int64, ...) *VerifyTokenRequest
  • func NewVerifyTokenRequestWithoutParam() *VerifyTokenRequest
  • func (r VerifyTokenRequest) GetRegionId() string
  • func (r *VerifyTokenRequest) SetAppId(appId int64)
  • func (r *VerifyTokenRequest) SetClientType(clientType string)
  • func (r *VerifyTokenRequest) SetClientVersion(clientVersion string)
  • func (r *VerifyTokenRequest) SetFingerPrint(fingerPrint string)
  • func (r *VerifyTokenRequest) SetIp(ip string)
  • func (r *VerifyTokenRequest) SetSceneId(sceneId int64)
  • func (r *VerifyTokenRequest) SetSessionId(sessionId string)
  • func (r *VerifyTokenRequest) SetUserAgent(userAgent string)
  • func (r *VerifyTokenRequest) SetVerifyToken(verifyToken string)
• type VerifyTokenResponse
• type VerifyTokenResult

Types

type GetSessionIdRequest

type GetSessionIdRequest struct {
	core.JDCloudRequest

	/* 应用id (Optional) */
	AppId *int64 `json:"appId"`

	/* 场景id (Optional) */
	SceneId *int64 `json:"sceneId"`

	/* 密钥，从界面获取 (Optional) */
	Secret *string `json:"secret"`

	/* uuid，ios客户端传openudid, android客户端传androidid (Optional) */
	Uuid *string `json:"uuid"`

	/* 客户端ip (Optional) */
	Ip *string `json:"ip"`

	/* 客户端userAgent (Optional) */
	UserAgent *string `json:"userAgent"`

	/* 指纹，客户端sdk获取 (Optional) */
	FingerPrint *string `json:"fingerPrint"`

	/* 客户端类型, android, ios (Optional) */
	ClientType *string `json:"clientType"`

	/* 客户端版本，用户端app版本，可选 (Optional) */
	ClientVersion *string `json:"clientVersion"`
}

func NewGetSessionIdRequest

func NewGetSessionIdRequest() *GetSessionIdRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewGetSessionIdRequestWithAllParams

func NewGetSessionIdRequestWithAllParams(
	appId *int64,
	sceneId *int64,
	secret *string,
	uuid *string,
	ip *string,
	userAgent *string,
	fingerPrint *string,
	clientType *string,
	clientVersion *string,
) *GetSessionIdRequest

* param appId: 应用id (Optional) * param sceneId: 场景id (Optional) * param secret: 密钥，从界面获取 (Optional) * param uuid: uuid，ios客户端传openudid, android客户端传androidid (Optional) * param ip: 客户端ip (Optional) * param userAgent: 客户端userAgent (Optional) * param fingerPrint: 指纹，客户端sdk获取 (Optional) * param clientType: 客户端类型, android, ios (Optional) * param clientVersion: 客户端版本，用户端app版本，可选 (Optional)

func NewGetSessionIdRequestWithoutParam

func NewGetSessionIdRequestWithoutParam() *GetSessionIdRequest

This constructor has better compatible ability when API parameters changed

func (GetSessionIdRequest) GetRegionId

func (r GetSessionIdRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*GetSessionIdRequest) SetAppId

func (r *GetSessionIdRequest) SetAppId(appId int64)

param appId: 应用id(Optional)

func (*GetSessionIdRequest) SetClientType

func (r *GetSessionIdRequest) SetClientType(clientType string)

param clientType: 客户端类型, android, ios(Optional)

func (*GetSessionIdRequest) SetClientVersion

func (r *GetSessionIdRequest) SetClientVersion(clientVersion string)

param clientVersion: 客户端版本，用户端app版本，可选(Optional)

func (*GetSessionIdRequest) SetFingerPrint

func (r *GetSessionIdRequest) SetFingerPrint(fingerPrint string)

param fingerPrint: 指纹，客户端sdk获取(Optional)

func (*GetSessionIdRequest) SetIp

func (r *GetSessionIdRequest) SetIp(ip string)

param ip: 客户端ip(Optional)

func (*GetSessionIdRequest) SetSceneId

func (r *GetSessionIdRequest) SetSceneId(sceneId int64)

param sceneId: 场景id(Optional)

func (*GetSessionIdRequest) SetSecret

func (r *GetSessionIdRequest) SetSecret(secret string)

param secret: 密钥，从界面获取(Optional)

func (*GetSessionIdRequest) SetUserAgent

func (r *GetSessionIdRequest) SetUserAgent(userAgent string)

param userAgent: 客户端userAgent(Optional)

func (*GetSessionIdRequest) SetUuid

func (r *GetSessionIdRequest) SetUuid(uuid string)

param uuid: uuid，ios客户端传openudid, android客户端传androidid(Optional)

type GetSessionIdResponse

type GetSessionIdResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    GetSessionIdResult `json:"result"`
}

type GetSessionIdResult

type GetSessionIdResult struct {
	Data captcha.SessionDataResp `json:"data"`
}

type VerifyTokenRequest

type VerifyTokenRequest struct {
	core.JDCloudRequest

	/* 提交后台校验的token，客户端sdk获取 (Optional) */
	VerifyToken *string `json:"verifyToken"`

	/* 验证码会话id，getsessionid返回 (Optional) */
	SessionId *string `json:"sessionId"`

	/* 应用id (Optional) */
	AppId *int64 `json:"appId"`

	/* 场景id (Optional) */
	SceneId *int64 `json:"sceneId"`

	/* 客户端ip (Optional) */
	Ip *string `json:"ip"`

	/* 客户端userAgent (Optional) */
	UserAgent *string `json:"userAgent"`

	/* 指纹，客户端sdk获取 (Optional) */
	FingerPrint *string `json:"fingerPrint"`

	/* 客户端类型, android, ios (Optional) */
	ClientType *string `json:"clientType"`

	/* 客户端版本，用户端app版本，可选 (Optional) */
	ClientVersion *string `json:"clientVersion"`
}

func NewVerifyTokenRequest

func NewVerifyTokenRequest() *VerifyTokenRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewVerifyTokenRequestWithAllParams

func NewVerifyTokenRequestWithAllParams(
	verifyToken *string,
	sessionId *string,
	appId *int64,
	sceneId *int64,
	ip *string,
	userAgent *string,
	fingerPrint *string,
	clientType *string,
	clientVersion *string,
) *VerifyTokenRequest

* param verifyToken: 提交后台校验的token，客户端sdk获取 (Optional) * param sessionId: 验证码会话id，getsessionid返回 (Optional) * param appId: 应用id (Optional) * param sceneId: 场景id (Optional) * param ip: 客户端ip (Optional) * param userAgent: 客户端userAgent (Optional) * param fingerPrint: 指纹，客户端sdk获取 (Optional) * param clientType: 客户端类型, android, ios (Optional) * param clientVersion: 客户端版本，用户端app版本，可选 (Optional)

func NewVerifyTokenRequestWithoutParam

func NewVerifyTokenRequestWithoutParam() *VerifyTokenRequest

This constructor has better compatible ability when API parameters changed

func (VerifyTokenRequest) GetRegionId

func (r VerifyTokenRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*VerifyTokenRequest) SetAppId

func (r *VerifyTokenRequest) SetAppId(appId int64)

param appId: 应用id(Optional)

func (*VerifyTokenRequest) SetClientType

func (r *VerifyTokenRequest) SetClientType(clientType string)

param clientType: 客户端类型, android, ios(Optional)

func (*VerifyTokenRequest) SetClientVersion

func (r *VerifyTokenRequest) SetClientVersion(clientVersion string)

param clientVersion: 客户端版本，用户端app版本，可选(Optional)

func (*VerifyTokenRequest) SetFingerPrint

func (r *VerifyTokenRequest) SetFingerPrint(fingerPrint string)

param fingerPrint: 指纹，客户端sdk获取(Optional)

func (*VerifyTokenRequest) SetIp

func (r *VerifyTokenRequest) SetIp(ip string)

param ip: 客户端ip(Optional)

func (*VerifyTokenRequest) SetSceneId

func (r *VerifyTokenRequest) SetSceneId(sceneId int64)

param sceneId: 场景id(Optional)

func (*VerifyTokenRequest) SetSessionId

func (r *VerifyTokenRequest) SetSessionId(sessionId string)

param sessionId: 验证码会话id，getsessionid返回(Optional)

func (*VerifyTokenRequest) SetUserAgent

func (r *VerifyTokenRequest) SetUserAgent(userAgent string)

param userAgent: 客户端userAgent(Optional)

func (*VerifyTokenRequest) SetVerifyToken

func (r *VerifyTokenRequest) SetVerifyToken(verifyToken string)

param verifyToken: 提交后台校验的token，客户端sdk获取(Optional)

type VerifyTokenResponse

type VerifyTokenResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    VerifyTokenResult  `json:"result"`
}

type VerifyTokenResult

type VerifyTokenResult struct {
	Data captcha.VerifyDataResp `json:"data"`
}