数美天网-营销风控#


版权所有 翻版必究


营销风控

营销风控#

具体接口#

请求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格式,具体参数如下:

参数名称类型参数说明是否必传规范
accessKeystring接口认证密钥
用于权限认证,开通账号服务时由数美提供或使用开通邮箱登录数美后台右上角相关文档处查看
必传参数数美分配
appIdstring应用ID,用于区分相同公司的不同应用必传参数该参数传递值可与数美协商
eventIdstring事件ID,用于标识事件类型。必传参数不同的事件对应不同的策略,不同的事件输入参数可能会有细微的差别,请对应按照各事件详细传参说明
datajson_object请求的数据内容必传参数请求的数据内容,最长10MB,详见data参数
其中,data的内容如下:
参数名称类型参数说明是否必传规范
tokenIdstring用户账号标识,建议使用贵司用户UID(可加密)自行生成 , 标识用户唯一身份用作灌水和广告等行为维度风控。如无用户uid的场景建议使用唯一的数据标识传值不能同时为空该ID为用户的唯一标识,且与其它数美接口的tokenId保持一致
isTokenSeperateint是否区分账号体系 同公司不同app接入,未统一账号体系,不同app,不同用户出现相同账号需要区分账号体系,0,不区分,1,区分。必传参数默认为0,如传为1,则token会自动处理为appid_token用以区分不同账号体系
ipstring当前业务事件发生时的客户端公网ipv4地址必传字段非内网ip
timestampint64当前业务事件发生时的时间戳,单位为毫秒(ms)必传字段
deviceIdstring数美设备指纹标识,由数美SDK生成强烈建议数美设备指纹标识,用于用户行为分析。
注:
1. 接入数美SDK前的版本,无法获取到deviceId的情况下,deviceId传空“”即可;
2. 直接传输getDeviceId获取到的原始字段,不需要解密
osstring应用端操作系统类型强烈建议可选值:android、ios、weapp、web
appVersionstring应用版本号强烈建议传入当前应用或服务正在使用的版本号,格式为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
activityIdstring营销活动id强烈建议建议传入对应营销活动标识id
userAgentstring用户代理强烈建议
phonestring手机号强烈建议
countryCodestring手机用户的国家代码强烈建议中国大陆区手机号填写0086非中国大陆区手机号填写国家代码例如:美国填写0001、安道尔0376、巴哈马1242
phoneMd5string手机号的phoneMd5加密串建议
phoneSha256string手机号的Sha256加密串建议
rolestring角色强烈建议可选值(强校验取值只能为空、ADMINHOST);HOST代表主播,针对主播,将会放开多开、PC模拟器规则以及关联频度策略阈值,以保证主播的正常体验和使用。
levelint用户等级,针对不同等级的用户可配置不同拦截策略强烈建议可选值:0,1,2,3,4分别对应:
0:最低级用户,典型如新注册、完全不活跃或等级为0的用户等
1:较低级用户,典型如低活跃或低等级用户等
2:中等级用户,典型如具备一定活跃或等级中等的用户等
3:较高级用户,典型如高活跃或高等级用户等4:最高级用户,典型如付费用户、VIP用户、可考虑放过的用户等
vdatajson微行为数据传入字段建议
extrajson用户自定义数据建议如无必要,不传
passThroughjson用户自定义透传字段建议如无必要,不传

返回结果#

放在HTTP Body中,采用Json格式,具体参数如下:

参数名称类型参数说明是否必返规范
codeint返回码1100:成功
1901:QPS超限
1902:参数不合法
1903:服务失败
1911:图片下载失败
9101:无权限操作
3000:运营商错误
除message和requestId之外的字段,只有当code为1100时才会存在
messagestring返回码描述和code对应:成功 QPS超限 参数不合法 服务失败 余额不足 无权限操作
requestIdstring请求标识请求唯一标识,用于排查问题和后续效果优化,强烈建议保存
riskevelstring当前事件的处置建议PASS:通过
REVIEW:审核
REJECT:拒绝
VERIFY:验证
detailjson_object风险详情信息,详情见下文请见《detail结果详情》表
tokenProfileLabelsjson_array账号属性标签见下面详情内容,仅在服务开通时返回
tokenRiskLabelsjson_array账号风险标签见下面详情内容,仅在服务开通时返回

其中

1)detail结果的详情内容

返回结果参数名参数类型参数说明规范
descriptionstring当前事件的风险描述
modelstring规则标识,命中的最高优先级规则标识
hitsJson array事件命中的所有规则标识hits中每个字段都是一个object,详见《hits结果详情信息》
ip_countrystringip归属地国家
ip_provincestringip归属地省份
ip_citystringip归属地城市
verifyTypestring当处置建议为VERIFY时,返回verifyTypeUPSMS:上行短信验证码
DOWNSMS:下行短信验证码
CAPTCHA:验证码(点选或滑动等)
SEQUENCE:语序验证(点选或输入)
SPATIAL:空间逻辑推理
FACE:人脸检测
DELAY:延时交易

其中,hits结果详情的内容如下:

返回结果参数名参数类型参数说明规范
descriptionstring当前事件的风险描述
modelstring规则标识
riskLevelstring当前事件的处置建议PASS:通过
REVIEW:审核
REJECT:拒绝
VERIFY:验证
verifyTypestring当处置建议为VERIFY时,返回verifyTypeUPSMS:上行短信验证码
DOWNSMS:下行短信验证码
CAPTCHA:验证码(点选或滑动等)
SEQUENCE:语序验证(点选或输入)
SPATIAL:空间逻辑推理
FACE:人脸检测
DELAY:延时交易

其中标签类返回字段

1)tokenProfileLabels的详情内容

返回结果参数名参数类型参数说明规范
label1string一级标签展示账号属性标签的一级标签。
label2string二级标签展示账号属性标签的二级标签。
label3string三级标签展示账号属性标签的三级标签。
descriptionstring风险描述展示账号属性标签的中文描述。
timestampint64最近一次命中策略的时间最近一次命中策略的时间
detailjson_object证据描述证据细节

2)tokenRiskLabels的详情内容

返回结果参数名参数类型参数说明规范
label1string一级标签展示账号风险标签的一级标签。
label2string二级标签展示账号风险标签的二级标签。
label3string三级标签展示账号风险标签的三级标签。
descriptionstring风险描述展示账号风险标签的中文描述。
timestampint64最近一次命中策略的时间最近一次命中策略的时间
detailjson_object证据描述证据细节

事件列表#

asdf

行业场景事件eventId规范
通用获利-拉新发起邀请invite参数详情
通用获利-拉新接受邀请fission参数详情
通用获利-例行签到签到signIn参数详情
通用获利-其他任务做任务task参数详情
通用获利-助力发起邀请invite参数详情
通用获利-助力助力help参数详情
通用通用反馈feedback参数详情
通用通用验证结果verify参数详情
通用通用短信通道保护sms参数详情
通用通用发券postCoupon参数详情
通用通用点击click参数详情
通用通用提交订单submitOrder参数详情
通用通用核保underwrite参数详情
通用通用平台奖励事件platformAward参数详情
通用获利-激励视频广告请求事件adGet参数详情
网赚获利-激励视频广告展示事件adShow参数详情
网赚获利-激励视频发放奖励事件adReward参数详情
网赚获利-激励视频广告点击事件adClick参数详情
网赚获利-激励视频广告消失事件adFinish参数详情
网赚获利-浏览阅读浏览browse参数详情
网赚获利-浏览阅读平台奖励platformAward参数详情
网赚获利-游戏打金玩家对环境pve参数详情
游戏获利-游戏打金玩家对玩家pvp参数详情
游戏获利-抽奖抽奖结果raffleResult参数详情
新零售获利-抢红包抢红包grabRedEnvelope参数详情
新零售获利-限时抢购(券)浏览browse参数详情
新零售获利-限时抢购(券)领券coupon参数详情
新零售获利-限时抢购(商品)浏览browse参数详情
新零售获利-限时抢购(商品)预约商品booking参数详情
新零售获利-限时抢购(商品)下实物订单order参数详情
新零售获利-限时抢购(商品)下虚拟订单virtualOrder参数详情
新零售获利-限时抢购(商品)下服务订单serviceOrder参数详情
新零售套利-会员权益(高端商店)下实物订单order参数详情
新零售套利-会员权益(高端商店)下虚拟订单virtualOrder参数详情
新零售套利-会员权益(高端商店)下服务订单serviceOrder参数详情
新零售套利-会员权益(高端商店)完成订单finishOrder参数详情
新零售套利-积分(兑换非实物)兑换exchange参数详情
新零售套利-积分(兑换实物)兑换exchange参数详情
新零售套利-积分(兑换实物)下实物订单order参数详情
新零售套利-积分(下单抵扣现金)下实物订单order参数详情
新零售套利-积分(下单抵扣现金)下虚拟订单virtualOrder参数详情
新零售套利-积分(下单抵扣现金)下服务订单serviceOrder参数详情
新零售套利-积分(下单抵扣现金)支付payment参数详情
新零售套利-积分(下单抵扣现金)完成订单finishOrder参数详情
新零售套利-礼品卡(购买)下虚拟订单virtualOrder参数详情
新零售套利-礼品卡(购买)完成订单finishOrder参数详情
新零售套利-礼品卡(领取)领券coupon参数详情
新零售套利-礼品卡(下单抵扣现金)下实物订单order参数详情
新零售套利-礼品卡(下单抵扣现金)下虚拟订单virtualOrder参数详情
新零售套利-礼品卡(下单抵扣现金)下服务订单serviceOrder参数详情
新零售套利-礼品卡(下单抵扣现金)完成订单finishOrder参数详情
新零售套利-现金发放到支付账号绑卡addCard参数详情
新零售套利-现金发放到支付账号发放奖励事件adReward参数详情
新零售套利-现金提现绑卡addCard参数详情
新零售套利-现金提现提现withdraw参数详情
新零售套利-优惠券(购买)下虚拟订单virtualOrder参数详情
新零售套利-优惠券(购买)完成订单finishOrder参数详情
新零售套利-优惠券(领取)领券coupon参数详情
新零售套利-优惠券(下单抵扣现金)下实物订单order参数详情
新零售套利-优惠券(下单抵扣现金)下虚拟订单virtualOrder参数详情
新零售套利-优惠券(下单抵扣现金)下服务订单serviceOrder参数详情
新零售套利-优惠券(下单抵扣现金)完成订单finishOrder参数详情
新零售套利-占库存下实物订单order参数详情
新零售套利-占库存下虚拟订单virtualOrder参数详情
新零售套利-占库存下服务订单serviceOrder参数详情
航司通用值机查询airlineCheckIn参数详情
航司套利-占库存预定航班bookFlight参数详情
航司套利-占库存下服务订单serviceOrder参数详情
航司套利-占库存完成订单finishOrder参数详情
航司套利-占库存取消订单cancelOrder参数详情
社交直播通用建立社交关系(匹配/加好友)friendReq参数详情
社交直播套利-直播道具(打赏)进入房间enterRoom参数详情
社交直播套利-直播道具(打赏)离开房间leaveRoom参数详情
社交直播套利-直播道具(打赏)提交表单submitForm参数详情
社交直播套利-直播道具(打赏)送礼gift参数详情
社交直播套利-直播道具(打赏)提现withdraw参数详情
社交直播套利-直播道具(1V1))提交表单submitForm参数详情
社交直播套利-直播道具(1V1))发起聊天startChat参数详情
社交直播套利-直播道具(1V1))结束聊天endChat参数详情
社交直播套利-直播道具(1V1))提现withdraw参数详情
社交直播套利-会员权益(无人健身房)获取二维码getQRcode参数详情
其他通用退款申请refundApply参数详情
新零售通用退款结果refundResult参数详情
新零售通用发货delivery参数详情
新零售通用修改订单updateOrder参数详情
新零售通用修改地址updateAddress参数详情
新零售通用加购物车addCart参数详情
新零售通用预约booking参数详情
新零售通用参与拼团joinGroup参数详情
新零售通用发起拼团createGroup参数详情
通用刷榜-店铺榜提交表单submitForm参数详情
通用刷榜-店铺榜浏览/观看/阅读browse参数详情
通用刷榜-店铺榜点赞like参数详情
通用刷榜-店铺榜关注follow参数详情
通用刷榜-店铺榜分享share参数详情
通用刷榜-内容榜提交表单submitForm参数详情
通用刷榜-内容榜浏览/观看/阅读browse参数详情
通用刷榜-内容榜浏览帖子browseTopic参数详情
通用刷榜-内容榜点赞like参数详情
通用刷榜-内容榜收藏collect参数详情
通用刷榜-内容榜分享share参数详情
通用刷榜-内容榜评论comment参数详情
通用刷榜-内容榜笔记点赞noteLike参数详情
通用刷榜-内容榜评论点赞commentLike参数详情
通用刷榜-商品榜提交表单submitForm参数详情
通用刷榜-商品榜浏览/观看/阅读browse参数详情
通用刷榜-商品榜收藏collect参数详情
通用刷榜-商品榜下实物订单order参数详情
通用刷榜-商品榜下虚拟订单virtualOrder参数详情
通用刷榜-商品榜下服务订单serviceOrder参数详情
通用刷榜-商品榜接受服务订单getServiceOrder参数详情
通用刷榜-商品榜完成订单finishOrder参数详情
通用刷榜-商品榜取消订单cancelOrder参数详情
通用刷榜-用户榜提交表单submitForm参数详情
通用刷榜-用户榜浏览/观看/阅读browse参数详情
通用刷榜-用户榜点赞like参数详情
通用刷榜-用户榜关注follow参数详情
通用刷榜-用户榜分享share参数详情
通用通用订阅subscribe参数详情
通用通用发帖note参数详情

事件详细API#

发起邀请 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
receiveTokenIdstring被邀请账号ID强烈建议被邀请账号ID唯一标识
getCouponint激励事件标注建议如果此次事件是行为激励的一种任务形式,传入1;否则传入0
nickNamestring发起邀请用户账户昵称建议
invitationCodeString用户邀请码强烈建议在页面展示出的用户邀请码,或在二维码、链接中隐含的邀请码
taskIdstring唯一标识拉新助力活动的ID强烈建议若有多个拉新助力活动同时进行,则用此id唯一标记当前参与的邀请活动
taskNamestring邀请任务名,表示当前具体邀请活动类型建议强烈可用于区分同时发生的多种邀请活动,例如:拉新赢红包、助力领券、助力砍价
requirementint当前邀请活动奖励所需最小参与账号数强烈建议若为阶梯式奖励(不同人数对应不同奖励规模)则传入最小奖励对应人数

接受邀请 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
inviteTokenIdstring邀请人的tokenId必传参数
subTokenIdstring账号的子账号强烈建议某些特殊的场景主账号有多个子账号(游戏场景不同区服)
nickNamestring被邀请用户账户昵称建议
groupIdstring拼团的团ID建议拼团、助力等场景下的团ID
invitationCodeString邀请用户的邀请码强烈建议接受邀请人填写的邀请码,或在二维码、链接中隐含的邀请码
requirementint当前拉新活动奖励所需最小参与账号数强烈建议若为阶梯式奖励(不同人数对应不同奖励规模)则传入最小奖励对应人数
taskIdstring唯一标识拉新活动的ID强烈建议若有多个裂变活动同时进行,则用此id唯一标记当前参与的裂变活动
taskNamestring事件名,表示当前具体拉新类型建议例如:拉新赢红包、拉新领券

签到 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
nickNamestring用户账户昵称建议
getCouponint激励事件标注建议如果此次事件是行为激励的一种任务形式,传入1;否则传入0

做任务 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
roleIdstring当前业务登录用户角色,游戏行业特殊字段强烈建议
subTokenIdstring账号的子账号强烈建议某些特殊的场景主账号有多个子账号(游戏场景不同区服)
taskIdstring任务ID强烈建议任务唯一标识
inviteTokenIdstring邀请人的tokenId强烈建议用在任务是由其他用户邀请做时传这个字段
invitationCodestring邀请用户的邀请码强烈建议接受邀请人填写的邀请码,或在二维码、链接中隐含的邀请码
getCouponint激励事件标注建议如果此次事件是行为激励的一种任务形式,传入1;否则传入0
eventNamestring事件名,表示当前事件类型下的具体事件建议例如:签到、玩游戏、记账、走路
taskCostTimeint64任务时长,以毫秒(ms)为单位的时间签到:0玩游戏:游戏时长记账:0走路:走路消耗时长建议
taskAmountint64任务内计数签到:留空玩游戏:留空记账:留空走路:走路步数建议
nickNamestring用户账户昵称建议
extrajson用户自定义数据或者数美要求传的特定数据如无必要,不传

助力 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
inviteTokenIdstring邀请人的tokenId必传参数
invitationCodeString邀请人的助力邀请码强烈建议助力人填写的邀请码,或在二维码、链接中隐含的邀请码
taskIdstring唯一标识助力活动的ID强烈建议若有多个助力活动同时进行,则用此id唯一标记当前参与的助力活动
groupIdstring用户参与拼团的拼团号强烈建议用户参与拼团的拼团号
taskNamestring事件名,表示当前具体助力类型建议例如:助力赢红包、助力领券、助力砍价
requirementint当前助力活动奖励所需最小参与账号数强烈建议若为阶梯式奖励(不同人数对应不同奖励规模)则传入最小奖励对应人数
getCouponint徒弟激励标注建议如果此次事件对当前账号发放激励,传入1;否则传入0
nickNamestring用户账户昵称建议
|

反馈 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
receiveTokenIdstring收到反馈的对象必传参数
eventNamestring事件类别必传参数可选值:
requestAgree:加好友的同意
requestRefuse:加好友的拒绝
requestNeglect:加好友的忽略
report:举报用户
blacklisting:拉黑用户
blocking:屏蔽用户
groupRequestAgree:加工会的同意
groupRequestRefuse:加工会的拒绝
groupNeglect:加工会的忽略
groupReport:工会举报用户
groupBlacklisting:工会拉黑用户
groupBlocking:工会屏蔽用户
roleIdstring当前业务登录用户角色,游戏行业特殊字段强烈建议
groupIdstring收到申请的工会/群的账号ID强烈建议在工会/群进行反馈时传入

验证结果 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
verifyResultint验证结果必传参数可选值:
2:取消
1:失败
0:成功
verifyTypestring二次验证方法强烈建议可选值:
SPATIAL:空间逻辑推理
SEQUENCE:语序选择验证
PASSWD_SMS:支付密码和短信验证
PASSWD:支付密码
DELAY:延时交易
CALLCENTER:人工坐席验证
FACE:人脸检测
CAPTCHA:验证码(点选或滑动等)
UPSMS:上行短信验证码
DOWNSMS:下行短信验证码
verifyEventstring被验证事件强烈建议可选值(被验证事件的eventId)
triggerReqIdstring触发当前处置事件的事件流水号必传

短信通道保护 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
textstring消息强烈建议

发券 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
couponTypestring当前业务领券的类型强烈建议如:满减券,打折券,免单券
guestIdstring当前业务中浏览的游客账户ID,当用户以游客身份进入时传入guestId强烈建议每个游客账号ID是唯一的,且与其它数美接口guestId保持一致性,长度限制在64个字符以内。
nickNamestring用户账户昵称建议
pricefloat64券的金额建议货币计量单位为中国大陆法定货币人民币(CNY),单位:元例如:88.69
getCouponint激励事件标注建议如果此次事件是行为激励的一种任务形式,传入1;否则传入0

点击 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
apputmstring渠道标识必传参数投放广告渠道,如巨量/腾讯等,传入渠道标识
clickIdstring点击id必传参数每次点击的唯一标识,可以传入点击回调参数中的点击id
useragentstring用户代理强烈建议
advertiserIdstring广告主id建议广告主账号id
campaignIdstring广告组id建议
adgroupIdstring广告计划id建议
creativeIdstring创意id建议
androidIdstring补充设备标识,安卓id建议android设备的唯一识别码
oaIdstring补充设备标识,oaid建议Android Q及更高版本的设备号,32位
macstring补充设备标识,mac地址,去掉:后的MD5值建议设备mac地址

提交订单 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
orderIdstring订单ID强烈建议该商品订单唯一标识(无正式生成订单及订单ID时需传入临时订单ID,需要保证与该事件返回 PASS 后order 事件正式生成订单的orderId 一致)
paymentMethodstring付款方式强烈建议可选值:
CASH_ON_DELIVERY:货到付款
ONLINE_PAYMENT:在线支付
intervalint64商品发布到下单时间,单位毫秒(ms)强烈建议主要用于商品秒杀
receiverPhonestring收货人手机号强烈建议中国大陆区手机号请填写11位数字例如:13800138000
receiverPhoneMd5string收货人手机号Md5值强烈建议MD5加密字符串格式为32位小写例如:d0213fde1643000949161dcb1ed0e605
activityIdstring活动ID建议营销活动的ID
pricefloat64下单优惠前的金额建议货币计量单位为中国大陆法定货币人民币(CNY),单位:元例如:88.69
discountfloat64该订单享受的优惠金额建议商品订单原价–商品订单实际支付的价格
nickNamestring用户账户昵称建议
groupIdstring拼团的团ID建议用户自定义唯一标识
discountTypestring优惠来源建议可选值:
NEW_USER:新用户优惠
REWARD_TASK:奖励任务优惠
PURCHASE:购买
receiverCountrystring收货人地址的国家建议国际域名缩写,若不存在传国家英文全称例如:CN
receiverProvincestring收货人地址的省建议中文例如:山东省
receiverCitystring收货人地址的市建议中文例如:北京市
receiverDistrictstring收货人地址的区建议中文例如:朝阳区
receiverAddressstring收货人地址的详细地址建议中文
deliverTypestring配送方式建议可选值:SELF_PICKUP:自提
EXPRESS:快递
groupOwnerIdString用户参与拼团的发起人的账号Id建议用户参与拼团的发起人的唯一标识

核保 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
apputmstring渠道标识必传参数投放广告渠道,如巨量/腾讯等,传入渠道标识
isFirstInsureint该手机号是否首次投保必传参数可选值:0,1若该手机号首次投保,则传入1,否则传入0.
insurantstring被保人必传参数可选值:self,spouse,parent,child若为自己投保,则传入self
若为配偶投保,则传入spouse
若为父母投保,则传入parent
若为子女投保,则传入child.
insurantPhonestring被保人的手机号或者该手机号MD5加密字符串强烈建议中国大陆区手机号请填写11位数字例如:13800138000MD5加密字符串格式为32位小写
prcidstring身份证ID建议将用户输入的身份证ID以md5加密,身份证ID为以下内容之一:身份证号码;港澳居民身份证号码;台湾居民身份证号码;护照号码;
insurantPrcidstring被保人身份证ID建议将用户输入的身份证ID以md5加密,身份证ID为以下内容之一:身份证号码;港澳居民身份证号码;台湾居民身份证号码;护照号码;
taskIdstring活动阶段Id强烈建议活动阶段唯一标识

平台奖励 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
tokenIdstring当前行为的用户账号强烈建议用户账号ID,每个用户账号ID是唯一的,且与其它数美接口tokenId保持一致性
taskIdstring唯一标识拉新助力活动的ID强烈建议若有多个拉新助力活动同时进行,则用此id唯一标记当前参与的邀请活动
amountfloat当前奖励的金额强烈建议本次奖励下发的金额,单位人民币
比如下发1000金币,价值0.1元,传入0.1

下载#

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
getCouponint激励事件标注强烈建议如果此次事件是行为激励的一种任务形式,传入1;否则传入0
contentIdstring下载内容的ID强烈建议
nickNamestring用户账户昵称建议
pricefloat64下载使用金额(币等)建议
intervalint64内容发布到点击下载时间间隔,单位毫秒(ms)建议“抢任务”场景必选;其他场景不必选

广告请求事件 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
adTypestring广告类型必传字段可选值:
NATIVE_AD:信息流广告;
BANNER_AD:banner广告;
SPLASH_AD:开屏广告;
INTERSTITIAL_IMAGE_AD:插屏广告;
REWARDED_VIDEO_AD :激励视频广告;
INTERSTITIAL_VIDEO_AD:全屏视频广告;
VERTICAL_DRAW_VIDEO_AD:draw信息流;
NEW_INTERSTITIAL_AD:新插屏广告
codeIdstring广告代码位ID必传字段客户在广告平台后台创建的代码位ID
adIdstring广告ID强烈建议用于标记一个广告生命周期的唯一标识,在同一广告生命周期中,广告请求事件、广告展示事件、广告消失事件、广告点击事件以及发放奖励事件的adId应一致。

广告展示事件 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
adTypestring广告类型必传字段可选值:
NATIVE_AD:信息流广告;
BANNER_AD:banner广告;
SPLASH_AD:开屏广告;
INTERSTITIAL_IMAGE_AD:插屏广告;
REWARDED_VIDEO_AD :激励视频广告;
INTERSTITIAL_VIDEO_AD:全屏视频广告;
VERTICAL_DRAW_VIDEO_AD:draw信息流;
NEW_INTERSTITIAL_AD:新插屏广告
codeIdstring广告代码位ID必传字段客户在广告平台后台创建的代码位ID
adIdstring广告ID强烈建议用于标记一个广告生命周期的唯一标识,在同一广告生命周期中,广告请求事件、广告展示事件、广告消失事件、广告点击事件以及发放奖励事件的adId应一致。

发放奖励事件 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
adTypestring广告类型必传字段可选值:
NATIVE_AD:信息流广告;
BANNER_AD:banner广告;
SPLASH_AD:开屏广告;
INTERSTITIAL_IMAGE_AD:插屏广告;
REWARDED_VIDEO_AD :激励视频广告;
INTERSTITIAL_VIDEO_AD:全屏视频广告;
VERTICAL_DRAW_VIDEO_AD:draw信息流;
NEW_INTERSTITIAL_AD:新插屏广告
codeIdstring广告代码位ID必传字段客户在广告平台后台创建的代码位ID
adIdstring广告ID强烈建议用于标记一个广告生命周期的唯一标识,在同一广告生命周期中,广告请求事件、广告展示事件、广告消失事件、广告点击事件以及发放奖励事件的adId应一致。
rewardAmountdouble奖励金额必填字段激励金额(单位为:人民币)
taskIdstring活动唯一标识必填字段用户观看广告的活动入口ID,例如:签到活动,道具领取活动等;

广告点击事件 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
adTypestring广告类型必传字段可选值:
NATIVE_AD:信息流广告;
BANNER_AD:banner广告;
SPLASH_AD:开屏广告;
INTERSTITIAL_IMAGE_AD:插屏广告;
REWARDED_VIDEO_AD :激励视频广告;
INTERSTITIAL_VIDEO_AD:全屏视频广告;
VERTICAL_DRAW_VIDEO_AD:draw信息流;
NEW_INTERSTITIAL_AD:新插屏广告
codeIdstring广告代码位ID必传字段客户在广告平台后台创建的代码位ID
adIdstring广告ID强烈建议用于标记一个广告生命周期的唯一标识,在同一广告生命周期中,广告请求事件、广告展示事件、广告消失事件、广告点击事件以及发放奖励事件的adId应一致。

广告消失事件 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
adTypestring广告类型必传字段可选值:
NATIVE_AD:信息流广告;
BANNER_AD:banner广告;
SPLASH_AD:开屏广告;
INTERSTITIAL_IMAGE_AD:插屏广告;
REWARDED_VIDEO_AD :激励视频广告;
INTERSTITIAL_VIDEO_AD:全屏视频广告;
VERTICAL_DRAW_VIDEO_AD:draw信息流;
NEW_INTERSTITIAL_AD:新插屏广告
codeIdstring广告代码位ID必传字段客户在广告平台后台创建的代码位ID
adIdstring广告ID强烈建议用于标记一个广告生命周期的唯一标识,在同一广告生命周期中,广告请求事件、广告展示事件、广告消失事件、广告点击事件以及发放奖励事件的adId应一致。
adFinishTypestring广告消失方式必填字段广告消失方式可选值:
CLICK_CLOSE_BUTTON:关闭按钮消失;
COMPLETE_AD:播放完成;
SKIP_AD:跳过广告;
QUIT_APP:退出app;
SHOW_AD_ERROR:广告播放异常

浏览 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
guestIdstring当前业务中浏览的游客账户ID,当用户以游客身份进入时传入guestId强烈建议每个游客账号ID是唯一的,且与其它数美接口guestId保持一致性,长度限制在64个字符以内。
referIdstring前一个内容或页面ID,可以是URI强烈建议
contentOwnerIdstring被浏览内容的拥有者账号ID强烈建议平台自己发布的内容传空字符串
productIdstring商品ID强烈建议浏览商品详情页是传入
productTypestring商品类别强烈建议浏览商品详情页是传入
商品的分类,例如:手机、电脑配件、化妆品、电脑笔记本等
productNamestring商品名称强烈建议浏览商品详情页是传入
productBrandstring商品品牌强烈建议浏览商品详情页是传入
productPricefloat商品单价强烈建议浏览商品详情页是传入
currencystring计价货币强烈建议浏览商品详情页是传入
参考货币代码表(ISO4217)
referTypestring前一个页面类型强烈建议可选值:首页、商品分类页,详情页,列表页
searchKeyWordsstring搜索关键词建议适用于通过搜索进入页面
browseLengthint64本次浏览时长,单位为毫秒(ms)建议适用电商场景
nickNamestring用户账户昵称建议
eventNamestring浏览页面的类型建议例如:首页、关注页、搜索页、推荐页等
contentIdstring内容或页面id,可以是URI建议当前页面Id,需要去掉可变参数
contentTypestring视频、文章、书籍小说建议可选值:video:视频
article:文章
book:书籍ad:广告
contentLengthint64内容长度:
1.对于视频,是以ms为单位的时间;
2.对于文章,为空
3.对于小说,以字为单位的字数
建议
watchLengthint64本次观看时长,单位为毫秒(ms)建议
inviteTokenIdstring分享或邀请人的的tokenId建议
getCouponint激励事件标注建议如果此次事件是行为激励的一种任务形式,传入1;否则传入0

玩家对环境 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
mapIdstring地图Id选填
roleLevelstring角色等级强力建议
raceIdstring战斗Id强力建议
raceDurationstring战斗时长强力建议
raceResultstring战斗结果强力建议适用于对抗、通关类游戏
可选值win,lose,tie
raceBetAmountfloat战斗赌注数量强力建议游戏赌注或标的的数量
raceBetCurrencystring战斗赌注类型强力建议游戏赌注或标的类型,如果是虚拟货币或者道具,转换成相应人民币、美元等参考货币代码表(ISO4217)
heroIdListstring英雄列表选填
channelNamestring区服选填

玩家对玩家 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
mapIdstring地图Id选填
roleLevelstring角色等级强力建议
raceIdstring战斗Id强力建议
raceDurationstring战斗时长强力建议
raceResultstring战斗结果强力建议适用于对抗、通关类游戏
可选值win,lose,tie
raceBetAmountfloat战斗赌注数量强力建议游戏赌注或标的的数量
raceBetCurrencystring战斗赌注类型强力建议游戏赌注或标的类型,如果是虚拟货币或者道具,转换成相应人民币、美元等参考货币代码表(ISO4217)
heroIdListstring英雄列表选填
channelNamestring区服选填

抽奖结果 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
taskIdstring任务ID必传参数任务唯一标识
resultint抽奖结果强烈建议1:中奖0:未中奖

抢红包 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
currencystring货币强烈建议参考货币代码表(ISO4217)
nickNamestring用户账户昵称建议
pricefloat64红包的金额建议货币计量单位为中国大陆法定货币人民币(CNY),单位:元例如:88.69
redEnvelopeTypestring当前业务抢红包的类型建议如:抢口令红包,抢随机红包,抢等额红包等

领券 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
couponTypestring当前业务领券的类型强烈建议如:满减券,打折券,免单券
nickNamestring用户账户昵称建议
pricefloat64券的金额建议货币计量单位为中国大陆法定货币人民币(CNY),单位:元例如:88.69
couponSourcestring当前业务领券的来源强烈建议传中文即可,具体值为:“平台券”,“商户券”
activityIdstring活动ID建议营销活动的ID
currencystring计价货币建议
couponsjson array券信息强烈建议

预约商品 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
productsjson array订单商品信息,详情见下文必传参数

products 中的字段

参数名称类型参数说明是否必传规范
productIdstring商品ID,SPU 标准化产品单元必传参数传sku id
productCountint商品数量必传参数
merchantIdstring商户ID必传参数传商户编号

下服务订单 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
orderIdstring订单ID必传参数
productsjson array订单服务信息,详情见下文强烈建议
intervalint64服务商品发布到下服务订单时间,单位毫秒(ms)强烈建议
serviceTokenIdstring提供服务的账号ID强烈建议
pricefloat64下单优惠前的金额建议货币计量单位为中国大陆法定货币人民币(CNY,单位:元例如:88.69
discountfloat64该订单享受的优惠金额建议商品订单原价–商品订单实际付款的价格
discountTypestring优惠来源建议可选值:
NEW_USER:新用户优惠
REWARD_TASK:奖励任务优惠
PURCHASE:用户购买
serviceNamestring服务商品名称建议例如:专车、拼车、出租车、送外卖、送咖啡等
currencystring计价货币建议价值的单位:人民币,美元,金币,智慧币等

products的内容如下:

参数名称类型参数说明是否必传规范
productIdstring商品ID,SPU标准化产品单元必传参数
productCountint商品数量必传参数
merchantIdstring商户ID必传参数若无法区分第三方(自营)传特定值“自营”
senderCountrystring发货人地址的国家建议国际域名缩写,若不存在传国家英文全称例如:CN
senderProvincestring发货人地址的省建议中文例如:山东省
senderCitystring发货人地址的市建议中文例如:北京市
senderDistrictstring发货人地址的区建议中文例如:朝阳区
senderAddressstring发货人地址的详细地址建议中文例如:望京诚盈中心1号楼3A或北京市朝阳区望京诚盈中心1号楼3A

下实物订单 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
productsjson array订单商品信息,详情见下文必传参数
orderIdstring订单ID强烈建议该商品订单唯一标识
paymentIdstring付款ID强烈建议用户进行一次下单付款动作的标识;该标识标记了用户发起的一次下单付款行为。
orderNotesstring订单备注信息建议用户在此订单上备注的信息
paymentMethodstring付款方式强烈建议可选值:
CASH_ON_DELIVERY:货到付款
ONLINE_PAYMENT:在线支付
intervalint64商品发布到下单时间,单位毫秒(ms)强烈建议主要用于商品秒杀
phonestring用户下单使用的手机号或者该手机号MD5加密字符串强烈建议中国大陆区手机号请填写11位数字例如:13800138000MD5加密字符串格式为32位小写
receiverPhonestring收货人手机号强烈建议中国大陆区手机号请填写11位数字例如:13800138000
receiverPhoneMd5string收货人手机号Md5值强烈建议MD5加密字符串格式为32位小写例如:d0213fde1643000949161dcb1ed0e605
countryCodestring手机用户的国家代码强烈建议中国大陆区手机号填写0086非中国大陆区手机号填写国家代码例如:美国填写0001、安道尔0376、巴哈马1242
shippingFeefloat64物流/快递费用强烈建议例如:0.00, 6.00
currencystring货币强烈建议参考货币代码表(ISO4217)
activityIdstring活动ID建议营销活动的ID
pricefloat64下单优惠前的金额建议货币计量单位为中国大陆法定货币人民币(CNY),单位:元例如:88.69
discountfloat64该订单享受的优惠金额建议商品订单原价–商品订单实际支付的价格
nickNamestring用户账户昵称建议
groupIdstring拼团的团ID建议用户自定义唯一标识
discountTypestring优惠来源建议可选值:
NEW_USER:新用户优惠
REWARD_TASK:奖励任务优惠
PURCHASE:购买
receiverCountrystring收货人地址的国家建议国际域名缩写,若不存在传国家英文全称例如:CN
receiverProvincestring收货人地址的省建议中文例如:山东省
receiverCitystring收货人地址的市建议中文例如:北京市
receiverDistrictstring收货人地址的区建议中文例如:朝阳区
receiverAddressstring收货人地址的详细地址建议中文
deliverTypestring配送方式建议可选值:SELF_PICKUP:自提
EXPRESS:快递
groupOwnerIdString用户参与拼团的发起人的账号Id建议用户参与拼团的发起人的唯一标识
shopIdstring门店编号建议
shopCountrystring门店(自提点)归属国家建议用于社区团购场景若不存在传国家英文全称,如:CN
shopProvincestring门店(自提点)归属省建议中文如:山东省
shopCitystring门店(自提点)归属市建议中文如:北京市
shopDistrictstring门店(自提点)归属区建议中文如:朝阳区
shopAddressstring门店(自提点)详细地址建议
discountsjson array券信息强烈建议例如:
[{"type":"券","id":"xxx","activityId":"xxx", "amount":5.00},{"type":"下单立减","id":"","activityId":"xxx", "amount":10.00},{"type":"积分","id":"","activityId":"xxx", "amount":2.50}]

products的内容如下:

参数名称类型参数说明是否必传规范
productIdstring商品ID,SPU标准化产品单元必传参数
productCountint商品数量必传参数
productTypestring商品类型建议用于需要特殊处理的商品,根据需要传入即可,具体值可参考为:“贵金属”
merchantIdstring商户ID必传参数若无法区分第三方(自营)传特定值“自营”
senderCountrystring发货人地址的国家建议国际域名缩写,若不存在传国家英文全称例如:CN
senderProvincestring发货人地址的省建议中文例如:山东省
senderCitystring发货人地址的市建议中文例如:北京市
senderDistrictstring发货人地址的区建议中文例如:朝阳区
senderAddressstring发货人地址的详细地址建议中文例如:望京诚盈中心1号楼3A或北京市朝阳区望京诚盈中心1号楼3A
productBrandstring商品品牌建议productBrand
productNamestring商品名称建议productName
productPricefloat商品价格建议productPrice
currencystring计价货币建议currency

discounts的内容如下:

参数名称类型参数说明是否必传规范
typestring券类型强烈建议
idstring券ID强烈建议标记优惠的唯一ID
activityIdstring券对应的活动ID强烈建议营销活动的ID
amountfloat券金额强烈建议

兑换 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
productstring虚拟商品名称必传参数例如:金币、道具、会员等机票(航班号+“-”+日期,CA288-20180101)
orderIdstring订单ID强烈建议该商品订单唯一标识
intervalint64商品发布到下单时间,单位毫秒(ms)强烈建议主要用于商品秒杀
phoneMd5string用户下单使用的手机号或者该手机号MD5加密字符串强烈建议中国大陆区手机号请填写11位数字例如:13800138000MD5加密字符串格式为32位小写
pricefloat64下单总金额(优惠前)强烈建议货币计量单位为中国大陆法定货币人民币(CNY),单位:元例如:88.69
discountfloat64该订单享受的优惠金额强烈建议商品订单原价–商品订单实际支付的价格
accountfloat64兑换商品后账户余额强烈建议使用金币、Q币等兑换虚拟商品后的账户余额(减少),单位:元,例如:10.5
discountTypestring优惠来源建议可选值:
NEW_USER:新用户优惠
REWARD_TASK:奖励任务优惠
PURCHASE:购买
currencystring货币强烈建议参考货币代码表(ISO4217)
productsJson_array订单商品信息,详情见下文强烈建议

products的内容如下:

参数名称类型参数说明是否必传规范
productIdstring商品ID,SPU标准化产品单元必传参数
productCountint商品数量必传参数
productTypestring商品类型建议用于需要特殊处理的商品,根据需要传入即可,具体值可参考为:“贵金属”
merchantIdstring商户ID必传参数若无法区分第三方(自营)传特定值“自营”
senderCountrystring发货人地址的国家建议国际域名缩写,若不存在传国家英文全称例如:CN
senderProvincestring发货人地址的省建议中文例如:山东省
senderCitystring发货人地址的市建议中文例如:北京市
senderDistrictstring发货人地址的区建议中文例如:朝阳区
senderAddressstring发货人地址的详细地址建议中文例如:望京诚盈中心1号楼3A或北京市朝阳区望京诚盈中心1号楼3A
productBrandstring商品品牌建议productBrand
productNamestring商品名称建议productName
productPricefloat商品价格建议productPrice
currencystring计价货币建议currency

支付 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
methodstring支付方式强烈建议可选值:
qrscan:二维码支付,主动扫码
qrshow:二维码支付,被动扫码(展示付款码给别人)
phone:手机Pay支付
widget:控件支付
wechatQr: 微信扫码支付
aliPay: 支付宝扫码/登录付款
debitCard:借记卡支付
creditCard:信用卡支付
huaweiPay:华为钱包支付
currencystring计价货币强烈建议参考货币代码表(ISO4217)
channelstring支付渠道强烈建议
cvvResultCodestringcvv验证结果强烈建议参考http://www.emsecommerce.net/avs_cvv2_response_codes.htm
avsResultCodestring地址验证结果强烈建议参考http://www.emsecommerce.net/avs_cvv2_response_codes.htm
cardBinstring卡bin,银行卡前六位强烈建议
bankCardstring支付银行卡号强烈建议当支付方式为借记卡支付或信用卡支付时传入该字段
XXXX-XXXX-XXXX-4242, 除后四位外,其余可用X代替
orderIdstring订单编号强烈建议当前支付的订单编号
bankCardPhonestring银行卡绑定的手机号强烈建议当支付方式为借记卡支付或信用卡支付时传入该字段
prcidstring银行卡所属人身份证号码的MD5强烈建议
merchantTypestring收款商户类型强烈建议可选值为:
1. normal: “普通商户”,商户资质要求较高,商户需要三证一表注册入网;
2. micro:“小微商户”,商户不需要提供三证一表,提供普通身份信息注册商户;
3. individual:“个人转账”,对收款方没有任何限制
4. platform:“平台自身”

绑卡 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
simVrfyRststring本机号校验结果必传参数取值:0: 不一致;1: 一致2: 本机号校验开关关闭 3: Token未取到 4: 设备指纹超时 5: 该用户手机号无法验证,包含境外手机号或取不到手机号的情况。若设备指纹后台本机号校验并落地接口中respCD返回其他非0000的应答码,直接通过此字段透传给数美
phonestring用户注册使用的手机号必传参数
bankCardstring银行卡号必传参数
bankCardPhonestring银行卡绑定的手机号必传参数
simTypestringsim卡所属运营商强烈建议0-移动;1 -电信 2-联通当tokenStatus为000000时,type字段取值在上述0、1、2之间,其他情况type只能取9
deviceFPstring设备指纹id建议该字段由客户自行采集,用于跨数据源的数据关联等
cardTypestring银行卡类型强烈建议可选值:debit:借记卡credit:信用卡(贷记卡)combine:借贷合一semicredit:准贷记卡prepaid:预付卡
accountTypestring账户类型强烈建议可选值:I:一类户,英文字母III:二类户,两个英文字母IIII:三类户,三个英文字母I
pidTypestring银行卡所属人证件类型必传参数可选值:
prc:身份证
milc:军官证
passport:护照
hrc:回乡证
mtp:台胞证
polc:警官证
solc:士兵证
other:其它(境外)
pidstring银行卡所属人证件号码必传参数
validint四要素、公安部等标准验证是否都成功。必传参数可选值:1:成功0:失败,任意标准验证失败
elemsValidint四/五要素验证是否成功。有4/5要素验证时传入,没有不传。强烈建议可选值:1:成功0:失败
smsValidint银行预留手机号短信验证是否成功。有预留手机号短信验证时传入,没有时不传。强烈建议可选值:1:成功0:失败
prcidValidint公安部验证是否成功。有公安部验证时传入,没有时不传强烈建议可选址:1:成功0:失败
countryCoderesString预留手机号区号强烈建议传入当前绑卡交易的预留手机号区号

提现 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
withdrawAmountfloat64提现金额必传参数货币计量单位为中国大陆法定货币人民币(CNY),单位:元例如:88.69
withdrawAccountIdstring提现账户ID必传参数例如:支付宝账户ID
withdrawPhonestring提现时使用的手机号或者该手机号MD5加密字符串强烈建议中国大陆区手机号请填写11位数字例如:13800138000MD5加密字符串格式为32位小写
phoneMd5string用户取消订单的手机号或者该手机号MD5加密字符串强烈建议中国大陆区手机号请填写11位数字例如:13800138000MD5加密字符串格式为32位小写
withdrawAccountTypestring提现账户类型,银行卡/微信/支付宝强烈建议可选值:bank:银行卡
weixin:微信
alipay:支付宝others:自由支付渠道
currencystring货币强烈建议参考货币代码表(ISO4217)

值机查询 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
guestIdstring当前业务中值机查询的游客账户ID,当用户以游客身份进入时传入guestId强烈建议每个游客账号ID是唯一的,且与其它数美接口guestId保持一致性,长度限制在64个字符以内。
namestring参数的名称强烈建议查询输入的乘机人姓名
prcidstring参数的内容强烈建议查询输入的证件号,为以下内容之一:身份证号码;港澳居民身份证号码;台湾居民身份证号码;护照号码;其他证件号码;票号
referIdstring前一个内容或页面ID,可以是URI强烈建议

预定航班 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
orderIdstring订单ID必传参数该机票订单唯一标识
startDatestring参数的内容强烈建议去程日期的值,格式类似:2019-01-01
endDatestring参数的内容强烈建议返程日期的值,格式类似:2019-01-01
startCitystring参数的内容强烈建议出发城市的名称或缩写
endCitystring参数的内容强烈建议到达城市的名称或缩写
flightNumstring航班号必传字段例:9C3300IJ123,如果是中转联程或往返,把2段都写上,用
branchIdstring航空公司分支Id强烈建议直接使用航司代码,如9C、IJ、IB,如果是联程,2段不一样的,用
airlineIdstring航线Id强烈建议航线的机场三字码,如上海浦东机场-重庆江北机场,填:PVGCKG,若为中转联程或往返,把2段都写上,用
productsjson array订单信息,详情见下文强烈建议
startGpsLocationjson object订单页面填写的服务开始gps的位置信息,详情见下文强烈建议详见下文startGpsLocation的内容
endGpsLocationjson object订单页面填写的服务结束gps的位置信息,详情见下文强烈建议详见下文endGpsLocation的内容
intervalint64机票发布到下服务订单时间,单位毫秒(ms)强烈建议
contactNamestring联系人姓名,可加密处理,保证一对一映射即可强烈建议
contactPhonestring联系人使用的手机号或者该手机号MD5加密字符串强烈建议中国大陆区手机号请填写11位数字例如:13800138000MD5加密字符串格式为32位小写
contactCountryCodestring联系人手机的国家代码,4位数字表示强烈建议中国大陆区手机号填写0086非中国大陆区手机号填写国家代码例如:美国填写0001、安道尔0376、巴哈马1242
contactEmailstring联系人邮箱强烈建议
contactEmailSuffixstring联系人邮箱后缀强烈建议
currencystring货币强烈建议参考货币代码表(ISO4217)
pricedouble下单优惠前的金额建议货币计量单位为中国大陆法定货币人民币(CNY,单位:元例如:88.69
discountdouble该订单享受的优惠金额必传参数商品订单原价–商品订单实际付款的价格
discountTypestring优惠来源必传参数如: MEMBERSHIP:绿翼会员立减(长期)FAMILY:亲友立减(长期)ACTIVITY:机票活动立减(短期,主要是中转联程立减)
orderNumint机票数量强烈建议

products的内容如下:

参数名称类型参数说明是否必传规范
namestring乘坐人姓名,可加密处理,保证一对一映射即可强烈建议如果使用此字段,需要将本接口切换成HTTPS加密传输
phonestring手机号强烈建议
countryCodestring手机用户的国家代码强烈建议中国大陆区手机号填写0086非中国大陆区手机号填写国家代码例如:美国填写0001、安道尔0376、巴哈马1242
levelint用户等级,针对不同等级的用户可配置不同拦截策略强烈建议可选值:0,1,2,3,4分别对应:
0:最低级用户,典型如新注册、完全不活跃或等级为0的用户等
1:较低级用户,典型如低活跃或低等级用户等
2:中等级用户,典型如具备一定活跃或等级中等的用户等
3:较高级用户,典型如高活跃或高等级用户等4:最高级用户,典型如付费用户、VIP用户、可考虑放过的用户等
pidTypestring银行卡所属人证件类型必传参数可选值:
prc:身份证
milc:军官证
passport:护照
hrc:回乡证
mtp:台胞证
polc:警官证
solc:士兵证
other:其它(境外)
pidstring乘坐人证件Id,可加密处理,保证一对一映射即可强烈建议
pidCountrystring乘坐人证件颁发国家强烈建议例如:中国
pidCitystring身份ID归属城市强烈建议例如:北京
sexstring乘坐人性别强烈建议例如:男、女

startGpsLocation的内容如下:

参数名称类型参数说明是否必传规范
startCountrystring订单页面填写的服务开始地所属的国家强烈建议
startProvincestring订单页面填写的服务开始地所属的省份(格式:不填“省”,例如填写“广东”)强烈建议
startCitystring订单页面填写的服务开始地所属的城市(格式:不填“市”,例如填写“广州”)强烈建议

endGpsLocation的内容如下:

参数名称类型参数说明是否必传规范
endCountrystring订单页面填写的服务结束地所属的国家强烈建议
endProvincestring订单页面填写的服务结束地所属的省份(格式:不填“省”,例如填写“广东”)强烈建议
endCitystring订单页面填写的服务结束地所属的城市(格式:不填“市”,例如填写“广州”)强烈建议

取消订单 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
orderIdstring订单ID强烈建议该商品订单唯一标识
intervalint64下订单到取消时间,单位毫秒(ms)强烈建议主要用于商品秒杀
nickNamestring用户账户昵称建议

建立社交关系(匹配/加好友) #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
roleIdstring当前业务登录用户角色,游戏行业特殊字段强烈建议
eventNamestring区分申请类型强烈建议不传默认为好友申请可选值:好友申请、工会申请
channelstring好友请求发送的渠道(方式)强烈建议可选值:undesignation:无指定designation:有指定
receiveTokenIdstring仅用于好友请求事件,好友请求的目标账号ID强烈建议在进行好友申请时传入
groupIdstring仅用于工会请求事件,工会/群请求的目标账号ID强烈建议在进行工会/群申请时传入
textstring加好友附言建议

进入房间 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
roomIdString房间号必传字段用户进入的房间号
enterFromstring进入房间来源强烈建议从哪个页面进入直播间,可选值:搜索结果,推荐页面,自动浏览,其他

离开房间 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求

提交表单 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
eventNamestring事件名,表示当前事件类型下的具体事件必传参数传入“搜索”
fieldName1string参数的名称必传字段表单中第一个参数的名称
fieldValue1string参数的内容必传字段表单中第一个参数的内容
guestIdstring当前业务中提交表单的游客账户ID,当用户以游客身份进入时传入guestId强烈建议每个游客账号ID是唯一的,且与其它数美接口guestId保持一致性,长度限制在64个字符以内。
fieldName2string参数的名称建议表单中第二个参数的名称,若表单中为必传,则此处必传,否则根据影响系数决定是否传入
fieldValue2string参数的内容建议表单中第二个参数的内容,若表单中为必传,则此处必传,否则根据影响系数决定是否传入
fieldName3string参数的名称建议表单中第三个参数的名称,若表单中为必传,则此处必传,否则根据影响系数决定是否传入
fieldValue3string参数的内容建议表单中第三个参数的内容,若表单中为必传,则此处必传,否则根据影响系数决定是否传入
fieldName4string参数的名称建议表单中第四个参数的名称,若表单中为必传,则此处必传,否则根据影响系数决定是否传入
fieldValue4string参数的内容建议表单中第四个参数的内容,若表单中为必传,则此处必传,否则根据影响系数决定是否传入
fieldName5string参数的名称建议表单中第五个参数的名称,若表单中为必传,则此处必传,否则根据影响系数决定是否传入
fieldValue5string参数的内容建议表单中第五个参数的内容,若表单中为必传,则此处必传,否则根据影响系数决定是否传入
fieldName6string参数的名称建议表单中第六个参数的名称,若表单中为必传,则此处必传,否则根据影响系数决定是否传入
fieldValue6string参数的内容建议表单中第六个参数的内容,若表单中为必传,则此处必传,否则根据影响系数决定是否传入
fieldName7string参数的名称建议表单中第七个参数的名称,若表单中为必传,则此处必传,否则根据影响系数决定是否传入
fieldValue7string参数的内容建议表单中第七个参数的内容,若表单中为必传,则此处必传,否则根据影响系数决定是否传入
fieldName8string参数的名称建议表单中第八个参数的名称,若表单中为必传,则此处必传,否则根据影响系数决定是否传入
fieldValue8string参数的内容建议表单中第八个参数的内容,若表单中为必传,则此处必传,否则根据影响系数决定是否传入
fieldName9string参数的名称建议表单中第九个参数的名称,若表单中为必传,则此处必传,否则根据影响系数决定是否传入
fieldValue9string参数的内容建议表单中第九个参数的内容,若表单中为必传,则此处必传,否则根据影响系数决定是否传入
fieldName10string参数的名称建议表单中第十个参数的名称,若表单中为必传,则此处必传,否则根据影响系数决定是否传入
fieldValue10string参数的内容建议表单中第十个参数的内容,若表单中为必传,则此处必传,否则根据影响系数决定是否传入
fieldsarray优先使用fieldName1-10和fieldValue1-10传入表单的数据,若需再增加表单内容,则使用此字段添加建议详见《fields结果详情表》
referIdstring前一个内容或页面ID,可以是URI强烈建议

其中fields的内容如下:

请求参数名类型参数说明传入说明备注传入值1传入值2传入值...
fieldNamestring表单中参数的名必传字段用于接收表单内容的参数名如firstName如age参数N。。。
fieldValuestring表单参数的值必传参数用于接受表单内容的参数值如Jack如18参数值n。。。

送礼 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
receiveTokenIdstring收礼物的账号ID必传参数
amountfloat64礼物现金价值必传参数货币计量单位为中国大陆法定货币人民币(CNY),单位:元例如:88.69
currencystring货币强烈建议参考货币代码表(ISO4217)
depositCoinfloat64账户剩余虚拟货币价值建议货币计量单位为中国大陆法定货币人民币(CNY),单位:元例如:88.69
nickNamestring用户账户昵称建议
receiveTokenIdLevelstring表演者账户等级建议
roomIdstring房间ID建议
roomMemberCountint房间人数(人)建议
roomShowOpenTimestampInt64房间开始直播时间戳(毫秒)建议

发起聊天 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求

结束聊天 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求

获取二维码 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求

退款申请 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
orderIdstring订单ID必传参数原下单事件所传订单ID
orderAmountfloat原订单金额强烈建议所退订单的实际金额
refundTypeint退款类型强烈建议退款的类型,可选值:
0:部分退
1:全退
refundReasonint退款原因必传参数可选值:
1:信息填写错误,如地址,收货人
2:选错商品或数量错误
2:商品降价
3:未使用优惠券
4:商品无货
5:物流时间问题
6:货物破损
7:未收到货
8:质量问题
9:不符预期
10:不想要了
refundProcessint退款阶段必传参数可选值:
1:未发货
2:已发货物流中
3:货物已签收
4:无物流虚拟商品
5:其他
refundProductsjson array订单商品信息,详情见下文必传参数
refundAmountfloat退款金额必传参数
productTypestring商品类别必传参数商品的分类,例如:手机、电脑配件、化妆品、电脑笔记本等
currencystring货币强烈建议参考货币代码表(ISO4217)

refundProducts内容如下:

参数名称类型参数说明是否必传规范
productIdstring商品ID必传参数
productCountint商品数量必传参数
productTypestring商品类型建议商品的分类,例如:手机、电脑配件、化妆品、电脑笔记本等

退款结果 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
orderIdstring订单ID必传
resultint退款结果必传可选值:
0:退款成功
1:退款失败
2:取消退款
reasonstring结果理由选填如:超过退款期限

发货 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
orderIdstring订单ID必传
trackingNumstring快递编号必传
trackingCompanystring快递公司必传
deliveryTimeint64发货时间,时间戳格式,单位毫秒(ms)必传
deliveryCountrystring收货人地址的国家选填国际域名缩写,若不存在传国家英文全称
deliveryProvincestring收货人地址的省选填
deliveryCitystring收货人地址的市选填
deliveryDistrictstring收货人地址的区选填
deliveryAddressstring收货人地址的详细地址选填

修改订单 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
orderIdstring被修改的订单ID必传参数
isPaidint是否已经支付必传参数可选值:
0:未支付
1:已支付
updatedReceiveInfoJson_object修改后的收货信息强烈建议如果发生了,地址修改,传入修改后的收货信息

updatedAddress内容如下,只需要传入修改过的项即可

参数名称类型参数说明是否必传规范
receiverCountrystring收货人地址的国家修改后必传国际域名缩写,若不存在传国家英文全称
receiverProvincestring收货人地址的省修改后必传
receiverCitystring收货人地址的市修改后必传
receiverDistrictstring收货人地址的区修改后必传
receiverAddressstring收货人地址的详细地址修改后必传
deliverTypestring配送方式修改后必传可选值:
SELF_PICKUP: 自提
EXPRESS: 快递

修改地址 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
exCountrystring修改前国家修改后传
newCountrystring修改后国家修改后传
exProvincestring修改前省份修改后传
newProvincestring修改后省份修改后传
exCitystring修改前市修改后传
newCitystring修改后市修改后传
exDistrictstring修改前区修改后传
newDistrictstring修改后区修改后传
exAddressstring修改前详细地址修改后传
newAddressstring修改后详细地址修改后传

加购物车 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
productIdstring商品ID必传
productTypestring商品类别必传商品的分类,例如:手机、电脑配件、化妆品、电脑笔记本等
productNamestring商品名称强烈建议
productBrandstring商品品牌强烈建议
productPricefloat商品单价必传
currencystring计价货币必传参考货币代码表(ISO4217)
https://www.currencyconversion.us/currency-codes.htm

参与拼团 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
groupIdString拼团号必传字段用户参与拼团的拼团号
groupOwnerIdString用户参与拼团的发起人的账号Id必传字段用户参与拼团的发起人的唯一标识
phoneString开户行绑定的手机号或者该手机号MD5加密字符串强烈建议中国大陆区手机号请填写11位数字例如:13800138000MD5加密字符串格式为32位小写
countryCodeString手机用户的国家代码强烈建议中国大陆区手机号填写0086非中国大陆区手机号填写国家代码例如:美国填写0001、安道尔0376、巴哈马1242

发起拼团 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
phonePrefix7String手机号前7位强烈建议
groupIdString拼团的团Id必传字段

浏览/观看/阅读 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
guestIdstring当前业务中浏览的游客账户ID,当用户以游客身份进入时传入guestId强烈建议每个游客账号ID是唯一的,且与其它数美接口guestId保持一致性,长度限制在64个字符以内。
referIdstring前一个内容或页面ID,可以是URI强烈建议
contentOwnerIdstring被浏览内容的拥有者账号ID强烈建议平台自己发布的内容传空字符串
levelint用户等级,针对不同等级的用户可配置不同拦截策略强烈建议可选值:0,1,2,3,4分别对应:
0:最低级用户,典型如新注册、完全不活跃或等级为0的用户等
1:较低级用户,典型如低活跃或低等级用户等
2:中等级用户,典型如具备一定活跃或等级中等的用户等
3:较高级用户,典型如高活跃或高等级用户等
4:最高级用户,典型如付费用户、VIP用户、可考虑放过的用户等
productIdstring商品ID强烈建议浏览商品详情页是传入
productTypestring商品类别强烈建议浏览商品详情页是传入
商品的分类,例如:手机、电脑配件、化妆品、电脑笔记本等
productNamestring商品名称强烈建议浏览商品详情页是传入
productBrandstring商品品牌强烈建议浏览商品详情页是传入
productPricefloat商品单价强烈建议浏览商品详情页是传入
currencystring计价货币强烈建议浏览商品详情页是传入
参考货币代码表(ISO4217)
referTypestring前一个页面类型强烈建议可选值:首页、商品分类页,详情页,列表页
searchKeyWordsstring搜索关键词建议适用于通过搜索进入页面
browseLengthint64本次浏览时长,单位为毫秒(ms)建议适用电商场景
nickNamestring用户账户昵称建议
eventNamestring浏览页面的类型建议例如:首页、关注页、搜索页、推荐页等
contentIdstring内容或页面id,可以是URI建议当前页面Id,需要去掉可变参数
contentTypestring视频、文章、书籍小说建议可选值:
video:视频
article:文章
book:书籍
ad:广告
contentLengthint64内容长度
1.对于视频,是以ms为单位的时间;
2.对于文章,为空
3.对于小说,以字为单位的字数
建议
watchLengthint64本次观看时长,单位为毫秒(ms)建议
inviteTokenIdstring分享或邀请人的的tokenId建议
getCouponint激励事件标注建议如果此次事件是行为激励的一种任务形式,传入 1;否则传入0

点赞 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
receiveTokenIdstring点赞行为对象的ID强烈建议被点赞内容的拥有者ID
nickNamestring用户账户昵称建议
contentIdstring被点赞内容的ID建议被点赞内容的ID
getCouponint激励事件标注建议如果此次事件是行为激励的一种任务形式,传入1;否则传入0
shoppingMallIdstring商场Id建议线下场景,被点赞商户所在商场

关注 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
receiveTokenIdstring关注行为对象的ID强烈建议被关注的目标对象ID
nickNamestring用户账户昵称建议
contentIdstring被关注内容的ID建议被关注内容的ID
getCouponint激励事件标注建议如果此次事件是行为激励的一种任务形式,传入1;否则传入0

分享 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
receiveTokenIdstring分享行为对象的ID强烈建议被分享的目标对象ID
nickNamestring用户账户昵称建议
contentIdstring被分享内容的ID建议被分享内容的ID
contentOwnerIdstring被分享内容的拥有者ID建议被分享内容的拥有者ID
getCouponint激励事件标注建议如果此次事件是行为激励的一种任务形式,传入1;否则传入0

浏览帖子 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
topicstring内容或页面id,可以是URI强烈建议当前页面Id,需要去掉可变参数
guestIdstring当前业务中浏览的游客账户ID,当用户以游客身份进入时传入guestId强烈建议每个游客账号ID是唯一的,且与其它数美接口guestId保持一致性,长度限制在64个字符以内。
referIdstring前一个内容或页面ID,可以是URI强烈建议
contentOwnerIdstring被浏览内容的拥有者账号ID强烈建议平台自己发布的内容传空字符串
nickNamestring用户账户昵称建议
eventNamestring浏览页面的类型建议例如:首页、关注页、搜索页、推荐页等
contentTypestring视频、文章、书籍小说建议可选值:
video:视频
article:文章
book:书籍
ad:广告
contentLengthint64内容长度:
1.对于视频,是以ms为单位的时间;
2.对于文章,为空
3.对于小说,以字为单位的字数
建议
watchLengthint64本次观看时长,单位为毫秒(ms)建议
inviteTokenIdstring分享或邀请人的的tokenId建议

收藏 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
receiveTokenIdstring收藏行为对象的ID强烈建议被收藏内容的拥有者ID
nickNamestring用户账户昵称建议
contentIdstring被收藏内容的ID建议被收藏内容的ID
getCouponint激励事件标注建议如果此次事件是行为激励的一种任务形式,传入1;否则传入0
productIdstring商品ID建议
productBrandstring商品品牌建议
productNamestring商品名称建议
productPricefloat商品价格建议
currencystring计价货币建议

评论 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
commentstring用户评论的内容强烈建议用户评论的内容
commentIdstring评论内容的Id强烈建议用户评论内容的id
flightNumstring被评论的航班号强烈建议用户评论的航班号(特殊行业字段)
orderIdstring发表商品评论关联的订单号强烈建议
productIdString发表商品评论关联的商品强烈建议

笔记点赞 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
receiveTokenIdstring笔记点赞行为对象的ID强烈建议被笔记点赞的拥有者ID
nickNamestring用户账户昵称建议
contentIdstring被点赞内容的ID建议被点赞内容的ID
getCouponint激励事件标注建议如果此次事件是行为激励的一种任务形式,传入1;否则传入0

评论点赞 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
receiveTokenIdstring评论点赞行为对象的ID强烈建议被评论点赞的拥有者ID
nickNamestring用户账户昵称建议
contentIdstring被点赞内容的ID建议被点赞内容的ID
getCouponint激励事件标注建议如果此次事件是行为激励的一种任务形式,传入1;否则传入0

下实物订单 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
productsjson array订单商品信息,详情见下文必传参数
orderIdstring订单ID强烈建议该商品订单唯一标识
paymentIdstring付款ID强烈建议用户进行一次下单付款动作的标识;该标识标记了用户发起的一次下单付款行为。
orderNotesstring订单备注信息建议用户在此订单上备注的信息
paymentMethodstring付款方式强烈建议可选值:
CASH_ON_DELIVERY:货到付款
ONLINE_PAYMENT:在线支付
intervalint64商品发布到下单时间,单位毫秒(ms)强烈建议主要用于商品秒杀
receiverPhonestring收货人手机号强烈建议中国大陆区手机号请填写11位数字例如:13800138000
receiverPhoneMd5string收货人手机号Md5值强烈建议MD5加密字符串格式为32位小写例如:d0213fde1643000949161dcb1ed0e605
shippingFeefloat64物流/快递费用强烈建议例如:0.00, 6.00
currencystring货币强烈建议参考货币代码表(ISO4217)
activityIdstring活动ID建议营销活动的ID
pricefloat64下单优惠前的金额建议货币计量单位为中国大陆法定货币人民币(CNY),单位:元例如:88.69
discountfloat64该订单享受的优惠金额建议商品订单原价–商品订单实际支付的价格
nickNamestring用户账户昵称建议
groupIdstring拼团的团ID建议用户自定义唯一标识
discountTypestring优惠来源建议可选值:
NEW_USER:新用户优惠
REWARD_TASK:奖励任务优惠
PURCHASE:购买
receiverCountrystring收货人地址的国家建议国际域名缩写,若不存在传国家英文全称例如:CN
receiverProvincestring收货人地址的省建议中文例如:山东省
receiverCitystring收货人地址的市建议中文例如:北京市
receiverDistrictstring收货人地址的区建议中文例如:朝阳区
receiverAddressstring收货人地址的详细地址建议中文
deliverTypestring配送方式建议可选值:
SELF_PICKUP:自提
EXPRESS:快递
groupOwnerIdstring用户参与拼团的发起人的账号Id建议用户参与拼团的发起人的唯一标识
shopIdstring门店编号建议
shopCountrystring门店(自提点)归属国家建议用于社区团购场景若不存在传国家英文全称,如:CN
shopProvincestring门店(自提点)归属省建议中文如:山东省
shopCitystring门店(自提点)归属市建议中文如:北京市
shopDistrictstring门店(自提点)归属区建议中文如:朝阳区
shopAddressstring门店(自提点)详细地址建议
discountsjson array券信息强烈建议例如:
[{"type":"券","id":"xxx","activityId":"xxx", "amount":5.00},{"type":"下单立减","id":"","activityId":"xxx", "amount":10.00},{"type":"积分","id":"","activityId":"xxx", "amount":2.50}]

|

products 的参数要求:

参数名称类型参数说明是否必传规范
productIdstring商品ID,SPU标准化产品单元必传参数
productCountint商品数量必传参数
productTypestring商品类型建议用于需要特殊处理的商品,根据需要传入即可,具体值可参考为:“贵金属”
merchantIdstring商户ID必传参数若无法区分第三方(自营)传特定值“自营”
senderCountrystring发货人地址的国家建议国际域名缩写,若不存在传国家英文全称例如:CN
senderProvincestring发货人地址的省建议中文例如:山东省
senderCitystring发货人地址的市建议中文例如:北京市
senderDistrictstring发货人地址的区建议中文例如:朝阳区
senderAddressstring发货人地址的详细地址建议中文例如:望京诚盈中心1号楼3A或北京市朝阳区望京诚盈中心1号楼3A
productBrandstring商品品牌建议productBrand
productNamestring商品名称建议productName
productPricefloat商品价格建议productPrice
currencystring计价货币建议currency

discounts的内容如下:

参数名称类型参数说明是否必传规范
typestring券类型强烈建议
idstring券ID强烈建议标记优惠的唯一ID
activityIdstring券对应的活动ID强烈建议营销活动的ID
amountfloat券金额强烈建议

下虚拟订单 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
productstring虚拟商品名称必传参数例如:金币、道具、会员等机票(航班号+“-”+日期,CA288-20180101)
orderIdstring订单ID强烈建议该商品订单唯一标识
intervalint64商品发布到下单时间,单位毫秒(ms)强烈建议主要用于商品秒杀
pricefloat64下单总金额(优惠前)强烈建议货币计量单位为中国大陆法定货币人民币(CNY),单位:元例如:88.69
discountfloat64该订单享受的优惠金额强烈建议商品订单原价–商品订单实际支付的价格
accountfloat64购买商品后账户余额强烈建议购买金币、Q币等虚拟商品后账户余额(增加),单位:元,例如:10.5
groupIdstring拼团的团ID建议用户自定义唯一标识
discountTypestring优惠来源建议可选值:
NEW_USER:新用户优惠
REWARD_TASK:奖励任务优惠
PURCHASE:购买
currencystring货币强烈建议参考货币代码表(ISO4217)

接受服务订单 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
orderIdstring订单ID必传参数
intervalint64由订单发布至订单被抢之间的时间,服务发布到下单时间,单位毫秒(ms)必传参数
pricefloat64下单优惠前的金额。单位:元建议
discountfloat64该订单享受的优惠金额建议商品订单原价–商品订单实际支付的价格
discountTypestring优惠来源建议可选值:
NEW_USER:新用户优惠
REWARD_TASK:奖励任务优惠
PURCHASE:购买
currencystring货币强烈建议参考货币代码表(ISO4217)

完成订单 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
orderIdstring订单ID必传参数
intervalint64由订单发布至订单被抢之间的时间,服务发布到下单时间,单位毫秒(ms)必传参数
pricefloat64下单优惠前的金额。单位:元建议
discountfloat64该订单享受的优惠金额建议商品订单原价–商品订单实际支付的价格
discountTypestring优惠来源建议可选值:
NEW_USER:新用户优惠
REWARD_TASK:奖励任务优惠
PURCHASE:购买
currencystring货币强烈建议参考货币代码表(ISO4217)

取消订单 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
orderIdstring订单ID必传参数
intervalint64由订单发布至订单被抢之间的时间,服务发布到下单时间,单位毫秒(ms)必传参数
pricefloat64下单优惠前的金额。单位:元建议
discountfloat64该订单享受的优惠金额建议商品订单原价–商品订单实际支付的价格
discountTypestring优惠来源建议可选值:
NEW_USER:新用户优惠
REWARD_TASK:奖励任务优惠
PURCHASE:购买
currencystring货币强烈建议参考货币代码表(ISO4217)

订阅 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
contentIdstring用户订阅的文章id强烈建议用户订阅的文章id
receiveTokenIdstring用户订阅文章的作者id强烈建议用户订阅文章的作者id

发帖 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
contentIdstring用户发步的内容id强烈建议用户发布的内容id

示例:#

请求示例:#

{
"accessKey": "XXXXXXX",
"eventId": "order",
"appId": "default",
"data": {
"ip": "",
"deviceId": "BQ144b7Xd4TAejWdbWOrB4SI0Gn7vaYxEybz2q22851RoABghw4evlXwXBlPjwY89Iv5kBZjE+nR7WDWFB94IPA==",
"phone": "67e7fec84d482447595eff4109f87c58",
"appVersion": "4.5.9",
"tokenId": "8ddbb939193651b7a38f5fe33ab14e53",
"isTokenSeperate": 0,
"os": "android",
"paymentMethod": "ONLINE_PAYMENT",
"products": [
{
"merchantId": "",
"productCount": 1,
"productId": "60425"
}
],
"timestamp": 1652370840283,
"activityId": "",
"discountType": "PURCHASE"
}
}

同步返回示例:#

{
"requestId": "0acfaaebbc01001113d6ad0b8c11eeb8",
"riskLevel": "REJECT",
"tokenRiskLabels": [
{
"timestamp": 1652370941818,
"label1": "risk_device_token",
"label2": "multi_boxing_token",
"label3": "multi_boxing_by_app_token",
"description": "风险设备账号:多开设备账号:工具多开设备账号"
},
{
"label1": "risk_device_token",
"label2": "multi_boxing_apps_token",
"label3": "multi_boxing_apps_token",
"description": "风险设备账号:安装多开工具设备账号:安装多开工具设备账号",
"timestamp": 1652370941818
}
],
"detail": {
"ip_province": "江西",
"hits": [
{
"description": "高风险账号:账号异常聚集账号",
"model": "M002020112",
"riskLevel": "REJECT"
},
{
"description": "高风险账号:数美风险模型识别",
"model": "M002070002",
"riskLevel": "REJECT"
},
{
"riskLevel": "REJECT",
"description": "高风险账号:数美风险模型识别",
"model": "M00212001"
},
{
"description": "高风险设备:账号异常聚集",
"model": "M99120102",
"riskLevel": "REJECT"
}
],
"model": "M99120102",
"machineAccountRisk": {
"tokenSampleDesc": "账号异常聚集",
"tokenSampleLastTs": 1652370941818
},
"description": "高风险设备:账号异常聚集",
"ip_country": "中国",
"ip_city": "上饶"
},
"code": 1100,
"message": "成功"
}

账号查询接口#

请求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格式,具体参数如下:

请求参数名类型参数说明是否必传规范
accessKeystring接口认证密钥
用于权限认证,开通账号服务时由数美提供或使用开通邮箱登录数美后台右上角相关文档处查看
必传参数数美分配
datajson_object请求的数据内容必传参数请求的数据内容,最长10MB,详见data参数
其中,data的内容如下:
请求参数名类型参数说明是否必传规范
tokenIdstring用户账号标识,建议使用贵司用户UID(可加密)自行生成 , 标识用户唯一身份用作灌水和广告等行为维度风控。如无用户uid的场景建议使用唯一的数据标识传值不能为空该ID为用户的唯一标识,且与其它数美接口的tokenId保持一致

返回结果#

放在HTTP Body中,采用Json格式,具体参数如下:

参数名称参数类型参数说明是否必返规范
codeint返回码1100:成功
1901:QPS超限
1902:参数不合法
1903:服务失败
1911:图片下载失败
9101:无权限操作
3000:运营商错误
除message和requestId之外的字段,只有当code为1100时才会存在
messagestring返回码描述和code对应:成功 QPS超限 参数不合法 服务失败 余额不足 无权限操作
requestIdstring请求标识请求唯一标识,用于排查问题和后续效果优化,强烈建议保存
tokenLabelsjson_object账号标签信息见下面详情内容,仅在tokenId传入且服务开通时返回
tokenProfileLabelsjson_array账号属性标签见下面详情内容,仅在tokenId传入且服务开通时返回
tokenRiskLabelsjson_array账号风险标签见下面详情内容,仅在tokenId传入且服务开通时返回

其中

1)tokenLabels的详情内容

返回结果参数名参数类型参数说明规范
machine_account_riskjson_object机器控制相关风险
UGC_account_riskjson_objectUGC内容相关风险
scene_account_riskjson_object场景账号风险特殊场景才可取到,如航司等

machine_account_risk的详情内容如下:

返回结果参数名参数类型参数说明规范
b_machine_control_tokenidint机器账号0:非机器控制账号1:机器控制账号
b_machine_control_tokenid_last_tsint机器账号时间
b_offer_wall_tokenidint积分墙账号0:非积分墙账号1:积分墙账号
b_offer_wall_tokenid_last_tsint积分墙账号时间

UGC_account_risk的详情内容如下:

返回结果参数名参数类型参数说明规范
b_politics_risk_tokenidint涉政风险0:暂未发现涉政风险1:存在涉政风险
b_politics_risk_tokenid_last_tsint涉政风险时间
b_sexy_risk_tokenidint色情风险0:暂未发现色情风险1:存在色情风险
b_sexy_risk_tokenid_last_tsint色情风险时间
b_advertise_risk_tokenidint广告风险0:暂未发现广告风险1:存在广告风险
b_advertise_risk_tokenid_last_tsint广告风险时间

scene_account_risk的详情内容如下:

返回结果参数名参数类型参数说明规范
i_tout_risk_tokenidint航司占座账号0:非航司占座账号1:航司占座账号
i_tout_risk_tokenid_last_tsint航司占座时间

其中标签类返回字段

1)tokenProfileLabels的详情内容

返回结果参数名参数类型参数说明规范
label1string一级标签展示账号属性标签的一级标签。
label2string二级标签展示账号属性标签的二级标签。
label3string三级标签展示账号属性标签的三级标签。
descriptionstring风险描述展示账号属性标签的中文描述。
timestampint64最近一次命中策略的时间最近一次命中策略的时间
detailjson_object证据描述证据细节

2)tokenRiskLabels的详情内容

返回结果参数名参数类型参数说明规范
label1string一级标签展示账号风险标签的一级标签。
label2string二级标签展示账号风险标签的二级标签。
label3string三级标签展示账号风险标签的三级标签。
descriptionstring风险描述展示账号风险标签的中文描述。
timestampint64最近一次命中策略的时间最近一次命中策略的时间
detailjson_object证据描述证据细节

示例:#

请求示例:#

{
"accessKey": "xxxxxxxxxxxxxxxxxxxxxxxxx",
"data": {
"tokenId": "ceshitokenId"
}
}

同步返回示例:#

{
"code": 1100,
"message": "成功",
"profileExist": 1,
"requestId": "7a5445716f0581c2ab1d381a6af4d1b8",
"tokenLabels": {
"machine_account_risk": {
"b_machine_control_tokenid": 1,
"b_machine_control_tokenid_last_ts": 1587711321232,
"b_offer_wall_tokenid": 1,
"b_offer_wall_tokenid_last_ts": 1587711321232
},
"UGC_account_risk": {
"b_politics_risk_tokenid": 1,
"b_politics_risk_tokenid_last_ts": 1587711321232,
"b_sexy_risk_tokenid": 1,
"b_sexy_risk_tokenid_last_ts": 1587711321232,
"b_advertise_risk_tokenid": 1,
"b_advertise_risk_tokenid_last_ts": 1587711321232
},
"scene_account_risk": {
"i_tout_risk_tokenid": 1,
"i_tout_risk_tokenid_last_ts": 1587711321232
},
"account_active_info": {
"i_tokenid_first_active_timestamp": 1587711321232,
"i_tokenid_active_days_7d": 5,
"i_tokenid_active_days_4w": 5
},
"account_freq_info": {
"i_tokenid_login_cnt_1d": 5,
"i_tokenid_login_cnt_7d": 5
},
"account_relate_info": {
"i_tokenid_relate_smid_cnt_1d": 5,
"i_tokenid_relate_smid_cnt_7d": 5,
"i_tokenid_relate_ip_city_cnt_1d": 5,
"i_tokenid_relate_ip_city_cnt_7d": 5
},
"account_common_info": {
"s_tokenid_relate_smid_info_map_4w": [
{
"smid": "xxxx1",
"days": "3"
},
{
"smid": "xxxx2",
"days": "5"
},
{
"smid": "xxxx3",
"days": "10"
}
],
"s_tokenid_relate_ip_city_info_map_4w": [
{
"city": "北京",
"days": "3"
},
{
"city": "长沙",
"days": "5"
},
{
"city": "武汉",
"days": "10"
}
]
}
},
"tokenProfileLabels": [
{
"label1": "age_gender",
"lable2": "token_age",
"label3": "minor_token",
"description": "年龄性别:年龄:未成年人",
"timestamp": 1634732525000,
"detail": {
}
}
],
"tokenRiskLabels": [
{
"label1": "risk_device_token",
"label2": "b_cloud_token_device",
"label3": "b_cloud_token_device",
"description": "风险设备账号:云手机账号:云手机账号",
"timestamp": 1634732525000,
"detail": {
}
},
{
"label1": "risk_device_token",
"label2": "b_hook_token",
"label3": "b_hook_token",
"description": "风险设备账号:hook设备:hook设备",
"timestamp": 1634732525000,
"detail": {
}
}
]
}

在线咨询