数美天网-营销风控

---

版权所有 翻版必究

---

营销风控

• 事件接口
  • 接口定义
    • 请求URL
    • 字符编码格式
    • 请求方法
    • 建议超时时长
    • 请求参数
    • 返回结果
  • 事件列表
  • 事件详细API
  • 示例
    • 请求示例
    • 返回示例
• 查询接口
  • 接口定义
    • 请求URL
    • 字符编码格式
    • 请求方法
    • 建议超时时长
    • 请求参数
    • 返回结果
  • 示例
    • 请求示例
    • 返回示例
    • 加密传输

营销风控

具体接口

请求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，用于区分相同公司的不同应用	必传参数	该参数传递值可与数美协商。 当公司app存在多个马甲包，分下面两种情况： 1. 马甲包账号互通，不同马甲包数据传入不同的appId，tokenId保持一致 2. 马甲包账号独立，不同马甲包数据传入不同的appId，tokenId必须不同
eventId	string	事件ID，用于标识事件类型。	必传参数	不同的事件对应不同的策略，不同的事件输入参数可能会有细微的差别，请对应按照各事件详细传参说明
data	json_object	请求的数据内容，事件特有参数可以放入data下传入	必传参数	请求的数据内容，最长10MB，详见data参数

其中，data的内容如下：

参数名称	类型	参数说明	是否必传	规范
tokenId	string	用户账号标识，建议使用贵司用户UID（可加密）自行生成 , 标识用户唯一身份用作灌水和广告等行为维度风控。如无用户uid的场景建议使用唯一的数据标识传值	必传参数	注意点： 1. tokenId传入业务系统中的用户ID，务必保证接入数美全部事件相同用户传入的用户ID值一致且唯一 2. 如果公司主体下存在多个应用且需要按应用区分账号，即相同用户ID在不同应用中代表不同用户。则建议在传入的用户ID之前拼接应用标识作为tokenId传入，达到区分账号体系的目的。 3. 如果没有区分需求，则直接将用户ID传入tokenId字段即可 4. 如果传入错误，会导致系统认为是不同账号，账号的行为无法关联，导致识别不准确
ip	string	当前业务事件发生时的客户端公网ipv4或ipv6地址	必传参数	非内网ip
timestamp	int64	当前业务事件发生时的时间戳，单位为毫秒（ms）	必传参数
deviceId	string	数美设备指纹标识，由数美SDK生成	强烈建议	数美设备指纹标识，用于用户行为分析。 注： 1. 接入数美SDK前的版本，无法获取到deviceId的情况下，deviceId传空“”即可； 2. 直接传输getDeviceId获取到的原始字段，不需要解密
os	string	应用端操作系统类型	强烈建议	可选值：android、harmony、ios、weapp、web、aliapp：支付宝小程序、ttapp：抖音小程序、tmapp：天猫小程序
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
activityType	string	活动类型，主要分为线下活动和线上活动。根据不同活动类型可以调用不同策略	建议	可选值：online_activity、offline_activity。online_activity为线上活动，如线上签到等；offline_activity为线下活动，如地推拉新活动等；
userAgent	string	用户代理	强烈建议
countryCode	string	手机用户的国家代码	强烈建议	中国大陆区手机号填写0086非中国大陆区手机号填写国家代码例如：美国填写0001、安道尔0376、巴哈马1242
phoneMd5	string	手机号的Md5，32位小写加密串	建议
phoneSha256	string	手机号的Sha256加密串	建议
newCountryCode	string	手机号国家码	建议	该字符串规范为四位字符串，默认为中国手机号国家码0086，传入规范详见国家码与国家对应关系
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	用户自定义透传字段	建议	如无必要，不传，如果存在，值不能为空
counterInfo	json_object	事件关联柜台信息	可选参数	事件与柜台具有关联时，强烈建议接入，否则部分策略无法使用，详见counterInfo参数

counterInfo的内容如下：

参数名称	类型	参数说明	是否必传	规范
counterName	string	柜台名称	可选参数
counterProvince	string	柜台所在省份	可选参数
counterCity	string	柜台所在城市	可选参数
counterId	string	柜台唯一ID	可选参数	注意点： 1. counterId传入业务系统中柜台ID，务必保证接入数美全部事件相同柜台传入的counterID值一致且唯一 2. 如果传入错误，会导致系统认为是不同柜台，导致识别不准确
counterDistrict	string	柜台所在地区	可选参数
counterAddress	string	柜台详细地址	可选参数

返回结果

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

参数名称	类型	参数说明	是否必返	规范
code	int	返回码	是	1100：成功 1901：QPS超限 1902：参数不合法 1903：服务失败 9101：无权限操作 除message和requestId之外的字段，只有当code为1100时才会存在
message	string	返回码描述	是	和code对应：成功 QPS超限 参数不合法 服务失败 无权限操作
requestId	string	请求标识	是	请求唯一标识，用于排查问题和后续效果优化，强烈建议保存
riskLevel	string	当前事件的处置建议	是	PASS：通过 REVIEW：审核 REJECT：拒绝 VERIFY：验证
detail	json_object	风险详情信息，详情见下文	是	详见detail结果详情
tokenProfileLabels	json_array	账号属性标签	否	仅在服务开通时返回，详见tokenProfileLabels结果详情
tokenRiskLabels	json_array	账号风险标签	否	仅在服务开通时返回，详见tokenRiskLabels结果详情

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	账号历史打黑信息	只有当前账号历史被打入账号黑库后，账号的相关流水才会返回该结构体，详见machineAccountRisk结果详情
smid	string	设备唯一标识	需要传入deviceId字段且联系数美开通配置后，才会返回该字段
matchedLists	json_arrar	功能名单内容	详见matchedLists结果详情

matchedLists字段下每个对象包含以下信息

返回结果参数名	参数类型	参数说明	规范
name	string	名单名称
riskLevel	string	处置建议
words	json_array	敏感词命中信息；该json_array下的每个item代表一个敏感词的一次命中	该名单下命中的敏感词风险详情，用于解释命中的敏感词位置等信息，详见words结果详情

words字段下每个对象包含以下信息

返回结果参数名	参数类型	参数说明	规范
word	string	敏感词	组合词返回 “服务|社会”；返回的是添加名单时添加的敏感词内容
checkItem	string	配置匹配字段	名单配置时的匹配字段

hits结果详情的内容

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

machineAccountRisk详情的内容

返回结果参数名	参数类型	参数说明	规范
tokenSampleLastTs	int64	最近打黑时间，毫秒级	如："tokenSampleLastTs": 1683026613000
tokenSampleDesc	string	历史打黑策略的description	如："tokenSampleDesc": "高风险设备：IP异常聚集"

其中标签类返回字段

tokenProfileLabels详情的内容

返回结果参数名	参数类型	参数说明	规范
label1	string	一级标签	展示账号属性标签的一级标签。
label2	string	二级标签	展示账号属性标签的二级标签。
label3	string	三级标签	展示账号属性标签的三级标签。
description	string	风险描述	展示账号属性标签的中文描述。
timestamp	int64	最近一次命中策略的时间	最近一次命中策略的时间
detail	json_object	证据描述	证据细节

tokenRiskLabels详情的内容

返回结果参数名	参数类型	参数说明	规范
label1	string	一级标签	展示账号风险标签的一级标签。
label2	string	二级标签	展示账号风险标签的二级标签。
label3	string	三级标签	展示账号风险标签的三级标签。
description	string	风险描述	展示账号风险标签的中文描述。
timestamp	int64	最近一次命中策略的时间	最近一次命中策略的时间
detail	json_object	证据描述	证据细节

事件列表

行业	场景	事件	eventId	规范
通用	获利-拉新	发起邀请	invite	参数详情
通用	获利-拉新	接受邀请	fission	参数详情
通用	获利-例行签到	签到	signIn	参数详情
通用	获利-其他任务	做任务	task	参数详情
通用	获利-助力	发起邀请	invite	参数详情
通用	获利-助力	助力	help	参数详情
通用	通用	反馈	feedback	参数详情
通用	通用	验证结果	verify	参数详情
通用	通用	发券	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	参数详情
航司	通用	查询航班	airlineSearch	参数详情
航司	套利-占库存	预定航班	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

发起邀请

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

接受邀请

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
inviteTokenId	string	邀请人的tokenId	必传参数
subTokenId	string	账号的子账号	强烈建议	某些特殊的场景主账号有多个子账号（游戏场景不同区服）
nickName	string	被邀请用户账户昵称	建议
groupId	string	拼团的团ID	建议	拼团、助力等场景下的团ID
invitationCode	String	邀请用户的邀请码	强烈建议	接受邀请人填写的邀请码，或在二维码、链接中隐含的邀请码
requirement	int	当前拉新活动奖励所需最小参与账号数	强烈建议	若为阶梯式奖励（不同人数对应不同奖励规模）则传入最小奖励对应人数
taskId	string	唯一标识拉新活动的ID	强烈建议	若有多个裂变活动同时进行，则用此id唯一标记当前参与的裂变活动
taskName	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	用户自定义数据或者数美要求传的特定数据	如无必要，不传

助力

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
inviteTokenId	string	邀请人的tokenId	必传参数
invitationCode	String	邀请人的助力邀请码	强烈建议	助力人填写的邀请码，或在二维码、链接中隐含的邀请码
taskId	string	唯一标识助力活动的ID	强烈建议	若有多个助力活动同时进行，则用此id唯一标记当前参与的助力活动
groupId	string	用户参与拼团的拼团号	强烈建议	用户参与拼团的拼团号
taskName	string	事件名，表示当前具体助力类型	建议	例如：助力赢红包、助力领券、助力砍价
requirement	int	当前助力活动奖励所需最小参与账号数	强烈建议	若为阶梯式奖励（不同人数对应不同奖励规模）则传入最小奖励对应人数
getCoupon	int	徒弟激励标注	建议	如果此次事件对当前账号发放激励，传入1；否则传入0
nickName	string	用户账户昵称	建议

反馈

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

验证结果

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

发券

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

点击

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

提交订单

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
orderId	string	订单ID	强烈建议	该商品订单唯一标识（无正式生成订单及订单ID时需传入临时订单ID，需要保证与该事件返回 PASS 后order 事件正式生成订单的orderId 一致）
paymentMethod	string	付款方式	强烈建议	可选值： CASH_ON_DELIVERY：货到付款 ONLINE_PAYMENT：在线支付
interval	int64	商品发布到下单时间，单位毫秒（ms）	强烈建议	主要用于商品秒杀
receiverPhone	string	收货人手机号	强烈建议	中国大陆区手机号请填写11位数字例如：13800138000
receiverPhoneMd5	string	收货人手机号Md5值	强烈建议	MD5加密字符串格式为32位小写例如：d0213fde1643000949161dcb1ed0e605
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	建议	用户参与拼团的发起人的唯一标识

核保

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

平台奖励

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

下载

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
getCoupon	int	激励事件标注	强烈建议	如果此次事件是行为激励的一种任务形式，传入1；否则传入0
contentId	string	下载内容的ID	强烈建议
nickName	string	用户账户昵称	建议
price	float64	下载使用金额（币等）	建议
interval	int64	内容发布到点击下载时间间隔，单位毫秒（ms）	建议	“抢任务”场景必选；其他场景不必选

广告请求事件

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

广告展示事件

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

发放奖励事件

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

广告点击事件

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

广告消失事件

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

浏览

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
guestId	string	当前业务中浏览的游客账户ID，当用户以游客身份进入时传入guestId	强烈建议	每个游客账号ID是唯一的，且与其它数美接口guestId保持一致性，长度限制在64个字符以内。
referId	string	前一个内容或页面ID，可以是URI	强烈建议
contentOwnerId	string	被浏览内容的拥有者账号ID	强烈建议	平台自己发布的内容传空字符串
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

玩家对环境

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

玩家对玩家

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

抽奖结果

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

抢红包

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

领券

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
couponType	string	当前业务领券的类型	强烈建议	如：满减券，打折券，免单券
nickName	string	用户账户昵称	建议
price	float64	券的金额	建议	货币计量单位为中国大陆法定货币人民币（CNY），单位：元例如：88.69
couponSource	string	当前业务领券的来源	强烈建议	传中文即可，具体值为：“平台券”，“商户券”
currency	string	计价货币	建议
coupons	json array	券信息	强烈建议

预约商品

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

products 中的字段

参数名称	类型	参数说明	是否必传	规范
productId	string	商品ID,SPU 标准化产品单元	必传参数	传sku id
productCount	int	商品数量	必传参数
merchantId	string	商户ID	必传参数	传商户编号

下服务订单

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
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	计价货币	建议	价值的单位：人民币，美元，金币，智慧币等
item_price	float64	订单实付价格	必传参数	货币计量单位为中国大陆法定货币人民币 （CNY），单位：元 例如：88.69
order_price	float64	订单原价	建议	货币计量单位为中国大陆法定货币人民币 （CNY），单位：元 例如：88.69
sampleCabinetInfo	json object	到柜领样场景相关的信息，详情见下文	必传参数

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

sampleCabinetInfo的内容如下：

参数名称	类型	参数说明	是否必传	规范
uploadPhotoState	int	上传照片	必传字段	上传照片传1 其余传0
VerificationCodeFirstTimestamp	int64	兑换券（核销码）生成时间戳	必传字段

下实物订单

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
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)
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}]
item_price	float64	订单实付价格	必传参数	货币计量单位为中国大陆法定货币人民币 （CNY），单位：元 例如：88.69
order_price	float64	订单原价	建议	货币计量单位为中国大陆法定货币人民币 （CNY），单位：元 例如：88.69
sampleCabinetInfo	json object	到柜领样场景相关的信息，详情见下文	必传参数

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
amount	float	券金额	强烈建议

sampleCabinetInfo的内容如下：

参数名称	类型	参数说明	是否必传	规范
uploadPhotoState	int	上传照片	必传字段	上传照片传1 其余传0
VerificationCodeFirstTimestamp	int64	兑换券（核销码）生成时间戳	必传字段

兑换

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

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

支付

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
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：“平台自身”

绑卡

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

提现

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
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个字符以内。
name	string	参数的名称	强烈建议	查询输入的乘机人姓名
prcid	string	参数的内容	强烈建议	查询输入的证件号，为以下内容之一：身份证号码；港澳居民身份证号码；台湾居民身份证号码；护照号码；其他证件号码；票号
referId	string	前一个内容或页面ID，可以是URI	强烈建议

查询航班(airlineSearch)

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
startDate	string	参数的内容	必传字段	去程日期的值，格式类似：2019-01-01
startCity	string	参数的内容	强烈建议	出发城市的名称或缩写
endCity	string	参数的内容	强烈建议	到达城市的名称或缩写
endDate	string	参数的内容	强烈建议	返程日期的值，格式类似：2019-01-01
referId	string	前一个内容或页面ID，可以是URI	强烈建议

预定航班

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
orderId	string	订单ID	必传参数	该机票订单唯一标识
startDate	string	参数的内容	强烈建议	去程日期的值，格式类似：2019-01-01
endDate	string	参数的内容	强烈建议	返程日期的值，格式类似：2019-01-01
startCity	string	参数的内容	强烈建议	出发城市的名称或缩写
endCity	string	参数的内容	强烈建议	到达城市的名称或缩写
flightNum	string	航班号	必传参数	例：9C3300、IJ123，如果是中转联程或往返，把2段都写上，用\|分隔，例如：9C3300\|9C1345,9C3300\|B3210
branchId	string	航空公司分支Id	强烈建议	直接使用航司代码，如9C、IJ、IB，如果是联程，2段不一样的，用\|分隔，例如：9C\|1B
airlineId	string	航线Id	强烈建议	航线的机场三字码，如上海浦东机场-重庆江北机场，填：PVGCKG，若为中转联程或往返，把2段都写上，用\|分隔，例如：PVGCKG\|CKGSHA
products	json array	订单信息，详情见下文	强烈建议
startGpsLocation	json object	订单页面填写的服务开始gps的位置信息，详情见下文	强烈建议	详见下文startGpsLocation的内容
endGpsLocation	json object	订单页面填写的服务结束gps的位置信息，详情见下文	强烈建议	详见下文endGpsLocation的内容
interval	int64	机票发布到下服务订单时间，单位毫秒（ms）	强烈建议
contactName	string	联系人姓名，可加密处理，保证一对一映射即可	强烈建议
contactPhone	string	联系人使用的手机号或者该手机号MD5加密字符串	强烈建议	中国大陆区手机号请填写11位数字例如：13800138000MD5加密字符串格式为32位小写
contactCountryCode	string	联系人手机的国家代码，4位数字表示	强烈建议	中国大陆区手机号填写0086非中国大陆区手机号填写国家代码例如：美国填写0001、安道尔0376、巴哈马1242
contactEmail	string	联系人邮箱	强烈建议
contactEmailSuffix	string	联系人邮箱后缀	强烈建议
currency	string	货币	强烈建议	参考货币代码表(ISO4217)
price	double	下单优惠前的金额	建议	货币计量单位为中国大陆法定货币人民币（CNY，单位：元例如：88.69
discount	double	该订单享受的优惠金额	必传参数	商品订单原价–商品订单实际付款的价格
discountType	string	优惠来源	必传参数	如： MEMBERSHIP：绿翼会员立减（长期）FAMILY：亲友立减（长期）ACTIVITY：机票活动立减（短期，主要是中转联程立减）
orderNum	int	机票数量	强烈建议

products的内容如下：

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

startGpsLocation的内容如下：

参数名称	类型	参数说明	是否必传	规范
startCountry	string	订单页面填写的服务开始地所属的国家	强烈建议
startProvince	string	订单页面填写的服务开始地所属的省份（格式：不填“省”，例如填写“广东”）	强烈建议
startCity	string	订单页面填写的服务开始地所属的城市（格式：不填“市”，例如填写“广州”）	强烈建议

endGpsLocation的内容如下：

参数名称	类型	参数说明	是否必传	规范
endCountry	string	订单页面填写的服务结束地所属的国家	强烈建议
endProvince	string	订单页面填写的服务结束地所属的省份（格式：不填“省”，例如填写“广东”）	强烈建议
endCity	string	订单页面填写的服务结束地所属的城市（格式：不填“市”，例如填写“广州”）	强烈建议

取消订单

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
orderId	string	订单ID	强烈建议	该商品订单唯一标识
interval	int64	下订单到取消时间，单位毫秒（ms）	强烈建议	主要用于商品秒杀
nickName	string	用户账户昵称	建议

建立社交关系（匹配/加好友）

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

进入房间

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

离开房间

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

提交表单

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
eventName	string	事件名，表示当前事件类型下的具体事件	必传参数	传入“搜索”
fieldName1	string	参数的名称	必传参数	表单中第一个参数的名称
fieldValue1	string	参数的内容	必传参数	表单中第一个参数的内容
guestId	string	当前业务中提交表单的游客账户ID，当用户以游客身份进入时传入guestId	强烈建议	每个游客账号ID是唯一的，且与其它数美接口guestId保持一致性，长度限制在64个字符以内。
fieldName2	string	参数的名称	建议	表单中第二个参数的名称，若表单中为必传，则此处必传，否则根据影响系数决定是否传入
fieldValue2	string	参数的内容	建议	表单中第二个参数的内容，若表单中为必传，则此处必传，否则根据影响系数决定是否传入
fieldName3	string	参数的名称	建议	表单中第三个参数的名称，若表单中为必传，则此处必传，否则根据影响系数决定是否传入
fieldValue3	string	参数的内容	建议	表单中第三个参数的内容，若表单中为必传，则此处必传，否则根据影响系数决定是否传入
fieldName4	string	参数的名称	建议	表单中第四个参数的名称，若表单中为必传，则此处必传，否则根据影响系数决定是否传入
fieldValue4	string	参数的内容	建议	表单中第四个参数的内容，若表单中为必传，则此处必传，否则根据影响系数决定是否传入
fieldName5	string	参数的名称	建议	表单中第五个参数的名称，若表单中为必传，则此处必传，否则根据影响系数决定是否传入
fieldValue5	string	参数的内容	建议	表单中第五个参数的内容，若表单中为必传，则此处必传，否则根据影响系数决定是否传入
fieldName6	string	参数的名称	建议	表单中第六个参数的名称，若表单中为必传，则此处必传，否则根据影响系数决定是否传入
fieldValue6	string	参数的内容	建议	表单中第六个参数的内容，若表单中为必传，则此处必传，否则根据影响系数决定是否传入
fieldName7	string	参数的名称	建议	表单中第七个参数的名称，若表单中为必传，则此处必传，否则根据影响系数决定是否传入
fieldValue7	string	参数的内容	建议	表单中第七个参数的内容，若表单中为必传，则此处必传，否则根据影响系数决定是否传入
fieldName8	string	参数的名称	建议	表单中第八个参数的名称，若表单中为必传，则此处必传，否则根据影响系数决定是否传入
fieldValue8	string	参数的内容	建议	表单中第八个参数的内容，若表单中为必传，则此处必传，否则根据影响系数决定是否传入
fieldName9	string	参数的名称	建议	表单中第九个参数的名称，若表单中为必传，则此处必传，否则根据影响系数决定是否传入
fieldValue9	string	参数的内容	建议	表单中第九个参数的内容，若表单中为必传，则此处必传，否则根据影响系数决定是否传入
fieldName10	string	参数的名称	建议	表单中第十个参数的名称，若表单中为必传，则此处必传，否则根据影响系数决定是否传入
fieldValue10	string	参数的内容	建议	表单中第十个参数的内容，若表单中为必传，则此处必传，否则根据影响系数决定是否传入
fields	array	优先使用fieldName1-10和fieldValue1-10传入表单的数据，若需再增加表单内容，则使用此字段添加	建议	详见《fields结果详情表》
referId	string	前一个内容或页面ID，可以是URI	强烈建议

其中fields的内容如下：

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

送礼

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
receiveTokenId	string	收礼物的账号ID	必传参数
amount	float64	礼物现金价值	必传参数	货币计量单位为中国大陆法定货币人民币（CNY），单位：元例如：88.69
currency	string	货币	强烈建议	参考货币代码表(ISO4217)
depositCoin	float64	账户剩余虚拟货币价值	建议	货币计量单位为中国大陆法定货币人民币（CNY），单位：元例如：88.69
nickName	string	用户账户昵称	建议
receiveTokenIdLevel	string	表演者账户等级	建议
roomId	string	房间ID	建议
roomMemberCount	int	房间人数（人）	建议
roomShowOpenTimestamp	Int64	房间开始直播时间戳（毫秒）	建议

发起聊天

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
chatId	string	聊天会话id	强烈建议
receiveTokenId	string	主播的账号	必传字段

结束聊天

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
chatId	string	聊天会话id	强烈建议	同一会话的发起聊天和结束聊天的chatId必须保持一致
receiveTokenId	string	主播的账号	必传字段
chatLength	float	聊天时长，单位为秒	强烈建议

获取二维码

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

退款申请

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

refundProducts内容如下：

参数名称	类型	参数说明	是否必传	规范
productId	string	商品ID	必传参数
productCount	int	商品数量	必传参数
productType	string	商品类型	建议	商品的分类，例如：手机、电脑配件、化妆品、电脑笔记本等

退款结果

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

发货

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
orderId	string	订单ID	必传
trackingNum	string	快递编号	必传
trackingCompany	string	快递公司	必传
deliveryTime	int64	发货时间，时间戳格式，单位毫秒(ms）	必传
deliveryCountry	string	收货人地址的国家	选填	国际域名缩写，若不存在传国家英文全称
deliveryProvince	string	收货人地址的省	选填
deliveryCity	string	收货人地址的市	选填
deliveryDistrict	string	收货人地址的区	选填
deliveryAddress	string	收货人地址的详细地址	选填

修改订单

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

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

参数名称	类型	参数说明	是否必传	规范
receiverCountry	string	收货人地址的国家	修改后必传	国际域名缩写，若不存在传国家英文全称
receiverProvince	string	收货人地址的省	修改后必传
receiverCity	string	收货人地址的市	修改后必传
receiverDistrict	string	收货人地址的区	修改后必传
receiverAddress	string	收货人地址的详细地址	修改后必传
deliverType	string	配送方式	修改后必传	可选值： SELF_PICKUP： 自提 EXPRESS： 快递

修改地址

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
exCountry	string	修改前国家	修改后传
newCountry	string	修改后国家	修改后传
exProvince	string	修改前省份	修改后传
newProvince	string	修改后省份	修改后传
exCity	string	修改前市	修改后传
newCity	string	修改后市	修改后传
exDistrict	string	修改前区	修改后传
newDistrict	string	修改后区	修改后传
exAddress	string	修改前详细地址	修改后传
newAddress	string	修改后详细地址	修改后传

加购物车

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
productId	string	商品ID	必传
productType	string	商品类别	必传	商品的分类，例如：手机、电脑配件、化妆品、电脑笔记本等
productName	string	商品名称	强烈建议
productBrand	string	商品品牌	强烈建议
productPrice	float	商品单价	必传
currency	string	计价货币	必传	参考货币代码表(ISO4217) 国际标准化组织 4217标准

参与拼团

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

发起拼团

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

浏览/观看/阅读

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
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

分享

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

浏览帖子

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

收藏

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
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	计价货币	建议

评论

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
comment	string	用户评论的内容	强烈建议	用户评论的内容
commentId	string	评论内容的Id	强烈建议	用户评论内容的id
flightNum	string	被评论的航班号	强烈建议	用户评论的航班号（特殊行业字段）
orderId	string	发表商品评论关联的订单号	强烈建议
productId	String	发表商品评论关联的商品	强烈建议

笔记点赞

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

评论点赞

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

下实物订单

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
products	json array	订单商品信息，详情见下文	必传参数
orderId	string	订单ID	强烈建议	该商品订单唯一标识
paymentId	string	付款ID	强烈建议	用户进行一次下单付款动作的标识；该标识标记了用户发起的一次下单付款行为。
orderNotes	string	订单备注信息	建议	用户在此订单上备注的信息
paymentMethod	string	付款方式	强烈建议	可选值： CASH_ON_DELIVERY：货到付款 ONLINE_PAYMENT：在线支付
interval	int64	商品发布到下单时间，单位毫秒（ms）	强烈建议	主要用于商品秒杀
receiverPhone	string	收货人手机号	强烈建议	中国大陆区手机号请填写11位数字例如：13800138000
receiverPhoneMd5	string	收货人手机号Md5值	强烈建议	MD5加密字符串格式为32位小写例如：d0213fde1643000949161dcb1ed0e605
shippingFee	float64	物流/快递费用	强烈建议	例如：0.00, 6.00
currency	string	货币	强烈建议	参考货币代码表(ISO4217)
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}]
item_price	float64	订单实付价格	必传参数	货币计量单位为中国大陆法定货币人民币 （CNY），单位：元 例如：88.69
order_price	float64	订单原价	建议	货币计量单位为中国大陆法定货币人民币 （CNY），单位：元 例如：88.69
sampleCabinetInfo	json object	到柜领样场景相关的信息，详情见下文	必传参数

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
amount	float	券金额	强烈建议

sampleCabinetInfo的内容如下：

参数名称	类型	参数说明	是否必传	规范
uploadPhotoState	int	上传照片	必传字段	上传照片传1 其余传0
VerificationCodeFirstTimestamp	int64	兑换券（核销码）生成时间戳	必传字段

下虚拟订单

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
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)
orderSource	string	订单来源的枚举值，分为两类： 1、用户购买官方的虚拟商品/充值； 2、用户间的虚拟商品交易，如游戏道具、NFT藏品等	建议	枚举值： mall: 订单来自官方商城，用来记录用户平台商城购买虚拟商品或充值； exchange: 订单来自玩家交易所，用来记录用户间的虚拟商品交易

接受服务订单

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

完成订单

参数名称	类型	参数说明	是否必传	规范
基础参数				需要满足基础参数的配置要求
orderId	string	订单ID	必传参数
price	float64	下单优惠前的金额。单位：元	建议
discount	float64	该订单享受的优惠金额	建议	商品订单原价–商品订单实际支付的价格
discountType	string	优惠来源	建议	可选值： NEW_USER：新用户优惠 REWARD_TASK：奖励任务优惠 PURCHASE：购买
currency	string	货币	强烈建议	参考货币代码表(ISO4217)

取消订单

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

订阅

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

发帖

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

示例：

请求示例：

{

"accessKey": "XXXXXXX",

"eventId": "order",

"appId": "default",

"data": {

"ip": "",

"deviceId": "BQ144b7Xd4TAejWdbWOrB4SI0Gn7vaYxEybz2q22851RoABghw4evlXwXBlPjwY89Iv5kBZjE+nR7WDWFB94IPA==",

"phoneMd5": "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",

"item_price": 88.69,

"sampleCabinetInfo": [

{

"uploadPhotoState": 1,

"VerificationCodeFirstTimestamp": 1465810229852

}

]

}

}

同步返回示例：

{

"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格式，具体参数如下：

请求参数名	类型	参数说明	是否必传	规范
accessKey	string	接口认证密钥 用于权限认证，开通账号服务时由数美提供或使用开通邮箱登录数美后台右上角相关文档处查看	必传参数	数美分配
data	json_object	请求的数据内容	必传参数	请求的数据内容，最长10MB，详见data参数

其中，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	场景账号风险	特殊场景才可取到，如航司等
account_relate_info	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	证据描述	证据细节

示例：

请求示例：

{

"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": {

}

}

]

}

加密传输

在某些场景下，为保障数据安全，我们需要对请求体进行加密处理后再进行传输。 若需开通加密传输方式，请联系数美科技客服人员。 本节将详细介绍如何实现这一过程，重点聚焦于使用SM4国密算法进行加密的实践方法。

支持的加密方式

目前系统支持的加密传输方式主要为：

• SM4国密算法：适用于对安全性有较高要求的场景，符合国家密码管理局的相关标准。

配置与准备

1. 密钥管理：确保加密前，已根据规定配置好加密所需的密钥及组织唯一标识。这些密钥信息由系统管理员提供。
2. 服务端配置：加密传输功能需预先在服务器端设置并上线。包括了密钥配置、组织唯一标识。

加密传输参数说明

当决定采用加密传输时，请求中需包含特定参数以指示加密方式及加密内容，具体如下：

参数名称	类型	参数说明	是否必传	规范
encryptType	string	指定使用的加密方式。	加密传输时必须提供；非加密传输可忽略。	固定值 SM4 表示使用SM4国密算法进行加密。
encryptData	string	经过加密处理后的数据字符串。	与 encryptType 相关联，加密传输时必填；否则无需提供。	使用指定的加密算法（如SM4）对原始请求数据进行加密后得到的结果。

示例请求体结构

一个采用SM4加密的数据传输请求实例，其请求体可能如下所示（仅展示加密相关参数）：

注意： 在SM4加密的数据传输请求中，请求体要求加密内容为JSON格式字符串，例如：{\"field1\":\"敏感数据1\",\"field2\":\"敏感数据2\",\"field3\":\"敏感数据3\"} ，确保信息安全加密处理。

{

"accessKey": "xxx",

"appId": "xxx",

"eventId": "xxx",

"data": {

"encryptType": "SM4",

"encryptData": "ZGYwZTA2MmJhNTU5ZDhkMjBlZWY4MmYwZTYyNTU1OWFjYTI2OGM4ZGFjNjNiNzg4ZDU0MTljMDIzNDRiZDQ4MGU5ODMwYzhkZmI0YzBhMTQ5NWFiMmUxNWFkMjNmMTg1YmQ5YWEyNGM1ZTdkNTI0ZTVlYjc1ZTVhMjhkYTE5MjFiNDU0MzRjODI3NjY0YTgwZWEzMjMyNGQ2NDUyOGNjMQ=="

}

}

示例返回体结构

{

"detail": {

"encryptType": "SM4",

"encryptData": "ZTY5M2E5YWIwZDIwYjU0OWJlYWVhNDg0NTMzYWIyMDU1N2RhZmQ0ZGM4OGY0NjNmMDFjZjI1MTA3YTdkMGY2ZmIyNzA2MDY0MDg1MGU2YmVhNGNmMjIyZjBhNGUyMGE2MWZkODNmYWNmZDA0YTFkNmI5Y2JhYWFmN2YzODVhYTk="

},

"code": 1100,

"message": "成功",

"requestId": "6f58f1d7540cfc6b5d7acc563d6efb6e",

"riskLevel": "PASS"

}

通过遵循上述指南，您可以确保敏感数据在传输过程中得到有效的保护，满足组织的安全合规要求。

附录： 国家码与国家对应关系表

国家码(newCountryCode)	国家(intl_phone_country)	国家码(newCountryCode)	国家(intl_phone_country)
0001	['美国', '加拿大']	0372	['爱沙尼亚']
0007	['俄罗斯', '哈萨克斯坦']	0373	['摩尔多瓦']
0020	['埃及']	0374	['亚美尼亚']
0027	['南非']	0375	['白俄罗斯']
0030	['希腊']	0376	['安道尔']
0031	['荷兰']	0377	['摩纳哥']
0032	['比利时']	0378	['圣马力诺']
0033	['法国']	0379	['梵蒂冈']
0034	['西班牙']	0380	['乌克兰']
0036	['匈牙利']	0381	['塞尔维亚']
0039	['意大利']	0382	['黑山']
0040	['罗马尼亚']	0383	['科索沃']
0041	['瑞士']	0385	['克罗地亚']
0043	['奥地利']	0386	['斯洛文尼亚']
0044	['英国', '泽西岛', '马恩岛', '根西岛']	0387	['波黑']
0045	['丹麦']	0389	['北马其顿']
0046	['瑞典']	0420	['捷克']
0047	['挪威', '斯瓦尔巴岛和扬马延岛']	0421	['斯洛伐克']
0048	['波兰']	0423	['列支敦士登']
0049	['德国']	0500	['福克兰群岛', '南乔治亚岛和南桑威奇群岛']
0051	['秘鲁']	0501	['伯利兹']
0052	['墨西哥']	0502	['危地马拉']
0053	['古巴']	0503	['萨尔瓦多']
0054	['阿根廷']	0504	['洪都拉斯']
0055	['巴西']	0505	['尼加拉瓜']
0056	['智利']	0506	['哥斯达黎加']
0057	['哥伦比亚']	0507	['巴拿马']
0058	['委内瑞拉']	0508	['圣皮埃尔和密克隆']
0060	['马来西亚']	0509	['海地']
0061	['澳大利亚', '赫德岛和麦克唐纳岛']	0590	['瓜德罗普', '圣巴泰勒米', '法属圣马丁']
0062	['印尼', '印度尼西亚']	0591	['玻利维亚']
0063	['菲律宾']	0592	['圭亚那']
0064	['新西兰']	0593	['厄瓜多尔']
0065	['新加坡']	0594	['法属圭亚那']
0066	['泰国']	0595	['巴拉圭']
0081	['日本']	0596	['马提尼克']
0082	['韩国']	0597	['苏里南']
0084	['越南']	0598	['乌拉圭']
0086	['中国']	0599	['库拉索', '荷兰加勒比区', '荷属安的列斯']
0090	['土耳其']	0649	['皮特凯恩']
0091	['印度']	0670	['东帝汶']
0092	['巴基斯坦']	0673	['文莱']
0093	['阿富汗']	0674	['瑙鲁']
0094	['斯里兰卡']	0675	['巴布亚新几内亚']
0095	['缅甸']	0676	['汤加']
0098	['伊朗']	0677	['所罗门群岛']
0210	['西撒哈拉']	0678	['瓦努阿图']
0211	['南苏丹']	0679	['斐济']
0212	['摩洛哥']	0680	['帕劳']
0213	['阿尔及利亚']	0682	['库克群岛']
0216	['突尼斯']	0683	['纽埃']
0218	['利比亚']	0685	['萨摩亚']
0220	['冈比亚']	0686	['基里巴斯']
0221	['塞内加尔']	0687	['新喀里多尼亚']
0222	['毛里塔尼亚']	0688	['图瓦卢']
0223	['马里']	0689	['法属波利尼西亚', '法属南部领地']
0224	['几内亚']	0690	['托克劳']
0225	['科特迪瓦']	0691	['密克罗尼西亚联邦']
0226	['布基纳法索']	0692	['马绍尔群岛']
0227	['尼日尔']	0850	['朝鲜']
0228	['多哥']	0852	['中国']
0229	['贝宁']	0853	['中国']
0230	['毛里求斯']	0855	['柬埔寨']
0231	['利比里亚']	0856	['老挝']
0232	['塞拉利昂']	0880	['孟加拉国', '孟加拉']
0233	['加纳']	0886	['中国']
0234	['尼日利亚']	0960	['马尔代夫']
0235	['乍得']	0961	['黎巴嫩']
0236	['中非']	0962	['约旦']
0237	['喀麦隆']	0963	['叙利亚']
0238	['佛得角']	0964	['伊拉克']
0239	['圣多美和普林西比']	0965	['科威特']
0240	['赤道几内亚']	0966	['沙特阿拉伯']
0241	['加蓬']	0967	['也门']
0242	['刚果共和国', '刚果布']	0968	['阿曼']
0243	['刚果民主共和国', '刚果金']	0970	['巴勒斯坦']
0244	['安哥拉']	0971	['阿联酋']
0245	['几内亚比绍']	0972	['以色列']
0246	['英属印度洋领地']	0973	['巴林']
0248	['塞舌尔']	0974	['卡塔尔']
0249	['苏丹']	0975	['不丹']
0250	['卢旺达']	0976	['蒙古']
0251	['埃塞俄比亚']	0977	['尼泊尔']
0252	['索马里']	0992	['塔吉克斯坦']
0253	['吉布提']	0993	['土库曼斯坦']
0254	['肯尼亚']	0994	['阿塞拜疆']
0255	['坦桑尼亚']	0995	['格鲁吉亚']
0256	['乌干达']	0996	['吉尔吉斯斯坦']
0257	['布隆迪']	0998	['乌兹别克斯坦']
0258	['莫桑比克']	1242	['巴哈马']
0260	['赞比亚']	1246	['巴巴多斯']
0261	['马达加斯加']	1264	['安圭拉']
0262	['留尼汪']	1268	['安提瓜和巴布达']
0263	['津巴布韦']	1284	['英属维尔京群岛']
0264	['纳米比亚']	1340	['美属维尔京群岛']
0265	['马拉维']	1345	['开曼群岛']
0266	['莱索托']	1441	['百慕大']
0267	['博茨瓦纳']	1473	['格林纳达']
0268	['斯威士兰']	1649	['特克斯和凯科斯群岛']
0269	['马约特', '科摩罗']	1664	['蒙塞拉特岛']
0290	['圣赫勒拿']	1670	['北马里亚纳群岛']
0291	['厄立特里亚']	1671	['关岛']
0297	['阿鲁巴']	1681	['瓦利斯和富图纳']
0298	['法罗群岛']	1684	['美属萨摩亚']
0299	['格陵兰']	1721	['荷属圣马丁']
0350	['直布罗陀']	1758	['圣卢西亚']
0351	['葡萄牙']	1767	['多米尼克']
0352	['卢森堡']	1784	['圣文森特和格林纳丁斯']
0353	['爱尔兰']	1787	['波多黎各']
0354	['冰岛']	1809	['多米尼加']
0355	['阿尔巴尼亚']	1868	['特立尼达和多巴哥']
0356	['马耳他']	1869	['圣基茨和尼维斯']
0357	['塞浦路斯']	1876	['牙买加']
0358	['芬兰', '奥兰']	6721	['南极洲']
0359	['保加利亚']	6722	['科科斯（基林）群岛']
0370	['立陶宛']	6723	['诺福克岛']
0371	['拉脱维亚']	6724	['圣诞岛']