UNPKG

@nocobase/plugin-verification

Version:

User identity verification management, including SMS, TOTP authenticator, with extensibility.

557 lines (549 loc) 14.4 kB
/** * 全栈式风控引擎出参 */ export interface OutputManageMarketingRisk { /** * 返回码。0表示成功,非0标识失败错误码。 注意:此字段可能返回 null,表示取不到有效值。 */ Code: number; /** * UTF-8编码,出错消息。 注意:此字段可能返回 null,表示取不到有效值。 */ Message: string; /** * 业务详情。 注意:此字段可能返回 null,表示取不到有效值。 */ Value: OutputManageMarketingRiskValue; /** * 控制台显示的req_id。 注意:此字段可能返回 null,表示取不到有效值。 */ UUid: string; } /** * 微信账号信息。 */ export interface WeChatAccountInfo { /** * 微信的OpenID/UnionID 。 */ WeChatOpenId: string; /** * 微信开放账号类型: 1:微信公众号/微信第三方登录。 2:微信小程序。 */ WeChatSubType?: number; /** * 随机串。如果WeChatSubType是2,该字段必填。Token签名随机数,建议16个字符。 */ RandStr?: string; /** * token */ WeChatAccessToken?: string; /** * 用于标识微信用户登录后所关联业务自身的账号ID。 */ AssociateAccount?: string; /** * 账号绑定的手机号。 */ MobilePhone?: string; /** * 用户设备号。 */ DeviceId?: string; } /** * QQ账号信息。 */ export interface QQAccountInfo { /** * QQ的OpenID。 */ QQOpenId: string; /** * QQ分配给网站或应用的AppId,用来唯一标识网站或应用。 */ AppIdUser: string; /** * 用于标识QQ用户登录后所关联业务自身的账号ID。 */ AssociateAccount?: string; /** * 账号绑定的手机号。 */ MobilePhone?: string; /** * 用户设备号。 */ DeviceId?: string; } /** * ManageMarketingRisk请求参数结构体 */ export interface ManageMarketingRiskRequest { /** * 业务入参 */ BusinessSecurityData?: InputManageMarketingRisk; /** * 业务入参 */ BusinessCryptoData?: InputCryptoManageMarketingRisk; } /** * DescribeRiskTrends请求参数结构体 */ export interface DescribeRiskTrendsRequest { /** * 业务入参 */ BusinessSecurityData: InputFrontRisk; } /** * 网赚防刷相关参数 */ export interface SponsorInfo { /** * OpenID */ SponsorOpenId?: string; /** * 设备号 */ SponsorDeviceNumber?: string; /** * 手机号 */ SponsorPhone?: string; /** * IP */ SponsorIp?: string; /** * 链接 */ CampaignUrl?: string; } /** * DescribeRiskAssessment请求参数结构体 */ export declare type DescribeRiskAssessmentRequest = null; /** * 诈骗信息。 */ export interface OnlineScamInfo { /** * 内容标签。 */ ContentLabel?: string; /** * 内容风险等级: 0:正常。 1:可疑。 */ ContentRiskLevel?: number; /** * 内容产生形式: 0:对话。 1:广播。 */ ContentType?: number; /** * 类型 */ FraudType?: number; /** * 账号 */ FraudAccount?: string; } /** * 全栈式风控引擎入参 */ export interface InputManageMarketingRisk { /** * 用户账号类型(默认开通 QQ 开放账号、手机号,手机 MD5 账号类型查询。如需使用微 信开放账号,则需要 提交工单 由腾讯云进行资格审核,审核通过后方可正常使用微信 开放账号): 1:QQ 开放账号。 2:微信开放账号。 4:手机号(暂仅支持国内手机号)。 8:设备号(imei/imeiMD5/idfa/idfaMd5)。 0: 其他。 10004:手机号 MD5。 */ Account: AccountInfo; /** * 场景类型:场景SceneCode, 控制台上新建对应的场景并获取对应的值; 例如:e_register_protection_1521184361 控制台链接:https://console.cloud.tencent.com/rce/risk/sceneroot; */ SceneCode: string; /** * 登录来源的外网IP */ UserIp: string; /** * 时间戳 */ PostTime: number; /** * 用户唯一标识。 */ UserId?: string; /** * 设备指纹token。 */ DeviceToken?: string; /** * 设备指纹BusinessId */ DeviceBusinessId?: number; /** * 业务ID。网站或应用在多个业务中使用此服务,通过此ID区分统计数据。 */ BusinessId?: number; /** * 昵称,UTF-8 编码。 */ Nickname?: string; /** * 用户邮箱地址(非系统自动生成)。 */ EmailAddress?: string; /** * 是否识别设备异常: 0:不识别。 1:识别。 */ CheckDevice?: number; /** * 用户HTTP请求中的Cookie进行2次hash的值,只要保证相同Cookie的hash值一致即可。 */ CookieHash?: string; /** * 用户HTTP请求的Referer值。 */ Referer?: string; /** * 用户HTTP请求的User-Agent值。 */ UserAgent?: string; /** * 用户HTTP请求的X-Forwarded-For值。 */ XForwardedFor?: string; /** * MAC地址或设备唯一标识。 */ MacAddress?: string; /** * 手机制造商ID,如果手机注册,请带上此信息。 */ VendorId?: string; /** * 设备类型,账号类型为8时必填: 0:未知 1:Imei;国际移动设备识别号(15-17位数字) 2:ImeiMd5;国际移动设备识别号,通过MD5加密后32位的小写字符串 3:Idfa; 4:IdfaMD5; */ DeviceType?: number; /** * 详细信息 */ Details?: Array<InputDetails>; /** * 可选填写。详情请跳转至SponsorInfo查看。 */ Sponsor?: SponsorInfo; /** * 可选填写。详情请跳转至OnlineScamInfo查看。 */ OnlineScam?: OnlineScamInfo; /** * 1:安卓 2:iOS 3:H5 4:小程序 */ Platform?: string; } /** * 风险趋势统计--入参 */ export interface InputFrontRisk { /** * 事件ID */ EventId: number; /** * 开始时间 */ StartTime?: string; /** * 结束时间 */ EndTime?: string; /** * 趋势类型 */ Type?: number; /** * 当前开始时间 */ CurrentStartTime?: string; /** * 当前结束时间 */ CurrentEndTime?: string; } /** * 风险趋势统计出参,需要为数组 */ export interface OutputFrontRisk { /** * 名称 注意:此字段可能返回 null,表示取不到有效值。 */ Name: string; /** * 参数值 注意:此字段可能返回 null,表示取不到有效值。 */ Value: Array<OutputFrontRiskValue>; } /** * 其它账号信息。 */ export interface OtherAccountInfo { /** * 其它账号信息: AccountType 是 4 时,填入真实的手机号(如 13123456789)。 AccountType 是 8 时,支持 imei、idfa、imeiMD5、idfaMD5入参。 AccountType 是 0 时,填入账号信息。 AccountType 是 10004 时,填入手机号的 MD5 值。 注:imeiMd5 加密方式为: imei 明文小写后,进行 MD5 加密,加密后取小写值。 IdfaMd5 加密方式为:idfa 明文大写后,进行 MD5 加密,加密后取小写值。 */ AccountId: string; /** * 手机号,若 AccountType 是 4(手机号)、或 10004(手机号 MD5),则无需重复填写 否则填入对应的手机号(如 13123456789)。 */ MobilePhone?: string; /** * 用户设备号。若 AccountType 是 8(设备号),则无需重复填写,否则填入对应的设备 号。 */ DeviceId?: string; } /** * DescribeRiskTrends返回参数结构体 */ export interface DescribeRiskTrendsResponse { /** * 业务出参 */ Data?: OutputFrontRiskData; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 账号信息。 */ export interface AccountInfo { /** * 账号类型 */ AccountType: number; /** * QQ账号信息,AccountType是1时,该字段必填。 */ QQAccount?: QQAccountInfo; /** * 微信账号信息,AccountType是2时,该字段必填。 */ WeChatAccount?: WeChatAccountInfo; /** * 其它账号信息,AccountType是0、4、8或10004时,该字段必填。 */ OtherAccount?: OtherAccountInfo; } /** * ManageMarketingRisk返回参数结构体 */ export interface ManageMarketingRiskResponse { /** * 业务出参 */ Data: OutputManageMarketingRisk; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 全栈式风控引擎入参 */ export interface InputCryptoManageMarketingRisk { /** * 是否授权:1已授权,否则未授权。 调用全栈式风控引擎接口服务时,客户需先明确授权 */ IsAuthorized?: string; /** * 加密类型:1AES加密 */ CryptoType?: string; /** * 加密内容,非空时接口采用加密模式。 */ CryptoContent?: string; } /** * DescribeRiskAssessment返回参数结构体 */ export interface DescribeRiskAssessmentResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 风险趋势统计--值 */ export interface OutputFrontRiskValue { /** * 请求次数 注意:此字段可能返回 null,表示取不到有效值。 */ Requests: number; /** * 日期标签 注意:此字段可能返回 null,表示取不到有效值。 */ Index: string; } /** * 入参的详细参数信息 */ export interface InputDetails { /** * 字段名称 */ FieldName: string; /** * 字段值 */ FieldValue: string; } /** * 全栈式风控引擎出参值 */ export interface OutputManageMarketingRiskValue { /** * 账号ID。对应输入参数: AccountType是1时,对应QQ的OpenID。 AccountType是2时,对应微信的OpenID/UnionID。 AccountType是4时,对应手机号。 AccountType是8时,对应imei、idfa、imeiMD5或者idfaMD5。 AccountType是0时,对应账号信息。 AccountType是10004时,对应手机号的MD5。 注意:此字段可能返回 null,表示取不到有效值。 */ UserId?: string; /** * 操作时间戳,单位秒(对应输入参数)。 注意:此字段可能返回 null,表示取不到有效值。 */ PostTime?: number; /** * 对应输入参数,AccountType 是 QQ 或微信开放账号时,用于标识 QQ 或微信用户登录后关联业务自身的账号ID。 注意:此字段可能返回 null,表示取不到有效值。 */ AssociateAccount?: string; /** * 操作来源的外网IP(对应输入参数)。 注意:此字段可能返回 null,表示取不到有效值。 */ UserIp?: string; /** * 风险值 pass : 无恶意 review:需要人工审核 reject:拒绝,高风险恶意 注意:此字段可能返回 null,表示取不到有效值。 */ RiskLevel?: string; /** * 风险类型,请参考官网风险类型 账号风险 1 账号信用低,账号近期存在因恶意被处罚历史,网络低活跃,被举报等因素 11 疑似 低活跃账号,账号活跃度与正常用户有差异 2 垃圾账号 疑似批量注册小号,近期存在严重违规或大量举报 21 疑似小号 账号有疑似线上养号,小号等行为 22 疑似违规账号 账号曾有违规行为、曾被举报过、曾因违规被处罚过等 3 无效账号 送检账号参数无法成功解析,请检查微信 openid 是否有误/appid与QQopenid无法关联/微信openid权限是否有开通/手机号是否为中国大陆手机号; 4 黑名单 该账号在业务侧有过拉黑记录 5 白名单 业务自行有添加过白名单记录 行为风险 101 批量操作 存在 ip/设备/环境等因素的聚集性异常 1011 疑似 IP 属性聚集,出现 IP 聚集 1012 疑似 设备属性聚集 出现设备聚集 102 自动机 疑似自动机批量请求 103 恶意行为-网赚 疑似网赚 104 微信登录态无效 检查 WeChatAccessToken 参数,是否已经失效; 201 环境风险 环境异常 操作 ip/设备/环境存在异常。当前 ip 为非常用 ip 或恶意 ip 段 2011 疑似 非常用IP 请求 当前请求 IP 非该账号常用 IP 2012 疑似 IP 异常 使用 idc 机房 ip 或 使用代理 ip 或 使用恶意 ip 等 205 非公网有效ip 传进来的 IP 地址为内网 ip 地址或者 ip 保留地址; 设备风险 206 设备异常 该设备存在异常的使用行为 2061 疑似 非常用设备 当前请求的设备非该账号常用设备 2062 疑似 虚拟设备 请求设备为模拟器、脚本、云设备等虚拟设备 2063 疑似 群控设备 请求设备为猫池、手机墙等群控设备 注意:此字段可能返回 null,表示取不到有效值。 */ RiskType?: Array<number | bigint>; /** * 唯一ID 注意:此字段可能返回 null,表示取不到有效值。 */ ConstId?: string; /** * 扩展信息 注意:此字段可能返回 null,表示取不到有效值。 */ RiskInformation?: string; } /** * 风险趋势统计--出参 */ export interface OutputFrontRiskData { /** * 返回码[0:成功;非0:标识失败错误码]。 注意:此字段可能返回 null,表示取不到有效值。 */ Code: number; /** * 出错消息[UTF-8编码]。 注意:此字段可能返回 null,表示取不到有效值。 */ Message: string; /** * 返回结果。 注意:此字段可能返回 null,表示取不到有效值。 */ Value: Array<OutputFrontRisk>; }