不同场景sceneData数据构建规范说明

2023.12.07 10:45:49

    易盾智能风控系统支持客户给予业务,不同场景下,回传给风控系统不同的检测数据,以期达到更好的检测效果。基于不同类型场景,易盾提供以下 sceneData 数据构建规范:

     

    游戏反外挂

    游戏反外挂

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    gameVersion String 32 601及以上版本 游戏的版本号
    assetVersion String 32 601及以上版本 游戏的资源版本号
    serverId String 64 601及以上版本 当前游戏角色所在游戏区服的ID(所属服务器ID)
    serverName String 32 601及以上版本 当前游戏角色所在游戏区服的名称(所属服务器名称)

     

    注册登录保护

    注册

    支持的接口版本: 600及以上版本,部分字段需要更高版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    registerType String - 600及以上版本 注册方式,可选参数内容如下:
    - userPassword:用户名密码注册
    - phoneAuth:手机号一键注册(包含短信验证码方式注册方式)
    - otherPlatformAuth:第三方平台授权注册(如微信授权注册等)
    - unknown:未知注册方式
    registerChannel String - 600及以上版本 如果是“第三方平台授权注册”,可传入注册渠道,可选参数内容如下:
    - qq:qq授权注册
    - weixin:微信授权注册
    - alipay:支付宝授权注册
    - weibo:微博授权注册
    - other:未知/其他平台授权注册
    inviterId String 128 600及以上版本 如为邀请注册制,可填写邀请人的邀请码、账号ID等唯一标识信息
    hashPassword String 128 600及以上版本 加密后的用户密码
    registerChannelMark String 128 600及以上版本 如可获取注册流量来源平台/渠道(特别适用于通过web、小程序方式进行的注册),可传入平台/渠道的唯一识别码。如:
    - 腾讯平台:传入点击回调中的 click_id
    - 巨量平台:传入点击回调中的 CALLBACK_PARAM
    可根据业务是否获取相关信息及是否需要根据表示进行检测决定是否传入此参数
    gender String - 600及以上版本 注册用户的性别,如应用注册时有明确的性别信息,可通过此处传入。可选参数内容如下:
    - male
    - female
    appChannel String 32 601及以上版本 用户使用的应用来源渠道(或者说是app的上架渠道),如用户是从GooglePlay下载应用,则可传入:googleplay。如业务无法获知当前应用的来源渠道,可传入:unknown

    登录

    支持的接口版本: 600及以上版本,部分字段需要更高版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    loginType String - 600及以上版本 当前用户登录方式,可选参数如下:
    - userPassword:使用用户名、密码登录
    - phoneAuth:使用手机号码授权登录(包含短信验证码方式登录方式)
    - qq:qq授权登录
    - weixin:微信授权登录
    - alipay:支付宝授权登录
    - weibo:微博授权登录
    - other:未知/其他平台授权登录
    appChannel String 32 600及以上版本 用户使用的应用来源渠道(或者说是app的上架渠道),如用户是从GooglePlay下载应用,则可传入:googleplay。如业务无法获知当前应用的来源渠道,可传入:unknown
    registerDay Long 8 600及以上版本 用户账号注册天数
    hashPassword String 128 600及以上版本 加密后的用户密码
    identity String - 600及以上版本 区分用户在业务中的身份类型(通常可用于根据业务需要进行策略研究、布控),可传入参数包括:
    - visitor:游客身份
    - commonUser:普通用户
    - seniorUser:高级用户(如vip、主播、司机等)
    - other:未知/其他身份
    paidUser Boolean - 600及以上版本 用于标记是否付费用户,以方便实施策略布控:
    - true:付费客户
    - false:非付费客户
    verifiedUser Boolean - 600及以上版本 用于标记是否经过实名/信息认证后的用户,以方便实施策略布控:
    - true:认证客户
    - false:非认证客户
    realUser Boolean - 601及以上版本 用于标记是否经过真人认证后的用户,以方便实施策略布控:
    - true:认证客户
    - false:非认证客户

    注册&登录

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    registerOrLogType String - 601及以上版本 注册或登录方式,可选参数内容如下:
    - userPassword:用户名密码注册或登录
    - phoneAuth:手机号一键注册或登录(包含短信验证码方式注册方式)
    - otherPlatformAuth:第三方平台授权注册或登录(如微信授权注册等)
    - unknown:未知注册或登录方式
    operationType String - 601及以上版本 标记本次行为属性,是注册还是登录
    -register:本次行为为注册行为
    -log:本次行为为登录行为
    registerOrLogChannel String - 601及以上版本 如果是“第三方平台授权注册或登录”,可传入注册或登录渠道,可选参数内容如下:
    - qq:qq授权注册或登录
    - weixin:微信授权注册或登录
    - alipay:支付宝授权注册或登录
    - weibo:微博授权注册或登录
    - other:未知/其他平台授权注册或登录
    inviterId String 128 601及以上版本 如为邀请注册制,可填写邀请人的邀请码、账号ID等唯一标识信息
    hashPassword String 128 601及以上版本 加密后的用户密码
    registerOrLogChannelMark String 128 601及以上版本 如可获取注册流量来源平台/渠道(特别适用于通过web、小程序方式进行的注册),可传入平台/渠道的唯一识别码。如:
    - 腾讯平台:传入点击回调中的 click_id
    - 巨量平台:传入点击回调中的 CALLBACK_PARAM
    可根据业务是否获取相关信息及是否需要根据表示进行检测决定是否传入此参数
    gender String - 601及以上版本 注册用户的性别,如应用注册时有明确的性别信息,可通过此处传入。可选参数内容如下:
    - male
    - female
    appChannel String 32 601及以上版本 用户使用的应用来源渠道(或者说是app的上架渠道),如用户是从GooglePlay下载应用,则可传入:googleplay。如业务无法获知当前应用的来源渠道,可传入:unknown
    registerDay Long 8 601及以上版本 如本次行为为登录,则传入用户账号注册天数
    paidUser Boolean - 601及以上版本 用于标记是否付费用户,以方便实施策略布控:
    - true:付费客户
    - false:非付费客户
    verifiedUser Boolean - 601及以上版本 用于标记是否经过实名/信息认证后的用户,以方便实施策略布控:
    - true:认证客户
    - false:非认证客户
    realUser Boolean - 601及以上版本 用于标记是否经过真人认证后的用户,以方便实施策略布控:
    - true:认证客户
    - false:非认证客户

    验证

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    verifyType String - 601及以上版本 当前执行的验证手段类型,可选传入参数包括:
    - upLinkSMS:上行短信验证
    - downLinkSMS:下行短信验证
    - oneClick:一键无感验证
    - captcha:滑动、点选、推理、语序等验证
    - voice:语音验证
    - face:人脸验证
    verifyResult String - 601及以上版本 验证是否成功,可选传入参数包括:
    - success:验证通过
    - fail:验证失败

     

    社交互动保护

    私聊

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    targetId String 128 601及以上版本 聊天对象ID(用户ID)
    contentType String - 601及以上版本 用户发送的聊天信息类型,可传入参数包括:
    - text:文本
    - image:图片
    - video:视频
    - audio:音频
    - link:链接
    content String 1024 601及以上版本 如聊天内容的文本,则传入文本信息(可用于做轻量级文本检测)
    chatId String 64 601及以上版本 当前聊天对话的会话ID,1v1聊天唯一识别ID(只要聊天双方对象未发生改变,则会话id不变)

    群聊/直播间等多人场景

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    chatGroupId String 128 601及以上版本 当前群组、直播间等公共空间ID
    contentType String - 601及以上版本 用户发送的聊天信息类型,可传入参数包括:
    - text:文本
    - image:图片
    - video:视频
    - audio:音频
    - link:链接
    content String 1024 601及以上版本 如聊天内容的文本,则传入文本信息(可用于做轻量级文本检测)

    送礼

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    targetIdList List<String> 数组最大元素个数: 100
    字符串元素最大长度: 128
    601及以上版本 送礼对象用户ID,如送礼对象为多个,则可传入多个对象ID
    giftId String 64 601及以上版本 礼品ID
    giftPrice Double 8 601及以上版本 礼品价格,可以是应用内货币,也可以是真实货币,如为后者,则默认货币计量单位:CNY,单位:元

    打招呼

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    targetIdList List<String> 数组最大元素个数: 100
    字符串元素最大长度: 128
    601及以上版本 打招呼对象ID,如打招呼对象为多个,则可传入多个对象ID
    content String 1024 601及以上版本 打招呼文本内容

    打赏

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    targetId String 128 601及以上版本 打赏对象ID,通常为主播ID、内容作者ID
    rewardPrice Double 8 601及以上版本 打赏金额,通常为真实货币,默认货币计量单位:CNY,单位:元
    relatedId String 64 601及以上版本 打赏关联内容ID,通常用于文章、视频打赏场景

    加入群组/进入直播间

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    chatGroupId String 64 601及以上版本 用户加入的群组对象的ID
    groupName String 64 601及以上版本 用户加入的群组的名称
    groupNum Long 8 601及以上版本 群组成员数量
    groupLevel Long 8 601及以上版本 用于标记群组等级
    joinType String - 601及以上版本 用户标记本次加群行为是用户主动申请,还是群邀请,可传入参数包括:
    - userApply:用户主动申请
    - invited:用户被邀请

    创建群组

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    chatGroupId String 64 601及以上版本 用户创建的群组的ID
    groupName String 64 601及以上版本 用户创建的群组的名称

    加好友/匹配

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    targetId String 128 601及以上版本 加好友对象用户ID
    psText String 1024 601及以上版本 加好友附言文本

    私聊/群聊

    支持的接口版本: 600版本支持,601版本已经移除,不再支持。
    场景拆分为: 私聊 和 群聊/直播间等多人场景

    参数名 类型 必填 最大长度 支持的接口版本 描述
    targetName String 128 600版本支持,601版本已经移除,不再支持 聊天对象昵称
    content String 1024 600版本支持,601版本已经移除,不再支持 聊天信息内容(当前仅支持文本)
    identity String - 600版本支持,601版本已经移除,不再支持 区分用户类型:
    - visitor:游客
    - commonUser:普通用户
    - seniorUser:高级用户(如vip、主播)
    - other:其他身份
    paidUser Boolean - 600版本支持,601版本已经移除,不再支持 是否付费客户:
    - true:付费客户
    - false:非付费客户
    verifiedUser Boolean - 600版本支持,601版本已经移除,不再支持 是否实名/信息认证客户:
    - true:认证客户
    - false:非认证客户

     

    运营/营销活动保护

    签到

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    signInDays Long 8 601及以上版本 用户累计签到天数
    getAward Boolean - 601及以上版本 标记当前行为是否行为激励的方式之一:
    - true:是行为激励
    - false:不是行为激励
    awardId String 64 601及以上版本 如当前行为是行为激励形式之一,则传入用户可获取到的激励物品ID
    awardNum Long 8 601及以上版本 如激励物品可通过数字衡量,可传入激励物品的数量(如积分)

    做任务

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    taskId String 64 601及以上版本 任务的唯一标识ID
    taskType String 64 601及以上版本 任务的类型,如:看视频、点赞、签到、下载等
    getAward Boolean - 601及以上版本 标记任务是否行为激励的方式之一:
    - true:是行为激励
    - false:不是行为激励
    awardId String 64 601及以上版本 如当前行为是行为激励形式之一,则传入用户可获取到的激励物品ID
    awardNum Long 8 601及以上版本 如激励物品可通过数字衡量,可传入激励物品的数量(如积分)
    inviterId String 128 601及以上版本 如任务为邀请制,则传入邀请人
    invitationCode String 128 601及以上版本 如任务为邀请制,传入邀请码(如邀请链接、二维码中的邀请码,凡是用于标记邀请的唯一标识的字段)

    抽奖

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    taskId String 64 601及以上版本 抽奖行为唯一标识ID
    result Integer - 601及以上版本 标记抽奖结果:
    - 1:中奖
    - 0:没中奖
    awardId String 64 601及以上版本 如当前行为是行为激励形式之一,则传入用户可获取到的激励物品ID
    awardNum Long 8 601及以上版本 如激励物品可通过数字衡量,可传入激励物品的数量(如积分)
    awardLevel Integer - 601及以上版本 用于标记奖品等级,可分为以下三类:
    - 1:初级奖品(低价值奖品)
    - 2:中级奖品
    - 3:高级奖品(高价值奖品)

    领劵

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    couponType String 64 601及以上版本 用户所领券的类型,如:满减券、免单券、打折券等
    couponSource String 64 601及以上版本 用户所领券的来源渠道,如商户发放、平台发放等
    couponId String 64 601及以上版本 用户所领券的唯一标识ID
    couponPrice Double 8 601及以上版本 如券可通过数字衡量价值,可传入具体的价值(如券的金额)

    抢红包

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    redEnvelopeType String 64 601及以上版本 红包类型,如口令红包、随机红包等
    redEnvelopSource String - 601及以上版本 红包来源类型,可选传入参数包括:
    - user:用户发的红包
    - official:官方发的红包
    - store:商家发的红包(适用于应用存在第三方入驻商户的情况)
    - other:未知/其他方发的红包
    redEnvelopOwnerId String 128 601及以上版本 如红包来源用户、商户,则传入用户ID、商户ID
    redEnvelopPrice Double 8 601及以上版本 红包的金额,货币计量单位:CNY,单位:元

    活动发起邀请

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    invitationCode String 128 601及以上版本 本次邀请唯一识别ID,如邀请码等
    getAward Boolean - 601及以上版本 标记当前行为是否行为激励的方式之一:
    - true:是行为激励
    - false:不是行为激励
    awardId String 64 601及以上版本 如当前行为是行为激励形式之一,则传入用户可获取到的激励物品ID
    awardNum Long 8 601及以上版本 如激励物品可通过数字衡量,可传入激励物品的数量(如积分)
    invitationType String 32 601及以上版本 标记当前邀请活动类型,如邀请注册、邀请助力砍价等
    requireNum Long 8 601及以上版本 如邀请活动的奖励是阶梯式的,请传入最低获取奖励所要求的接受邀请人数

    活动受邀

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    invitationCode String 128 601及以上版本 本次邀请唯一识别ID,如邀请码等
    inviterId String 128 601及以上版本 邀请人的用户ID
    groupId String 64 601及以上版本 如接受的是诸如拼团等活动,则传入团ID

    点赞

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    contentId String 128 601及以上版本 点赞对象ID
    ownerId String 128 601及以上版本 被点赞对象拥有者用户ID
    times Long 8 601及以上版本 点赞对象累计被点赞次数
    getAward Boolean - 601及以上版本 标记当前行为是否行为激励的方式之一:
    - true:是行为激励
    - false:不是行为激励
    awardId String 64 601及以上版本 如当前行为是行为激励形式之一,则传入用户可获取到的激励物品ID
    awardNum Long 8 601及以上版本 如激励物品可通过数字衡量,可传入激励物品的数量(如积分)

    评论

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    contentId String 128 601及以上版本 评论对象ID
    ownerId String 128 601及以上版本 被评论对象拥有者用户ID
    times Long 8 601及以上版本 评论对象累计被评论次数
    comment String 1024 601及以上版本 评论的文本内容
    getAward Boolean - 601及以上版本 标记当前行为是否行为激励的方式之一:
    - true:是行为激励
    - false:不是行为激励
    awardId String 64 601及以上版本 如当前行为是行为激励形式之一,则传入用户可获取到的激励物品ID
    awardNum Long 8 601及以上版本 如激励物品可通过数字衡量,可传入激励物品的数量(如积分)

    转发/分享

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    contentId String 128 601及以上版本 转发/分享对象ID
    ownerId String 128 601及以上版本 被转发/分享对象拥有者用户ID
    times Long 8 601及以上版本 转发/分享对象累计被转发/分享次数
    targetId String 64 601及以上版本 如转发/分享目标对象是用户、群,可传入用户、群ID
    shareChannel String - 601及以上版本 转发/分享的通道,可选传入参数包括:
    - self:通过当前app自身渠道转发
    - weixin:转发/分享到微信
    - qq:转发/分享到qq
    - weibo:转发/分享到微博
    - other:未知/其他分享渠道
    getAward Boolean - 601及以上版本 标记当前行为是否行为激励的方式之一:
    - true:是行为激励
    - false:不是行为激励
    awardId String 64 601及以上版本 如当前行为是行为激励形式之一,则传入用户可获取到的激励物品ID
    awardNum Long 8 601及以上版本 如激励物品可通过数字衡量,可传入激励物品的数量(如积分)

    收藏

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    contentId String 128 601及以上版本 收藏对象ID
    ownerId String 128 601及以上版本 被收藏对象拥有者用户ID
    times Long 8 601及以上版本 收藏对象累计被收藏次数
    goodsPrice Double 8 601及以上版本 被收藏对象如为商品,可上传商品价格。货币计量单位:CNY,单位:元
    getAward Boolean - 601及以上版本 标记当前行为是否行为激励的方式之一:
    - true:是行为激励
    - false:不是行为激励
    awardId String 64 601及以上版本 如当前行为是行为激励形式之一,则传入用户可获取到的激励物品ID
    awardNum Long 8 601及以上版本 如激励物品可通过数字衡量,可传入激励物品的数量(如积分)

    关注

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    followId String 128 601及以上版本 关注对象ID(可以是被关注的用户ID、商户ID等)
    getAward Boolean - 601及以上版本 标记当前行为是否行为激励的方式之一:
    - true:是行为激励
    - false:不是行为激励
    awardId String 64 601及以上版本 如当前行为是行为激励形式之一,则传入用户可获取到的激励物品ID
    awardNum Long 8 601及以上版本 如激励物品可通过数字衡量,可传入激励物品的数量(如积分)

     

    支付安全保护

    充值

    支持的接口版本: 600及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    payTime Long 13 600及以上版本 角色充值到账时间,UNIX 时间戳(毫秒值)
    appChannel String 32 600及以上版本 客户端app的渠道,如:appstore、googleplay
    money Double 8 600及以上版本 商店定价货币额度,50元(换算人民币)以下记录准确金额,50元(换算人民币)以上可都记录为50元
    currency String 16 600及以上版本 商店定价货币类型,如:USD、EUR、CNY,参考货币代码表(ISO4217)
    payMoney Double 8 600及以上版本 支付货币额度,50元(换算人民币)以下记录准确金额,50元(换算人民币)以上可都记录为50元
    payCurrency String 16 600及以上版本 玩家实际支付货币类型,如:USD、EUR、CNY,参考货币代码表(ISO4217)
    payChannel String 32 600及以上版本 支付渠道,如app_store、google、H5等)
    orderId String 128 600及以上版本 app_store/google/其他渠道唯一订单号
    app_store:iOS的transactionId,例如:160001456292965
    google:Google订单号,例如:GPA.3329-6166-4658-28227
    orderCreateTime Long 13 600及以上版本 订单创建时间,UNIX 时间戳(毫秒值)
    orderPayTime Long 13 600及以上版本 订单支付时间,UNIX 时间戳(毫秒值)
    orderFinishTime Long 13 600及以上版本 订单发货时间,UNIX 时间戳(毫秒值)
    callbackUrl String 256 600及以上版本 回调接口地址,用于坏账治理结果回调通知业务方,如果您开通了坏账治理功能,请在此处填入回调接口,否则检测结果仅可通过页面查询获取。
    仅检测到异常时会回调通知,正常订单不会调用回调接口。

    消费

    支持的接口版本: 600及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    createTime Long 13 600及以上版本 用户账号/角色创建时间点,UNIX 时间戳(毫秒值)
    cost Long 8 600及以上版本 消费货币数(可以是真实金额、应用/游戏中的货币数)

    积分/券等兑换

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    goodsId String 64 601及以上版本 用户兑换的商品ID
    listingTime Long 13 601及以上版本 商品上架的时间点
    goodsCount Long 8 601及以上版本 兑换商品数量
    unitPrice Double 8 601及以上版本 商品的实际单价,通常为真实货币,默认货币计量单位:CNY,单位:元
    totalPrice Double 8 601及以上版本 兑换商品总价格,通常为真实货币,默认货币计量单位:CNY,单位:元
    consumption Long 16 601及以上版本 兑换商品消耗的积分、券数量
    costIdList List<String> 数组最大元素个数: 100
    字符串元素最大长度: 128
    601及以上版本 如兑换商品消耗的是诸如优惠券、折扣券等,可传入券的ID,如消耗多个,可传入多个ID

    提现

    支持的接口版本: 601及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    withdrawCount Double 8 601及以上版本 用户提现的金额,默认货币计量单位:CNY,单位:元
    withdrawAccount String 64 601及以上版本 用户提现账号的ID,如支付宝账号ID、微信账号ID等
    withdrawType String - 601及以上版本 用户提现渠道/方式,可传入参数包括:
    - bank:提现到银行卡
    - weixin:提现到微信
    - alipay:提现到支付宝
    - other:未知/其他提现渠道

    退款

    支持的接口版本: 600及以上版本

    参数名 类型 必填 最大长度 支持的接口版本 描述
    refundTime Long 13 600及以上版本 订单退款时间,UNIX 时间戳(毫秒值)
    orderId String 128 600及以上版本 app_store/google/其他渠道唯一订单号
    app_store:iOS的transactionId,例如:160001456292965
    google:Google订单号,例如:GPA.3329-6166-4658-28227
    refundReason String 64 600及以上版本 用户退款原因
    callbackUrl String 256 600及以上版本 回调接口地址,用于坏账治理结果回调通知业务方,如果您开通了坏账治理功能,请在此处填入回调接口,否则检测结果仅可通过页面查询获取。

    仅检测到异常时会回调通知,正常订单不会调用回调接口。

     

    其他

    其他场景情况下,seceneData无强制要求,可传空串。

    Online Chat Tel:95163223 Free trial