#
数美天网-渠道假量识别版权所有 翻版必究
渠道假量识别#
具体接口#
请求URL:#
集群 | URL | 支持产品列表 |
---|---|---|
北京 | http://api-skynet-bj.fengkongcloud.com/v4/event | 天网风险识别 |
美国(弗吉尼亚) | http://api-skynet-fjny.fengkongcloud.com/v4/event | 天网风险识别 |
新加坡 | http://api-skynet-xjp.fengkongcloud.com/v4/event | 天网风险识别 |
欧洲(法兰克福) | http://api-skynet-eur.fengkongcloud.com/v4/event | 天网风险识别 |
请求方法:#
POST
字符编码:#
UTF-8
建议超时时间:#
1s
请求参数:#
请求body = 通用请求参数 + 事件特有参数 (放在data字段下)
通用的请求参数:#
放在HTTP Body中,采用Json格式,具体参数如下:
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
accessKey | string | 接口认证密钥 用于权限认证,开通账号服务时由数美提供或使用开通邮箱登录数美后台右上角相关文档处查看 | 必传参数 | 数美分配 |
appId | string | 应用ID,用于区分相同公司的不同应用 | 必传参数 | 该参数传递值可与数美协商 |
eventId | string | 事件ID,用于标识事件类型。 | 必传参数 | 不同的事件对应不同的策略,不同的事件输入参数可能会有细微的差别,请对应按照各事件详细传参说明 |
data | json_object | 请求的数据内容 | 必传参数 | 请求的数据内容,最长10MB,详见data参数 |
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
tokenId | string | 用户账号标识,建议使用贵司用户UID(可加密)自行生成 , 标识用户唯一身份用作灌水和广告等行为维度风控。如无用户uid的场景建议使用唯一的数据标识传值 | 必传参数 | 该ID为用户的唯一标识,且与其它数美接口的tokenId保持一致 |
isTokenSeperate | int | 是否区分账号体系 同公司不同app接入,未统一账号体系,不同app,不同用户出现相同账号需要区分账号体系,0 ,不区分,1 ,区分。 | 必传参数 | 默认为0 ,如传为1 ,则token会自动处理为appid_token用以区分不同账号体系 |
ip | string | 当前业务事件发生时的客户端公网ipv4地址 | 必传参数 | 非内网ip |
timestamp | int64 | 当前业务事件发生时的时间戳,单位为毫秒(ms) | 必传参数 | |
deviceId | string | 数美设备指纹标识,由数美SDK生成 | 强烈建议 | 数美设备指纹标识,用于用户行为分析。 注: 1. 接入数美SDK前的版本,无法获取到deviceId的情况下,deviceId传空“”即可; 2. 直接传输getDeviceId获取到的原始字段,不需要解密 |
os | string | 应用端操作系统类型 | 强烈建议 | 可选值:android、ios、weapp、web |
appVersion | string | 应用版本号 | 强烈建议 | 传入当前应用或服务正在使用的版本号,格式为3个点4段数字,每段数字最多4位,例如3.2.1.1234 。不足4段的请补0,例如2.1.5 传入2.1.5.0 。多于4段的取前4段,例如2.1.5.1.1 传入2.1.5.1 。 |
activityId | string | 营销活动id | 强烈建议 | 建议传入对应营销活动标识id |
userAgent | string | 用户代理 | 强烈建议 | |
phone | string | 手机号 | 强烈建议 | |
countryCode | string | 手机用户的国家代码 | 强烈建议 | 中国大陆区手机号填写0086 非中国大陆区手机号填写国家代码例如:美国填写0001 、安道尔0376 、巴哈马1242 |
phoneMd5 | string | 手机号的phoneMd5加密串 | 建议 | |
phoneSha256 | string | 手机号的Sha256加密串 | 建议 | |
role | string | 角色 | 强烈建议 | 可选值(强校验取值只能为空、ADMIN 、HOST );HOST 代表主播,针对主播,将会放开多开、PC模拟器规则以及关联频度策略阈值,以保证主播的正常体验和使用。 |
level | int | 用户等级,针对不同等级的用户可配置不同拦截策略 | 强烈建议 | 可选值:0,1,2,3,4 分别对应:0 :最低级用户,典型如新注册、完全不活跃或等级为0的用户等1 :较低级用户,典型如低活跃或低等级用户等2 :中等级用户,典型如具备一定活跃或等级中等的用户等3 :较高级用户,典型如高活跃或高等级用户等4:最高级用户,典型如付费用户、VIP用户、可考虑放过的用户等 |
vdata | json | 微行为数据传入字段 | 建议 | |
extra | json | 用户自定义数据 | 建议 | 如无必要,不传 |
passThrough | json | 用户自定义透传字段 | 建议 | 如无必要,不传 |
返回结果#
放在HTTP Body中,采用Json格式,具体参数如下:
参数名称 | 类型 | 参数说明 | 是否必返 | 规范 |
---|---|---|---|---|
code | int | 返回码 | 是 | 1100 :成功1901 :QPS超限1902 :参数不合法1903 :服务失败1911 :图片下载失败9101 :无权限操作3000 :运营商错误除message和requestId之外的字段,只有当code为1100时才会存在 |
message | string | 返回码描述 | 是 | 和code对应:成功 QPS超限 参数不合法 服务失败 余额不足 无权限操作 |
requestId | string | 请求标识 | 是 | 请求唯一标识,用于排查问题和后续效果优化,强烈建议保存 |
riskevel | string | 当前事件的处置建议 | 是 | PASS :通过REVIEW :审核REJECT :拒绝VERIFY :验证 |
detail | json_object | 风险详情信息,详情见下文 | 是 | 请见《detail结果详情》表 |
tokenProfileLabels | json_array | 账号属性标签 | 否 | 见下面详情内容,仅在服务开通时返回 |
tokenRiskLabels | json_array | 账号风险标签 | 否 | 见下面详情内容,仅在服务开通时返回 |
其中
1)detail结果的详情内容
返回结果参数名 | 参数类型 | 参数说明 | 规范 |
---|---|---|---|
description | string | 当前事件的风险描述 | |
model | string | 规则标识,命中的最高优先级规则标识 | |
hits | Json array | 事件命中的所有规则标识 | hits中每个字段都是一个object,详见《hits结果详情信息》 |
ip_country | string | ip归属地国家 | |
ip_province | string | ip归属地省份 | |
ip_city | string | ip归属地城市 | |
verifyType | string | 当处置建议为VERIFY 时,返回verifyType | UPSMS :上行短信验证码DOWNSMS :下行短信验证码CAPTCHA :验证码(点选或滑动等)SEQUENCE :语序验证(点选或输入)SPATIAL :空间逻辑推理FACE :人脸检测DELAY :延时交易 |
machineAccountRisk | json | 账号历史打黑信息 | 只有当前账号历史被打入账号黑库后,账号的相关流水才会返回该结构体 |
其中,hits结果详情的内容如下:
返回结果参数名 | 参数类型 | 参数说明 | 规范 |
---|---|---|---|
description | string | 当前事件的风险描述 | |
model | string | 规则标识 | |
riskLevel | string | 当前事件的处置建议 | PASS :通过REVIEW :审核REJECT :拒绝VERIFY :验证 |
verifyType | string | 当处置建议为VERIFY 时,返回verifyType | UPSMS :上行短信验证码DOWNSMS :下行短信验证码CAPTCHA :验证码(点选或滑动等)SEQUENCE :语序验证(点选或输入)SPATIAL :空间逻辑推理FACE :人脸检测DELAY :延时交易 |
其中,machineAccountRisk详情的内容如下:
返回结果参数名 | 参数类型 | 参数说明 | 规范 |
---|---|---|---|
tokenSampleLastTs | int | 最近打黑时间,毫秒级 | 如:"tokenSampleLastTs": 1683026613000 |
tokenSampleDesc | string | 历史打黑策略的description | 如:"tokenSampleDesc": "高风险设备:IP异常聚集" |
其中标签类返回字段
1)tokenProfileLabels的详情内容
返回结果参数名 | 参数类型 | 参数说明 | 规范 |
---|---|---|---|
label1 | string | 一级标签 | 展示账号属性标签的一级标签。 |
label2 | string | 二级标签 | 展示账号属性标签的二级标签。 |
label3 | string | 三级标签 | 展示账号属性标签的三级标签。 |
description | string | 风险描述 | 展示账号属性标签的中文描述。 |
timestamp | int64 | 最近一次命中策略的时间 | 最近一次命中策略的时间 |
detail | json_object | 证据描述 | 证据细节 |
2)tokenRiskLabels的详情内容
返回结果参数名 | 参数类型 | 参数说明 | 规范 |
---|---|---|---|
label1 | string | 一级标签 | 展示账号风险标签的一级标签。 |
label2 | string | 二级标签 | 展示账号风险标签的二级标签。 |
label3 | string | 三级标签 | 展示账号风险标签的三级标签。 |
description | string | 风险描述 | 展示账号风险标签的中文描述。 |
timestamp | int64 | 最近一次命中策略的时间 | 最近一次命中策略的时间 |
detail | json_object | 证据描述 | 证据细节 |
事件列表#
行业 | 场景 | 事件 | eventId | 规范 |
---|---|---|---|---|
通用 | 套利-渠道流量反作弊 | 激活 | activation | 参数详情 |
通用 | 套利-渠道流量反作弊 | 首次活跃 | firstActive | 参数详情 |
通用 | 套利-渠道流量反作弊 | 注册 | register | 参数详情 |
通用 | 套利-渠道流量反作弊 | 游客注册 | guestRegister | 参数详情 |
通用 | 套利-渠道流量反作弊 | 登录 | login | 参数详情 |
通用 | 套利-渠道流量反作弊 | 下实物商品订单 | order | 参数详情 |
通用 | 套利-渠道流量反作弊 | 下虚拟商品订单(充值) | virtualOrder | 参数详情 |
通用 | 套利-渠道流量反作弊 | 下服务订单 | serviceOrder | 参数详情 |
通用 | 套利-渠道流量反作弊 | 提现 | withdraw | 参数详情 |
通用 | 套利-渠道流量反作弊 | 浏览 | browse | 参数详情 |
通用 | 套利-渠道流量反作弊 | 点赞 | like | 参数详情 |
通用 | 套利-渠道流量反作弊 | 收藏 | collect | 参数详情 |
通用 | 套利-渠道流量反作弊 | 分享 | share | 参数详情 |
通用 | 套利-渠道流量反作弊 | 关注 | follow | 参数详情 |
通用 | 套利-渠道流量反作弊 | 签到 | signIn | 参数详情 |
通用 | 套利-渠道流量反作弊 | 做任务 | task | 参数详情 |
通用 | 套利-渠道流量反作弊 | 进入房间 | enterRoom | 参数详情 |
通用 | 套利-渠道流量反作弊 | 评论 | comment | 参数详情 |
通用 | 套利-渠道流量反作弊 | 订阅 | subscribe | 参数详情 |
通用 | 套利-渠道流量反作弊 | 支付 | payment | 参数详情 |
事件详细API#
激活 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
advertisingId | string | 广告计费的设备ID | 必传参数 | 一般是安卓的IMEI或苹果设备的IDFA。可以传入哈希值 |
apputm | string | 本次激活来自的渠道标识 | 必传参数 | 客户自定义字段 |
首次活跃 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
guestId | string | 游客账号 | 强烈建议 | 如果是游客首次活跃,只传入tokenId,不传guestId;在游客账号绑定成真实账号时,tokenId传入真实账号,guestId传入游客账号,长度限制在64个字符以内。 |
nickName | string | 用户账户昵称 | 建议 | |
signupPlatform | string | 第三方来源平台,如果本平台直接注册,可以不传 | 建议 | 可选值:qq、weibo、weixin、alipay、taobao、facebook、twitter |
string | 注册使用邮箱 | 建议 | ||
sex | string | 用户性别,没有则不传 | 建议 | 可选值:male,female |
注册事件 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
type | string | 注册方式: 包括手机号码一键注册、手机号验证码注册、第三方授权、用户名密码注册 | 必传参数 | 可选值:phoneOnePass :手机号一键注册、手机号验证码注册signupPlatform 、第三方授权userPassword 用户名密码注册 |
hashPassword | string | 加密后的用户密码 | 强烈建议 | 可选择任意一种加密方式进行加密,但必须确保同一密码加密后是唯一的且一致的。 |
isPhoneExist | int | 该手机号是否已经被注册 | 强烈建议 | 可选值:0 ,1 若注册方式为手机号注册,且该手机号已经被注册过,则传入1 ,否则传入0 . |
guestId | string | 游客账号 | 强烈建议 | 在游客账号绑定成真实账号时,tokenId传入真实账号,guestId传入游客账号,长度限制在64个字符以内。 |
nickName | string | 用户账户昵称 | 建议 | |
clickId | string | 点击id | 强烈建议 | (渠道假量场景,关联渠道点击事件使用) 腾讯平台:传入点击回调中的 click_id 即可巨量平台:传入点击回调中的 CALLBACK_PARAM 即可 |
signupPlatform | string | 第三方注册平台,如果本平台直接注册,可以不传 | 建议 | 可选值:qq、weibo、weixin、alipay、taobao、facebook、twitter |
string | 注册使用邮箱 | 建议 | ||
sex | string | 用户性别,没有则不传 | 建议 | 可选值:male ,female |
isSignupPlatformPhone | int | 该手机号是否是第三方授权平台手机号 | 建议 | 可选值:0 ,1 若手机号为第三方授权平台绑定的手机号,则传入1 ,否则传入0 . |
游客注册 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
guestId | string | 当前业务中用户的游客账号 | 必传参数 | 游客注册事件需要在生成用户的游客ID后调用,每个用户的游客ID是唯一的,且与其它数美接口的guestId保持一致性,长度限制在64个字符以内。 |
roleId | string | 当前业务登录用户角色,游戏行业特殊字段 | 强烈建议 |
登录事件 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
type | string | 登录方式,包括:本机号码一键登录、手机号密码登录、手机号验证码登录、用户名密码登录、生物识别(指纹、人脸、声音锁)登录 | 必传参数 | 可选值:fastLogin :快速登录phoneOneLogin :本机号码一键登录phonePassword :手机号密码登录phoneMessage :手机号验证码登录signupPlatform :第三方授权登录userPassword :用户名密码登录biometric :生物识别 |
hashPassword | string | 加密后的用户密码 | 强烈建议 | 可选择任意一种加密方式进行加密,但必须确保同一密码加密后是唯一的且一致的。 |
subTokenId | string | 账号的子账号 | 强烈建议 | 某些特殊的场景主账号有多个子账号(游戏场景不同区服) |
roleId | string | 当前业务登录用户角色,游戏行业特殊字段 | 强烈建议 | |
valid | int | 用户名密码验证结果 | 建议 | 可选值:1 :成功0 :失败 |
下实物订单 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
products | json array | 订单商品信息,详情见下文 | 必传参数 | |
orderId | string | 订单ID | 强烈建议 | 该商品订单唯一标识 |
paymentId | string | 付款ID | 强烈建议 | 用户进行一次下单付款动作的标识;该标识标记了用户发起的一次下单付款行为。 |
orderNotes | string | 订单备注信息 | 建议 | 用户在此订单上备注的信息 |
paymentMethod | string | 付款方式 | 强烈建议 | 可选值:CASH_ON_DELIVERY :货到付款ONLINE_PAYMENT :在线支付 |
interval | int64 | 商品发布到下单时间,单位毫秒(ms) | 强烈建议 | 主要用于商品秒杀 |
phone | string | 用户下单使用的手机号或者该手机号MD5加密字符串 | 强烈建议 | 中国大陆区手机号请填写11位数字例如:13800138000MD5加密字符串格式为32位小写 |
receiverPhone | string | 收货人手机号 | 强烈建议 | 中国大陆区手机号请填写11位数字例如:13800138000 |
receiverPhoneMd5 | string | 收货人手机号Md5值 | 强烈建议 | MD5加密字符串格式为32位小写例如:d0213fde1643000949161dcb1ed0e605 |
countryCode | string | 手机用户的国家代码 | 强烈建议 | 中国大陆区手机号填写0086非中国大陆区手机号填写国家代码例如:美国填写0001、安道尔0376、巴哈马1242 |
shippingFee | float64 | 物流/快递费用 | 强烈建议 | 例如:0.00, 6.00 |
currency | string | 货币 | 强烈建议 | 参考货币代码表(ISO4217) |
activityId | string | 活动ID | 建议 | 营销活动的ID |
price | float64 | 下单优惠前的金额 | 建议 | 货币计量单位为中国大陆法定货币人民币(CNY),单位:元例如:88.69 |
discount | float64 | 该订单享受的优惠金额 | 建议 | 商品订单原价–商品订单实际支付的价格 |
nickName | string | 用户账户昵称 | 建议 | |
groupId | string | 拼团的团ID | 建议 | 用户自定义唯一标识 |
discountType | string | 优惠来源 | 建议 | 可选值:NEW_USER :新用户优惠REWARD_TASK :奖励任务优惠PURCHASE :购买 |
receiverCountry | string | 收货人地址的国家 | 建议 | 国际域名缩写,若不存在传国家英文全称例如:CN |
receiverProvince | string | 收货人地址的省 | 建议 | 中文例如:山东省 |
receiverCity | string | 收货人地址的市 | 建议 | 中文例如:北京市 |
receiverDistrict | string | 收货人地址的区 | 建议 | 中文例如:朝阳区 |
receiverAddress | string | 收货人地址的详细地址 | 建议 | 中文 |
deliverType | string | 配送方式 | 建议 | 可选值:SELF_PICKUP:自提 EXPRESS:快递 |
groupOwnerId | String | 用户参与拼团的发起人的账号Id | 建议 | 用户参与拼团的发起人的唯一标识 |
shopId | string | 门店编号 | 建议 | |
shopCountry | string | 门店(自提点)归属国家 | 建议 | 用于社区团购场景若不存在传国家英文全称,如:CN |
shopProvince | string | 门店(自提点)归属省 | 建议 | 中文如:山东省 |
shopCity | string | 门店(自提点)归属市 | 建议 | 中文如:北京市 |
shopDistrict | string | 门店(自提点)归属区 | 建议 | 中文如:朝阳区 |
shopAddress | string | 门店(自提点)详细地址 | 建议 | |
discounts | json array | 券信息 | 强烈建议 | 例如:[{"type":"券","id":"xxx","activityId":"xxx", "amount":5.00},{"type":"下单立减","id":"","activityId":"xxx", "amount":10.00},{"type":"积分","id":"","activityId":"xxx", "amount":2.50}] |
products的内容如下:
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
productId | string | 商品ID,SPU标准化产品单元 | 必传参数 | |
productCount | int | 商品数量 | 必传参数 | |
productType | string | 商品类型 | 建议 | 用于需要特殊处理的商品,根据需要传入即可,具体值可参考为:“贵金属” |
merchantId | string | 商户ID | 必传参数 | 若无法区分第三方(自营)传特定值“自营” |
senderCountry | string | 发货人地址的国家 | 建议 | 国际域名缩写,若不存在传国家英文全称例如:CN |
senderProvince | string | 发货人地址的省 | 建议 | 中文例如:山东省 |
senderCity | string | 发货人地址的市 | 建议 | 中文例如:北京市 |
senderDistrict | string | 发货人地址的区 | 建议 | 中文例如:朝阳区 |
senderAddress | string | 发货人地址的详细地址 | 建议 | 中文例如:望京诚盈中心1号楼3A或北京市朝阳区望京诚盈中心1号楼3A |
productBrand | string | 商品品牌 | 建议 | productBrand |
productName | string | 商品名称 | 建议 | productName |
productPrice | float | 商品价格 | 建议 | productPrice |
currency | string | 计价货币 | 建议 | currency |
discounts的内容如下:
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
type | string | 券类型 | 强烈建议 | |
id | string | 券ID | 强烈建议 | 标记优惠的唯一ID |
activityId | string | 券对应的活动ID | 强烈建议 | 营销活动的ID |
amount | float | 券金额 | 强烈建议 |
下虚拟商品订单 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
product | string | 虚拟商品名称 | 必传参数 | 例如:金币、道具、会员等机票(航班号+“-”+日期,CA288-20180101) |
orderId | string | 订单ID | 强烈建议 | 该商品订单唯一标识 |
interval | int64 | 商品发布到下单时间,单位毫秒(ms) | 强烈建议 | 主要用于商品秒杀 |
price | float64 | 下单总金额(优惠前) | 强烈建议 | 货币计量单位为中国大陆法定货币人民币(CNY),单位:元例如:88.69 |
discount | float64 | 该订单享受的优惠金额 | 强烈建议 | 商品订单原价–商品订单实际支付的价格 |
account | float64 | 购买商品后账户余额 | 强烈建议 | 购买金币、Q币等虚拟商品后账户余额(增加),单位:元,例如:10.5 |
groupId | string | 拼团的团ID | 建议 | 用户自定义唯一标识 |
discountType | string | 优惠来源 | 建议 | 可选值:NEW_USER :新用户优惠REWARD_TASK :奖励任务优惠PURCHASE :购买 |
currency | string | 货币 | 强烈建议 | 参考货币代码表(ISO4217) |
下服务订单 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
orderId | string | 订单ID | 必传参数 | |
products | json array | 订单服务信息,详情见下文 | 强烈建议 | |
interval | int64 | 服务商品发布到下服务订单时间,单位毫秒(ms) | 强烈建议 | |
serviceTokenId | string | 提供服务的账号ID | 强烈建议 | |
price | float64 | 下单优惠前的金额 | 建议 | 货币计量单位为中国大陆法定货币人民币(CNY,单位:元例如:88.69 |
discount | float64 | 该订单享受的优惠金额 | 建议 | 商品订单原价–商品订单实际付款的价格 |
discountType | string | 优惠来源 | 建议 | 可选值:NEW_USER :新用户优惠REWARD_TASK :奖励任务优惠PURCHASE :购买 |
serviceName | string | 服务商品名称 | 建议 | 例如:专车、拼车、出租车、送外卖、送咖啡等 |
currency | string | 计价货币 | 建议 | 价值的单位:人民币,美元,金币,智慧币等 |
products的内容如下:
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
productId | string | 商品ID,SPU标准化产品单元 | 必传参数 | |
productCount | int | 商品数量 | 必传参数 | |
merchantId | string | 商户ID | 必传参数 | 若无法区分第三方(自营)传特定值“自营” |
senderCountry | string | 发货人地址的国家 | 建议 | 国际域名缩写,若不存在传国家英文全称例如:CN |
senderProvince | string | 发货人地址的省 | 建议 | 中文例如:山东省 |
senderCity | string | 发货人地址的市 | 建议 | 中文例如:北京市 |
senderDistrict | string | 发货人地址的区 | 建议 | 中文例如:朝阳区 |
senderAddress | string | 发货人地址的详细地址 | 建议 | 中文例如:望京诚盈中心1号楼3A或北京市朝阳区望京诚盈中心1号楼3A |
提现 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
withdrawAmount | float64 | 提现金额 | 必传参数 | 货币计量单位为中国大陆法定货币人民币(CNY),单位:元例如:88.69 |
withdrawAccountId | string | 提现账户ID | 必传参数 | 例如:支付宝账户ID |
withdrawPhone | string | 提现时使用的手机号或者该手机号MD5加密字符串 | 强烈建议 | 中国大陆区手机号请填写11位数字例如:13800138000MD5加密字符串格式为32位小写 |
phoneMd5 | string | 用户取消订单的手机号或者该手机号MD5加密字符串 | 强烈建议 | 中国大陆区手机号请填写11位数字例如:13800138000MD5加密字符串格式为32位小写 |
withdrawAccountType | string | 提现账户类型,银行卡/微信/支付宝 | 强烈建议 | 可选值:bank:银行卡 weixin:微信 alipay:支付宝others:自由支付渠道 |
currency | string | 货币 | 强烈建议 | 参考货币代码表(ISO4217) |
浏览/观看/阅读 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
guestId | string | 当前业务中浏览的游客账户ID,当用户以游客身份进入时传入guestId | 强烈建议 | 每个游客账号ID是唯一的,且与其它数美接口guestId保持一致性,长度限制在64个字符以内。 |
referId | string | 前一个内容或页面ID,可以是URI | 强烈建议 | |
contentOwnerId | string | 被浏览内容的拥有者账号ID | 强烈建议 | 平台自己发布的内容传空字符串 |
level | int | 用户等级,针对不同等级的用户可配置不同拦截策略 | 强烈建议 | 可选值:0,1,2,3,4 分别对应:0 :最低级用户,典型如新注册、完全不活跃或等级为0的用户等1 :较低级用户,典型如低活跃或低等级用户等2 :中等级用户,典型如具备一定活跃或等级中等的用户等3 :较高级用户,典型如高活跃或高等级用户等4 :最高级用户,典型如付费用户、VIP用户、可考虑放过的用户等 |
productId | string | 商品ID | 强烈建议 | 浏览商品详情页是传入 |
productType | string | 商品类别 | 强烈建议 | 浏览商品详情页是传入 商品的分类,例如:手机、电脑配件、化妆品、电脑笔记本等 |
productName | string | 商品名称 | 强烈建议 | 浏览商品详情页是传入 |
productBrand | string | 商品品牌 | 强烈建议 | 浏览商品详情页是传入 |
productPrice | float | 商品单价 | 强烈建议 | 浏览商品详情页是传入 |
currency | string | 计价货币 | 强烈建议 | 浏览商品详情页是传入 参考货币代码表(ISO4217) |
referType | string | 前一个页面类型 | 强烈建议 | 可选值:首页、商品分类页,详情页,列表页 |
searchKeyWords | string | 搜索关键词 | 建议 | 适用于通过搜索进入页面 |
browseLength | int64 | 本次浏览时长,单位为毫秒(ms) | 建议 | 适用电商场景 |
nickName | string | 用户账户昵称 | 建议 | |
eventName | string | 浏览页面的类型 | 建议 | 例如:首页、关注页、搜索页、推荐页等 |
contentId | string | 内容或页面id,可以是URI | 建议 | 当前页面Id,需要去掉可变参数 |
contentType | string | 视频、文章、书籍小说 | 建议 | 可选值:video :视频article :文章book :书籍ad :广告 |
contentLength | int64 | 内容长度 1.对于视频,是以ms为单位的时间; 2.对于文章,为空 3.对于小说,以字为单位的字数 | 建议 | |
watchLength | int64 | 本次观看时长,单位为毫秒(ms) | 建议 | |
inviteTokenId | string | 分享或邀请人的的tokenId | 建议 | |
getCoupon | int | 激励事件标注 | 建议 | 如果此次事件是行为激励的一种任务形式,传入 1 ;否则传入0 |
点赞 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
receiveTokenId | string | 点赞行为对象的ID | 强烈建议 | 被点赞内容的拥有者ID |
nickName | string | 用户账户昵称 | 建议 | |
contentId | string | 被点赞内容的ID | 建议 | 被点赞内容的ID |
getCoupon | int | 激励事件标注 | 建议 | 如果此次事件是行为激励的一种任务形式,传入1 ;否则传入0 |
shoppingMallId | string | 商场Id | 建议 | 线下场景,被点赞商户所在商场 |
收藏 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
receiveTokenId | string | 收藏行为对象的ID | 强烈建议 | 被收藏内容的拥有者ID |
nickName | string | 用户账户昵称 | 建议 | |
contentId | string | 被收藏内容的ID | 建议 | 被收藏内容的ID |
getCoupon | int | 激励事件标注 | 建议 | 如果此次事件是行为激励的一种任务形式,传入1 ;否则传入0 |
productId | string | 商品ID | 建议 | |
productBrand | string | 商品品牌 | 建议 | |
productName | string | 商品名称 | 建议 | |
productPrice | float | 商品价格 | 建议 | |
currency | string | 计价货币 | 建议 |
#
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
receiveTokenId | string | 分享行为对象的ID | 强烈建议 | 被分享的目标对象ID |
nickName | string | 用户账户昵称 | 建议 | |
contentId | string | 被分享内容的ID | 建议 | 被分享内容的ID |
contentOwnerId | string | 被分享内容的拥有者ID | 建议 | 被分享内容的拥有者ID |
getCoupon | int | 激励事件标注 | 建议 | 如果此次事件是行为激励的一种任务形式,传入1 ;否则传入0 |
关注 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
receiveTokenId | string | 关注行为对象的ID | 强烈建议 | 被关注的目标对象ID |
nickName | string | 用户账户昵称 | 建议 | |
contentId | string | 被关注内容的ID | 建议 | 被关注内容的ID |
getCoupon | int | 激励事件标注 | 建议 | 如果此次事件是行为激励的一种任务形式,传入1 ;否则传入0 |
评论 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
comment | string | 用户评论的内容 | 强烈建议 | 用户评论的内容 |
commentId | string | 评论内容的Id | 强烈建议 | 用户评论内容的id |
flightNum | string | 被评论的航班号 | 强烈建议 | 用户评论的航班号(特殊行业字段) |
orderId | string | 发表商品评论关联的订单号 | 强烈建议 | |
productId | String | 发表商品评论关联的商品 | 强烈建议 |
签到 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
nickName | string | 用户账户昵称 | 建议 | |
getCoupon | int | 激励事件标注 | 建议 | 如果此次事件是行为激励的一种任务形式,传入1 ;否则传入0 |
做任务 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
roleId | string | 当前业务登录用户角色,游戏行业特殊字段 | 强烈建议 | |
subTokenId | string | 账号的子账号 | 强烈建议 | 某些特殊的场景主账号有多个子账号(游戏场景不同区服) |
taskId | string | 任务ID | 强烈建议 | 任务唯一标识 |
inviteTokenId | string | 邀请人的tokenId | 强烈建议 | 用在任务是由其他用户邀请做时传这个字段 |
invitationCode | string | 邀请用户的邀请码 | 强烈建议 | 接受邀请人填写的邀请码,或在二维码、链接中隐含的邀请码 |
getCoupon | int | 激励事件标注 | 建议 | 如果此次事件是行为激励的一种任务形式,传入1 ;否则传入0 |
eventName | string | 事件名,表示当前事件类型下的具体事件 | 建议 | 例如:签到、玩游戏、记账、走路 |
taskCostTime | int64 | 任务时长,以毫秒(ms)为单位的时间签到:0玩游戏:游戏时长记账:0走路:走路消耗时长 | 建议 | |
taskAmount | int64 | 任务内计数签到:留空玩游戏:留空记账:留空走路:走路步数 | 建议 | |
nickName | string | 用户账户昵称 | 建议 | |
extra | json | 用户自定义数据或者数美要求传的特定数据 | 如无必要,不传 |
进入房间 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
roomId | String | 房间号 | 必传参数 | 用户进入的房间号 |
enterFrom | string | 进入房间来源 | 强烈建议 | 从哪个页面进入直播间,可选值:搜索结果,推荐页面,自动浏览,其他 |
订阅 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
contentId | string | 用户订阅的文章id | 强烈建议 | 用户订阅的文章id |
receiveTokenId | string | 用户订阅文章的作者id | 强烈建议 | 用户订阅文章的作者id |
支付 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
method | string | 支付方式 | 强烈建议 | 可选值:qrscan :二维码支付,主动扫码qrshow :二维码支付,被动扫码(展示付款码给别人)phone :手机Pay支付widget :控件支付wechatQr : 微信扫码支付aliPay : 支付宝扫码/登录付款debitCard :借记卡支付creditCard :信用卡支付huaweiPay :华为钱包支付 |
currency | string | 计价货币 | 强烈建议 | 参考货币代码表(ISO4217) |
channel | string | 支付渠道 | 强烈建议 | |
cvvResultCode | string | cvv验证结果 | 强烈建议 | 参考http://www.emsecommerce.net/avs_cvv2_response_codes.htm |
avsResultCode | string | 地址验证结果 | 强烈建议 | 参考http://www.emsecommerce.net/avs_cvv2_response_codes.htm |
cardBin | string | 卡bin,银行卡前六位 | 强烈建议 | |
bankCard | string | 支付银行卡号 | 强烈建议 | 当支付方式为借记卡支付或信用卡支付时传入该字段 XXXX-XXXX-XXXX-4242, 除后四位外,其余可用X代替 |
orderId | string | 订单编号 | 强烈建议 | 当前支付的订单编号 |
bankCardPhone | string | 银行卡绑定的手机号 | 强烈建议 | 当支付方式为借记卡支付或信用卡支付时传入该字段 |
prcid | string | 银行卡所属人身份证号码的MD5 | 强烈建议 | |
merchantType | string | 收款商户类型 | 强烈建议 | 可选值为:1 . normal: “普通商户”,商户资质要求较高,商户需要三证一表注册入网;2 . micro:“小微商户”,商户不需要提供三证一表,提供普通身份信息注册商户;3 . individual:“个人转账”,对收款方没有任何限制4 . platform:“平台自身” |
示例:#
请求示例:#
同步返回示例:#
账号查询接口#
请求URL:#
集群 | URL | 支持产品列表 |
---|---|---|
北京集群 | http://api-tianxiang-bj.fengkongcloud.com/tianxiang/v4 | 风险查询 |
新加坡集群 | http://api-tianxiang-xjp.fengkongcloud.com/tianxiang/v4 | 风险查询 |
法兰克福集群 | http://api-tianxiang-eur.fengkongcloud.com/tianxiang/v4 | 风险查询 |
弗吉尼亚集群 | http://api-tianxiang-fjny.fengkongcloud.com/tianxiang/v4 | 风险查询 |
请求方法:#
POST
字符编码:#
UTF-8
建议超时时间:#
1s
请求参数:#
放在HTTP Body中,采用Json格式,具体参数如下:
请求参数名 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
accessKey | string | 接口认证密钥 用于权限认证,开通账号服务时由数美提供或使用开通邮箱登录数美后台右上角相关文档处查看 | 必传参数 | 数美分配 |
data | json_object | 请求的数据内容 | 必传参数 | 请求的数据内容,最长10MB,详见data参数 |
请求参数名 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
tokenId | string | 用户账号标识,建议使用贵司用户UID(可加密)自行生成 , 标识用户唯一身份用作灌水和广告等行为维度风控。如无用户uid的场景建议使用唯一的数据标识传值 | 不能为空 | 该ID为用户的唯一标识,且与其它数美接口的tokenId保持一致 |
返回结果#
放在HTTP Body中,采用Json格式,具体参数如下:
参数名称 | 参数类型 | 参数说明 | 是否必返 | 规范 |
---|---|---|---|---|
code | int | 返回码 | 是 | 1100 :成功1901 :QPS超限1902 :参数不合法1903 :服务失败1911 :图片下载失败9101 :无权限操作3000 :运营商错误除message和requestId之外的字段,只有当code为1100时才会存在 |
message | string | 返回码描述 | 是 | 和code对应:成功 QPS超限 参数不合法 服务失败 余额不足 无权限操作 |
requestId | string | 请求标识 | 是 | 请求唯一标识,用于排查问题和后续效果优化,强烈建议保存 |
tokenLabels | json_object | 账号标签信息 | 否 | 见下面详情内容,仅在tokenId传入且服务开通时返回 |
tokenProfileLabels | json_array | 账号属性标签 | 否 | 见下面详情内容,仅在tokenId传入且服务开通时返回 |
tokenRiskLabels | json_array | 账号风险标签 | 否 | 见下面详情内容,仅在tokenId传入且服务开通时返回 |
其中
1)tokenLabels的详情内容
返回结果参数名 | 参数类型 | 参数说明 | 规范 |
---|---|---|---|
machine_account_risk | json_object | 机器控制相关风险 | |
UGC_account_risk | json_object | UGC内容相关风险 | |
scene_account_risk | json_object | 场景账号风险 | 特殊场景才可取到,如航司等 |
machine_account_risk的详情内容如下:
返回结果参数名 | 参数类型 | 参数说明 | 规范 |
---|---|---|---|
b_machine_control_tokenid | int | 机器账号 | 0 :非机器控制账号1 :机器控制账号 |
b_machine_control_tokenid_last_ts | int | 机器账号时间 | |
b_offer_wall_tokenid | int | 积分墙账号 | 0 :非积分墙账号1 :积分墙账号 |
b_offer_wall_tokenid_last_ts | int | 积分墙账号时间 |
UGC_account_risk的详情内容如下:
返回结果参数名 | 参数类型 | 参数说明 | 规范 |
---|---|---|---|
b_politics_risk_tokenid | int | 涉政风险 | 0 :暂未发现涉政风险1 :存在涉政风险 |
b_politics_risk_tokenid_last_ts | int | 涉政风险时间 | |
b_sexy_risk_tokenid | int | 色情风险 | 0 :暂未发现色情风险1 :存在色情风险 |
b_sexy_risk_tokenid_last_ts | int | 色情风险时间 | |
b_advertise_risk_tokenid | int | 广告风险 | 0 :暂未发现广告风险1 :存在广告风险 |
b_advertise_risk_tokenid_last_ts | int | 广告风险时间 |
scene_account_risk的详情内容如下:
返回结果参数名 | 参数类型 | 参数说明 | 规范 |
---|---|---|---|
i_tout_risk_tokenid | int | 航司占座账号 | 0 :非航司占座账号1 :航司占座账号 |
i_tout_risk_tokenid_last_ts | int | 航司占座时间 |
其中标签类返回字段
1)tokenProfileLabels的详情内容
返回结果参数名 | 参数类型 | 参数说明 | 规范 |
---|---|---|---|
label1 | string | 一级标签 | 展示账号属性标签的一级标签。 |
label2 | string | 二级标签 | 展示账号属性标签的二级标签。 |
label3 | string | 三级标签 | 展示账号属性标签的三级标签。 |
description | string | 风险描述 | 展示账号属性标签的中文描述。 |
timestamp | int64 | 最近一次命中策略的时间 | 最近一次命中策略的时间 |
detail | json_object | 证据描述 | 证据细节 |
2)tokenRiskLabels的详情内容
返回结果参数名 | 参数类型 | 参数说明 | 规范 |
---|---|---|---|
label1 | string | 一级标签 | 展示账号风险标签的一级标签。 |
label2 | string | 二级标签 | 展示账号风险标签的二级标签。 |
label3 | string | 三级标签 | 展示账号风险标签的三级标签。 |
description | string | 风险描述 | 展示账号风险标签的中文描述。 |
timestamp | int64 | 最近一次命中策略的时间 | 最近一次命中策略的时间 |
detail | json_object | 证据描述 | 证据细节 |