You need to enable JavaScript to run this app.
导航
接口列表
最近更新时间:2023.07.05 11:16:19首次发布时间:2021.12.16 18:01:18

1. 注册

当前业务新用户注册流程中,在生成用户账号id之后,实时调用本接口,调用者可根据接口的返回参数进行相应的业务处理。

Service字段取值:register
建议超时:1s
字段名称字段描述字段类型是否必须示例数据
account_id用户的账户ID,唯一标识一个账户string必传101234567
operate_time精确到秒的操作时间戳,格林威治时间,如1522555200)int必传例如,格林威治时间2018-04-01 12:00:00,时间戳为1522555200
install_time安装App时间戳int可传1587778531
bd_did设备稳定标识,需在设备SDK中获取BDDeviceID传入string可传ADBDDEDFALKZLKJFLAKJWLKJL227FAF2L
account_type用户账号注册方式,请从如下类型中选择: mobile, email, wechat, qq, otherstring必传wechat
xmsg只在web端需要。接入web端SDK必传。 web页面接入SDK之后,在指定的请求header中带的参数。string可传BGr+YgfPHsIapGwJVTsFgnMZ67h7ikaY6aVvaZ9OOVCed9lsiu33Hz2GFUDvJpRRHs23+95LE8JlAae/ydex9qC5+ZobjO/RrgTcpxt8XQdHgqEMUj1cmP5N4UCX9CCwU/HsWU7gByJKWavVa1aSx8316+NgwhXO58M+AOLCL4g=
country_code手机号国家码,如86表示中国string可传86
mobile手机号,不包括国家码string可传13811111111
mobile_sha1使用SHA-1算法对1开头,11位纯数字手机号进行加密后的值,40位小写。string强烈建议(和mobile字段二选一)SHA-1前: 13811111111 SHA-1后: 6436d67be51be6080206cca378679f395a6fc27f
mobile7_sha1使用SHA-1算法对11位纯数字手机号的前7位进行加密后的值,40位小写。强烈建议(mobile_sha1传时该字段也必传)SHA-1前: 1381111 SHA-1后: 84e4de5b8ae3dafb6f6e70cb8486f28f7f273253
ip用户操作时真实的IP地址。string必传42.120.74.211
install_ip安装APP时的IP地址string可传42.120.74.211
channelApp下载渠道string必传wandoujia
x_forwarded_for用户http请求的X-Forwarded-For头信息,或其他记录代理信息的http头信息string可传
email邮箱地址string可传example@volcengine.com
nick_name账户昵称string可传example
openidaccount_type 是 QQ 或微信开放账号时需传,如果是 QQ,则填入对应的 openid,微信用户则填入对应的 openidstring可传9130088
unionid微信用户传入获取到的用户的unionidstring可传o6_bmasdasdsad6_2sgVt7hMZOPfL
user_agenthttp请求所带的userAgentstring可传Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.84 Safari/537.36
refererhttp请求所带的refererstring可传https://www.volcengine.com/
app_versionApp版本号string可传1.9.8
device_platform设备平台类型举例:1、android 2. ios 3. wap 4. webstring可传android
user_type用户类型 normal:普通用户 admin:业务系统管理员 white:业务白名单用户string可传normal
avatar_type用户头像的类型. default:默认头像 defined:用户自己上传的头像string可传default
avatar_url头像图片URLstring可传https://xxxx.png

2. 登录

当前业务中登录请求验证完成后调用,在验证成功和验证失败的时候都需要进行调用。

Service字段取值:login

建议超时:1s
字段名称字段描述字段类型是否必须示例数据
account_id用户的账户ID,唯一标识一个账户string必传101234567
operate_time精确到秒的操作时间戳,格林威治时间,如1522555200)int必传例如,格林威治时间2018-04-01 12:00:00,时间戳为1522555200
install_time安装App时间戳int可传1587778531
bd_did设备稳定标识,需在设备SDK中获取BDDeviceID传入string可传ADBDDEDFALKZLKJFLAKJWLKJL227FAF2L
country_code手机号国家码,如86表示中国string可传86
mobile手机号,不包括国家码string可传13811111111
mobile_sha1使用SHA-1算法对1开头,11位纯数字手机号进行加密后的值,40位小写。string强烈建议(和mobile字段二选一)SHA-1前: 13811111111 SHA-1后: 6436d67be51be6080206cca378679f395a6fc27f
mobile7_sha1使用SHA-1算法对11位纯数字手机号的前7位进行加密后的值,40位小写。强烈建议(mobile_sha1传时该字段也必传)SHA-1前: 1381111 SHA-1后: 84e4de5b8ae3dafb6f6e70cb8486f28f7f273253
ip用户操作时真实的IP地址。string必传42.120.74.211
install_ip安装APP时的IP地址string可传42.120.74.211
xmsg只在web端需要。接入web端SDK必传。 web页面接入SDK之后,在指定的请求header中带的参数。string可传BGr+YgfPHsIapGwJVTsFgnMZ67h7ikaY6aVvaZ9OOVCed9lsiu33Hz2GFUDvJpRRHs23+95LE8JlAae/ydex9qC5+ZobjO/RrgTcpxt8XQdHgqEMUj1cmP5N4UCX9CCwU/HsWU7gByJKWavVa1aSx8316+NgwhXO58M+AOLCL4g=
channelApp下载渠道string必传wandoujia
x_forwarded_for用户http请求的X-Forwarded-For头信息,或其他记录代理信息的http头信息string可传
email邮箱地址string可传example@volcengine.com
nick_name账户昵称string可传example
openidaccount_type 是 QQ 或微信开放账号时需传,如果是 QQ,则填入对应的 openid,微信用户则填入对应的 openidstring可传9130088
unionid微信用户传入获取到的用户的unionidstring可传o6_bmasdasdsad6_2sgVt7hMZOPfL
register_time该账户注册时间,精确到秒的时间戳,格林威治时间int可传1522555200
login_type登录方式: password:手动帐号密码输入 sms:动态短信密码登录 qr_code:二维码扫描登录 wechat: 第三方微信登录 qq: 第三方QQ登录 other:其他string可传sms
user_name_type如果login_type是password,登录时所选择的账户名类型,请从如下类型中选择:mobile, email, nick_name, otherstring可传mobile
register_ip该账户注册时所用ipstring可传42.120.74.211
login_result登录是否成功bool可传true
fail_reason登录失败的原因,请从如下类型中选择: wrong_password:用户名或密码错误 business_risk: 业务自己判定有风险 other: 其他string可传wrongPassword
user_agenthttp请求所带的userAgentstring可传Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.84 Safari/537.36
refererhttp请求所带的refererstring可传https://www.volcengine.com/
app_versionApp版本号string可传1.9.8
device_platform设备平台类型举例:1、android 2. ios 3. wap 4. webstring可传android
user_type用户类型 punished:被处罚的用户,例如被封禁 normal:未被处罚的普通用户 admin:业务系统管理员 white:业务白名单用户string可传normal
avatar_type用户头像的类型. default:默认头像 defined:用户自己上传的头像string可传default
avatar_url头像图片URLstring可传https://xxxx.png

3. 发起邀请

在用户裂变场景中,用户发起裂变邀请时,实时调用本接口,调用者可根据接口的返回结果进行相应的业务处理。

Service字段取值:send_invite

建议超时:1s
字段名称字段描述字段类型是否必须示例数据
account_id用户的账户ID,唯一标识一个账户string必传101234567
operate_time精确到秒的操作时间戳,格林威治时间,如1522555200)int必传例如,格林威治时间2018-04-01 12:00:00,时间戳为1522555200
install_time安装App时间戳int可传1587778531
bd_did设备稳定标识,需在设备SDK中获取BDDeviceID传入string可传ADBDDEDFALKZLKJFLAKJWLKJL227FAF2L
country_code手机号国家码,如86表示中国string可传86
mobile手机号,不包括国家码string可传13811111111
mobile_sha1使用SHA-1算法对1开头,11位纯数字手机号进行加密后的值,40位小写。string强烈建议(和mobile字段二选一)SHA-1前: 13811111111 SHA-1后: 6436d67be51be6080206cca378679f395a6fc27f
mobile7_sha1使用SHA-1算法对11位纯数字手机号的前7位进行加密后的值,40位小写。强烈建议(mobile_sha1传时该字段也必传)SHA-1前: 1381111 SHA-1后: 84e4de5b8ae3dafb6f6e70cb8486f28f7f273253
ip用户操作时真实的IP地址。string必传42.120.74.211
install_ip安装APP时的IP地址string可传42.120.74.211
xmsg只在web端需要。接入web端SDK必传。 web页面接入SDK之后,在指定的请求header中带的参数。string可传BGr+YgfPHsIapGwJVTsFgnMZ67h7ikaY6aVvaZ9OOVCed9lsiu33Hz2GFUDvJpRRHs23+95LE8JlAae/ydex9qC5+ZobjO/RrgTcpxt8XQdHgqEMUj1cmP5N4UCX9CCwU/HsWU7gByJKWavVa1aSx8316+NgwhXO58M+AOLCL4g=
channelApp下载渠道string必传wandoujia
x_forwarded_for用户http请求的X-Forwarded-For头信息,或其他记录代理信息的http头信息string可传
email邮箱地址string可传example@volcengine.com
nick_name账户昵称string可传example
openidaccount_type 是 QQ 或微信开放账号时需传,如果是 QQ,则填入对应的 openid,微信用户则填入对应的 openidstring可传9130088
unionid微信用户传入获取到的用户的unionidstring可传o6_bmasdasdsad6_2sgVt7hMZOPfL
register_time该账户注册时间,精确到秒的时间戳,格林威治时间int可传1522555200
login_type登录方式: password:手动帐号密码输入 sms:动态短信密码登录 qr_code:二维码扫描登录 wechat: 第三方微信登录 qq: 第三方QQ登录 other:其他string可传sms
user_name_type如果login_type是password,登录时所选择的账户名类型,请从如下类型中选择:mobile, email, nick_name, otherstring可传mobile
register_ip该账户注册时所用ipstring可传42.120.74.211
login_result登录是否成功bool可传true
fail_reason登录失败的原因,请从如下类型中选择: wrong_password:用户名或密码错误 business_risk: 业务自己判定有风险 other: 其他string可传wrongPassword
user_agenthttp请求所带的userAgentstring可传Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.84 Safari/537.36
refererhttp请求所带的refererstring可传https://www.volcengine.com/
app_versionApp版本号string可传1.9.8
device_platform设备平台类型举例:1、android 2. ios 3. wap 4. webstring可传android
user_type用户类型 punished:被处罚的用户,例如被封禁 normal:未被处罚的普通用户 admin:业务系统管理员 white:业务白名单用户string可传normal
avatar_type用户头像的类型. default:默认头像 defined:用户自己上传的头像string可传default
avatar_url头像图片URLstring可传https://xxxx.png

4. 接受邀请

当前业中场景中,接受邀请且邀请关系成功建立时,实时调用本接口,调用者可根据接口的返回结果进行相应的业务处理。

Service字段取值:accept_invite

建议超时:1s
字段名称字段描述字段类型是否必须示例数据
master_id邀请人的账户idstring必传101234567
group_id用户接受拼团时的拼团号string可传113578
account_id用户的账户ID,唯一标识一个账户string必传101234579
operate_time精确到秒的操作时间戳,格林威治时间,如1522555200)int必传例如,格林威治时间2018-04-01 12:00:00,时间戳为1522555200
install_time安装App时间戳int1587778531
install_ip安装APP时的IP地址string42.120.74.211
channelApp下载渠道stringwandoujia
xmsg只在web端需要。接入web端SDK必传。 web页面接入SDK之后,在指定的请求header中带的参数。string可传BGr+YgfPHsIapGwJVTsFgnMZ67h7ikaY6aVvaZ9OOVCed9lsiu33Hz2GFUDvJpRRHs23+95LE8JlAae/ydex9qC5+ZobjO/RrgTcpxt8XQdHgqEMUj1cmP5N4UCX9CCwU/HsWU7gByJKWavVa1aSx8316+NgwhXO58M+AOLCL4g=
bd_did设备稳定标识,需在设备SDK中获取BDDeviceID传入string可传ADBDDEDFALKZLKJFLAKJWLKJL227FAF2L
account_type用户账号注册方式,请从如下类型中选择: mobile, email, wechat, qq, otherstring必传wechat
country_code手机号国家码,如86表示中国string可传86
mobile手机号,不包括国家码string可传13811111111
mobile_sha1使用SHA-1算法对1开头,11位纯数字手机号进行加密后的值,40位小写。string强烈建议(和mobile字段二选一)SHA-1前: 13811111111 SHA-1后: 6436d67be51be6080206cca378679f395a6fc27f
mobile7_sha1使用SHA-1算法对11位纯数字手机号的前7位进行加密后的值,40位小写。强烈建议(mobile_sha1传时该字段也必传)SHA-1前: 1381111 SHA-1后: 84e4de5b8ae3dafb6f6e70cb8486f28f7f273253
ip用户操作时真实的IP地址。string必传42.120.74.211
x_forwarded_for用户http请求的X-Forwarded-For头信息,或其他记录代理信息的http头信息string可传
email邮箱地址string可传example@volcengine.com
nick_name账户昵称string可传example
openidaccount_type 是 QQ 或微信开放账号时需传,如果是 QQ,则填入对应的 openid,微信用户则填入对应的 openidstring可传9130088
unionid微信用户传入获取到的用户的unionidstring可传o6_bmasdasdsad6_2sgVt7hMZOPfL
user_agenthttp请求所带的userAgentstring可传Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.84 Safari/537.36
refererhttp请求所带的refererstring可传https://www.volcengine.com/
app_versionApp版本号string可传1.9.8
device_platform设备平台类型举例:1、android 2. ios 3. wap 4. webstring可传android
user_type用户类型 normal:普通用户 admin:业务系统管理员 white:业务白名单用户string可传normal
avatar_type用户头像的类型. default:默认头像 defined:用户自己上传的头像string可传default
avatar_url头像图片URLstring可传https://xxxx.png

5. 获利行为

做签到、玩小游戏、领取优惠券、抢红包、抽奖等可获益的行为,实时调用本接口,调用者可根据接口的返回参数进行相应的业务处理。

Service字段取值:activity

建议超时:1s
字段名称字段描述字段类型是否必须示例数据
activity_id活动idstring必传hongbao1
activity_type活动类型 签到:sign,抽奖:lottery,领券:coupon,抢红包:envelope,玩游戏:game,其他:otherstring必传sign
account_id用户的账户ID,唯一标识一个账户string必传101234579
operate_time精确到秒的操作时间戳,格林威治时间,如1522555200)int必传例如,格林威治时间2018-04-01 12:00:00,时间戳为1522555200
install_time安装App时间戳int1587778531
install_ip安装APP时的IP地址string42.120.74.211
xmsg只在web端需要。接入web端SDK必传。 web页面接入SDK之后,在指定的请求header中带的参数。string可传BGr+YgfPHsIapGwJVTsFgnMZ67h7ikaY6aVvaZ9OOVCed9lsiu33Hz2GFUDvJpRRHs23+95LE8JlAae/ydex9qC5+ZobjO/RrgTcpxt8XQdHgqEMUj1cmP5N4UCX9CCwU/HsWU7gByJKWavVa1aSx8316+NgwhXO58M+AOLCL4g=
channelApp下载渠道stringwandoujia
bd_did设备稳定标识,需在设备SDK中获取BDDeviceID传入string可传ADBDDEDFALKZLKJFLAKJWLKJL227FAF2L
account_type用户账号注册方式,请从如下类型中选择: mobile, email, wechat, qq, otherstring必传wechat
country_code手机号国家码,如86表示中国string可传86
mobile手机号,不包括国家码string可传13811111111
mobile_sha1使用SHA-1算法对1开头,11位纯数字手机号进行加密后的值,40位小写。string强烈建议(和mobile字段二选一)SHA-1前: 13811111111 SHA-1后: 6436d67be51be6080206cca378679f395a6fc27f
mobile7_sha1使用SHA-1算法对11位纯数字手机号的前7位进行加密后的值,40位小写。强烈建议(mobile_sha1传时该字段也必传)SHA-1前: 1381111 SHA-1后: 84e4de5b8ae3dafb6f6e70cb8486f28f7f273253
ip用户操作时真实的IP地址。string必传42.120.74.211
x_forwarded_for用户http请求的X-Forwarded-For头信息,或其他记录代理信息的http头信息string可传
email邮箱地址string可传example@volcengine.com
nick_name账户昵称string可传example
openidaccount_type 是 QQ 或微信开放账号时需传,如果是 QQ,则填入对应的 openid,微信用户则填入对应的 openidstring可传9130088
unionid微信用户传入获取到的用户的unionidstring可传o6_bmasdasdsad6_2sgVt7hMZOPfL
user_agenthttp请求所带的userAgentstring可传Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.84 Safari/537.36
refererhttp请求所带的refererstring可传https://www.volcengine.com/
app_versionApp版本号string可传1.9.8
device_platform设备平台类型举例:1、android 2. ios 3. wap 4. webstring可传android
user_type用户类型 normal:普通用户 admin:业务系统管理员 white:业务白名单用户string可传normal
avatar_type用户头像的类型. default:默认头像 defined:用户自己上传的头像string可传default

6. 提现

当前业中场景中,用户提现,实时调用本接口,调用者可根据接口的返回参数进行相应的业务理。

Service字段取值:withdrawal

建议超时:1s
字段名称字段描述字段类型是否必须示例数据
account_id用户的账户ID,唯一标识一个账户string必传101234579
withdrawal_amount提现金额,单位为分(中国大陆货币人民币),100分 = 1元int必传688(表示6元8毛8分)
withdrawal_account_id提现账户ID,如支付宝账户IDstring必传12341
withdrawal_type提现账户类型 bank: 银行卡 weixin: 微信 alipay: 支付宝 other: 其他string可传bank
operate_time精确到秒的操作时间戳,格林威治时间,如1522555200)int必传例如,格林威治时间2018-04-01 12:00:00,时间戳为1522555200
install_time安装App时间戳int可传1587778531
install_ip安装APP时的IP地址string可传42.120.74.211
channelApp下载渠道string可传wandoujia
bd_did设备稳定标识,需在设备SDK中获取BDDeviceID传入string可传ADBDDEDFALKZLKJFLAKJWLKJL227FAF2L
account_type用户账号注册方式,请从如下类型中选择: mobile, email, wechat, qq, otherstring必传wechat
country_code手机号国家码,如86表示中国string可传86
mobile手机号,不包括国家码string可传13811111111
mobile_sha1使用SHA-1算法对1开头,11位纯数字手机号进行加密后的值,40位小写。string强烈建议(和mobile字段二选一)SHA-1前: 13811111111 SHA-1后: 6436d67be51be6080206cca378679f395a6fc27f
mobile7_sha1使用SHA-1算法对11位纯数字手机号的前7位进行加密后的值,40位小写。强烈建议(mobile_sha1传时该字段也必传)SHA-1前: 1381111 SHA-1后: 84e4de5b8ae3dafb6f6e70cb8486f28f7f273253
ip用户操作时真实的IP地址。string必传42.120.74.211
xmsg只在web端需要。接入web端SDK必传。 web页面接入SDK之后,在指定的请求header中带的参数。string可传BGr+YgfPHsIapGwJVTsFgnMZ67h7ikaY6aVvaZ9OOVCed9lsiu33Hz2GFUDvJpRRHs23+95LE8JlAae/ydex9qC5+ZobjO/RrgTcpxt8XQdHgqEMUj1cmP5N4UCX9CCwU/HsWU7gByJKWavVa1aSx8316+NgwhXO58M+AOLCL4g=
channelApp下载渠道string可传wandoujia
x_forwarded_for用户http请求的X-Forwarded-For头信息,或其他记录代理信息的http头信息string可传
email邮箱地址string可传example@volcengine.com
nick_name账户昵称string可传example
openidaccount_type 是 QQ 或微信开放账号时需传,如果是 QQ,则填入对应的 openid,微信用户则填入对应的 openidstring可传9130088
unionid微信用户传入获取到的用户的unionidstring可传o6_bmasdasdsad6_2sgVt7hMZOPfL
user_agenthttp请求所带的userAgentstring可传Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.84 Safari/537.36
refererhttp请求所带的refererstring可传https://www.volcengine.com/
app_versionApp版本号string可传1.9.8
device_platform设备平台类型举例:1、android 2. ios 3. wap 4. webstring可传android
user_type用户类型 normal:普通用户 admin:业务系统管理员 white:业务白名单用户string可传normal
avatar_type用户头像的类型. default:默认头像 defined:用户自己上传的头像string可传default
avatar_url头像图片URLstring可传https://xxxx.png

7. 反爬取

浏览商品、视频、文章等高价值数据时,实时调用本接口,调用者可根据接口的返回结果进行相应的业务处理。

Service字段取值:anti-crawl

建议超时:1s

APP端接入参数:

字段名称字段描述字段类型是否必须示例数据
api客户端请求APIString必传http://api-event.antispam.com/v1
api_type页面类型 register:注册页面 login:登录页面 search:搜索 home_page:首页 download:下载文书 detail_page:访问详情页 upload:上传 clear:清空string必传search
account_id用户的账户ID,唯一标识一个账户string必传101234579
operate_time精确到秒的操作时间戳,格林威治时间,如1522555200)int必传例如,格林威治时间2018-04-01 12:00:00,时间戳为1522555200
install_time安装App时间戳int可传1587778531
install_ip安装APP时的IP地址string可传42.120.74.211
channelApp下载渠道string必传wandoujia
bd_did设备稳定标识,需在设备SDK中获取BDDeviceID传入string可传ADBDDEDFALKZLKJFLAKJWLKJL227FAF2L
ip用户操作时真实的IP地址。string必传42.120.74.211
is_vip是否是付费用户 1:付费用户 0:免费用户int可传1
xmsg只在web端需要。接入web端SDK必传。 web页面接入SDK之后,在指定的请求header中带的参数。string可传BGr+YgfPHsIapGwJVTsFgnMZ67h7ikaY6aVvaZ9OOVCed9lsiu33Hz2GFUDvJpRRHs23+95LE8JlAae/ydex9qC5+ZobjO/RrgTcpxt8XQdHgqEMUj1cmP5N4UCX9CCwU/HsWU7gByJKWavVa1aSx8316+NgwhXO58M+AOLCL4g=
search_text搜索词string搜索场景下必传"未成年"
search_type搜索类型 例如:国家法律_标题_模糊查询 也可传code码,将映射关系同步到火山引擎侧。string搜索场景下必传国家法律_标题_模糊查询
content_id内容IDint下载文书场景下必传案例id、法律id等
device_platform平台系统类型string必传web
os操作系统string必传windows
openidaccount_type 是 QQ 或微信开放账号时需传,如果是 QQ,则填入对应的 openid,微信用户则填入对应的 openidstring可传9130088
unionid微信用户传入获取到的用户的unionidstring可传o6_bmasdasdsad6_2sgVt7hMZOPfL
user_agenthttp请求所带的userAgentstring必传Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.84 Safari/537.36
user_paramsB端原始业务参数,json格式string可传"{\"page\":\"64\"}"
app_versionApp版本号string必传1.9.8
latitude纬度string可传39.23
longitude经度string可传12.32

web端接入参数:

字段名称字段描述字段类型是否必须示例数据
api客户端请求APIString必传http://api-event.antispam.com/v1
api_type页面类型 register:注册页面 login:登录页面 search:搜索 home_page:首页 download:下载文书 detail_page:访问详情页 upload:上传 clear:清空string必传search
account_id用户的账户ID,唯一标识一个账户string必传101234579
operate_time精确到秒的操作时间戳,格林威治时间,如1522555200)int必传例如,格林威治时间2018-04-01 12:00:00,时间戳为1522555200
bd_did设备稳定标识,需在设备SDK中获取BDDeviceID传入string可传ADBDDEDFALKZLKJFLAKJWLKJL227FAF2L
ip用户操作时真实的IP地址。string必传42.120.74.211
search_text搜索词string搜索场景下必传"未成年"
search_type搜索类型 例如:国家法律_标题_模糊查询 也可传code码,将映射关系同步到火山引擎侧。string搜索场景下必传国家法律_标题_模糊查询
content_id内容IDint下载文书场景下必传案例id、法律id等
device_platform平台系统类型string必传web
os操作系统string必传windows
referer当前流量的来源页面string必传faxin.cn
root_referer第一次进入法信的来源页面string必传faxin.cn
cookie_enabled是否禁用cookiestring必传1
screen_width屏幕宽度string必传
screen_height屏幕高度string必传
browser_language浏览器语言string必传pt-BR
browser_platform浏览器平台string必传Win32
browser_name浏览器名string必传Mozilla
browser_version浏览器版本string必传
browser_online浏览器是否在线 ,在线:1,离线:0string必传1
openidaccount_type 是 QQ 或微信开放账号时需传,如果是 QQ,则填入对应的 openid,微信用户则填入对应的 openidstring可传9130088
unionid微信用户传入获取到的用户的unionidstring可传o6_bmasdasdsad6_2sgVt7hMZOPfL
user_agenthttp请求所带的userAgentstring可传Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.84 Safari/537.36
user_paramsB端原始业务参数,json格式string可传"{\"page\":\"64\"}"

8. 喜好

用户对内容或作者完成点赞、收藏、关注、订阅、送礼等行为时,实时调用本接口,调用者可根据接口的返回参数进行相应的业务处理。

Service字段取值:interest

建议超时:1s
字段名称字段描述字段类型是否必须示例数据
account_id用户的账户ID,唯一标识一个账户string必传101234567
operate_time精确到秒的操作时间戳,格林威治时间,如1522555200)int必传例如,格林威治时间2018-04-01 12:00:00,时间戳为1522555200
bd_did设备稳定标识,需在设备SDK中获取BDDeviceID传入string可传ADBDDEDFALKZLKJFLAKJWLKJL227FAF2L
interest_type被喜好的类型 点赞:like,收藏:collect,关注:follow,订阅:subscribe,送礼:gift,其他:otherstring必传like
receive_account_id被喜好内容拥有者的账户IDstring可传101234568
receive_object_id被喜好的作品IDstring可传102314242
amount送礼或订阅花费的金额float可传2.3
account_type用户账号注册方式,请从如下类型中选择: mobile, email, wechat, qq, otherstring必传wechat
country_code手机号国家码,如86表示中国string可传86
mobile手机号,不包括国家码string可传13811111111
mobile_sha1使用SHA-1算法对1开头,11位纯数字手机号进行加密后的值,40位小写。string强烈建议(和mobile字段二选一)SHA-1前: 13811111111 SHA-1后: 6436d67be51be6080206cca378679f395a6fc27f
mobile7_sha1使用SHA-1算法对11位纯数字手机号的前7位进行加密后的值,40位小写。强烈建议(mobile_sha1传时该字段也必传)SHA-1前: 1381111 SHA-1后: 84e4de5b8ae3dafb6f6e70cb8486f28f7f273253
ip用户操作时真实的IP地址。string必传42.120.74.211
xmsg只在web端需要。接入web端SDK必传。 web页面接入SDK之后,在指定的请求header中带的参数。string可传BGr+YgfPHsIapGwJVTsFgnMZ67h7ikaY6aVvaZ9OOVCed9lsiu33Hz2GFUDvJpRRHs23+95LE8JlAae/ydex9qC5+ZobjO/RrgTcpxt8XQdHgqEMUj1cmP5N4UCX9CCwU/HsWU7gByJKWavVa1aSx8316+NgwhXO58M+AOLCL4g=
channelApp下载渠道string可传wandoujia
x_forwarded_for用户http请求的X-Forwarded-For头信息,或其他记录代理信息的http头信息string可传
email邮箱地址string可传example@volcengine.com
nick_name账户昵称string可传example
openidaccount_type 是 QQ 或微信开放账号时需传,如果是 QQ,则填入对应的 openid,微信用户则填入对应的 openidstring可传9130088
unionid微信用户传入获取到的用户的unionidstring可传o6_bmasdasdsad6_2sgVt7hMZOPfL
user_agenthttp请求所带的userAgentstring可传Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.84 Safari/537.36
refererhttp请求所带的refererstring可传https://www.volcengine.com/
app_versionApp版本号string可传1.9.8
device_platform设备平台类型举例:1、android 2. ios 3. wap 4. webstring可传android
user_type用户类型 normal:普通用户 admin:业务系统管理员 white:业务白名单用户string可传normal
avatar_type用户头像的类型. default:默认头像 defined:用户自己上传的头像string可传default
avatar_url头像图片URLstring可传https://xxxx.png

9. 聊天

用户发生聊天等行为时,实时调用本接口,调用者可根据接口的返回参数进行相应的业务处理。

Service字段取值:im

建议超时:1s
字段名称字段描述字段类型是否必传示例数据
account_id用户的账户ID,唯一标识一个账户string必传101234579
text聊天/私信的文本内容string必传加V 28391248
channel_type聊天频道类型,公开频道:world,单聊频道:singlestring可传single
operate_time该玩家发言时间戳, 精确到秒int必传1823778531
ip用户操作时真实的IP地址string可传42.120.74.211
xmsg只在web端需要。接入web端SDK必传。 web页面接入SDK之后,在指定的请求header中带的参数。string可传BGr+YgfPHsIapGwJVTsFgnMZ67h7ikaY6aVvaZ9OOVCed9lsiu33Hz2GFUDvJpRRHs23+95LE8JlAae/ydex9qC5+ZobjO/RrgTcpxt8XQdHgqEMUj1cmP5N4UCX9CCwU/HsWU7gByJKWavVa1aSx8316+NgwhXO58M+AOLCL4g=
install_time安装App时间戳int可传1587778531
install_ip安装APP时的IP地址string可传42.120.74.211
channelApp下载渠道string可传wandoujia
bd_did设备稳定标识,需在设备SDK中获取BDDeviceID传入string可传ADBDDEDFALKZLKJFLAKJWLKJL227FAF2L
nick_name账户昵称string可传example
signature账户个性签名string可传个性签名
account_type用户账号注册方式,请从如下类型中选择: mobile, email, wechat, qq, otherstring必传wechat
country_code手机号国家码,如86表示中国string可传86
mobile手机号,不包括国家码string可传13811111111
mobile_sha1使用SHA-1算法对1开头,11位纯数字手机号进行加密后的值,40位小写。string强烈建议(和mobile字段二选一)SHA-1前: 13811111111 SHA-1后: 6436d67be51be6080206cca378679f395a6fc27f
mobile7_sha1使用SHA-1算法对11位纯数字手机号的前7位进行加密后的值,40位小写。强烈建议(mobile_sha1传时该字段也必传)SHA-1前: 1381111 SHA-1后: 84e4de5b8ae3dafb6f6e70cb8486f28f7f273253
x_forwarded_for用户http请求的X-Forwarded-For头信息,或其他记录代理信息的http头信息string可传
email邮箱地址string可传example@volcengine.com
openidaccount_type 是 QQ 或微信开放账号时需传,如果是 QQ,则填入对应的 openid,微信用户则填入对应的 openidstring可传9130088
unionid微信用户传入获取到的用户的unionidstring可传o6_bmasdasdsad6_2sgVt7hMZOPfL
user_agenthttp请求所带的userAgentstring可传Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.84 Safari/537.36
refererhttp请求所带的refererstring可传https://www.volcengine.com/
app_versionApp版本号string可传1.9.8
device_platform设备平台类型举例:1、android 2. ios 3. wap 4. webstring可传android
user_type用户类型 normal:普通用户 admin:业务系统管理员 white:业务白名单用户string可传normal
avatar_type用户头像的类型. default:默认头像 defined:用户自己上传的头像string可传default
avatar_url头像图片URLstring可传https://xxxx.png

10. 群聊

用户发生聊天(群聊)行为时,实时调用本接口,调用者可根据接口的返回参数进行相应的业务处理。

Service字段取值:group_im

建议超时:1s
字段名称字段描述字段类型是否必传示例数据
account_id用户的账户ID,唯一标识一个账户string必传101234579
text聊天/私信的文本内容string必传加V 28391248
operate_time该用户发言时间戳, 精确到秒int必传1823778531
group_name群名string可传一起炒股,共同致富
group_id群唯一IDstring可传518888
group_admin群主IDstring可传101234588
group_level群等级string可传25
group_create_time群创建时间,秒级时间戳int可传1823778531
group_notice群公告string可传进群都下载xx软件,大家一起致富
vip_level用户的vip等级(可自定义,同时需要将定义内容同步给火山侧)string可传10
ip用户操作时真实的IP地址string可传42.120.74.211
xmsg只在web端需要。接入web端SDK必传。 web页面接入SDK之后,在指定的请求header中带的参数。string可传BGr+YgfPHsIapGwJVTsFgnMZ67h7ikaY6aVvaZ9OOVCed9lsiu33Hz2GFUDvJpRRHs23+95LE8JlAae/ydex9qC5+ZobjO/RrgTcpxt8XQdHgqEMUj1cmP5N4UCX9CCwU/HsWU7gByJKWavVa1aSx8316+NgwhXO58M+AOLCL4g=
install_time安装App时间戳int可传1587778531
install_ip安装APP时的IP地址string可传42.120.74.211
channelApp下载渠道string可传wandoujia
bd_did设备稳定标识,需在设备SDK中获取BDDeviceID传入string可传ADBDDEDFALKZLKJFLAKJWLKJL227FAF2L
nick_name账户昵称string可传example
signature账户个性签名string可传个性签名
account_type用户账号注册方式,请从如下类型中选择: mobile, email, wechat, qq, otherstring必传wechat
country_code手机号国家码,如86表示中国string可传86
mobile手机号,不包括国家码string可传13811111111
mobile_sha1使用SHA-1算法对1开头,11位纯数字手机号进行加密后的值,40位小写。string强烈建议(和mobile字段二选一)SHA-1前: 13811111111 SHA-1后: 6436d67be51be6080206cca378679f395a6fc27f
mobile7_sha1使用SHA-1算法对11位纯数字手机号的前7位进行加密后的值,40位小写。强烈建议(mobile_sha1传时该字段也必传)SHA-1前: 1381111 SHA-1后: 84e4de5b8ae3dafb6f6e70cb8486f28f7f273253
x_forwarded_for用户http请求的X-Forwarded-For头信息,或其他记录代理信息的http头信息string可传
email邮箱地址string可传example@volcengine.com
openidaccount_type 是 QQ 或微信开放账号时需传,如果是 QQ,则填入对应的 openid,微信用户则填入对应的 openidstring可传9130088
unionid微信用户传入获取到的用户的unionidstring可传o6_bmasdasdsad6_2sgVt7hMZOPfL
user_agenthttp请求所带的userAgentstring可传Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.84 Safari/537.36
refererhttp请求所带的refererstring可传https://www.volcengine.com/
app_versionApp版本号string可传1.9.8
device_platform设备平台类型举例:1、android 2. ios 3. wap 4. webstring可传android
user_type用户类型 normal:普通用户 admin:业务系统管理员 white:业务白名单用户string可传normal
avatar_type用户头像的类型. default:默认头像 defined:用户自己上传的头像string可传default
avatar_url头像图片URLstring可传https://xxxx.png

11. 发送短信验证码

给客户发送短信验证码时上报。

Service字段取值:send_sms_verify

建议超时:1s
字段名称字段描述字段类型是否必传示例数据
account_id买家唯一表述IDstring必传101234579
operate_time精确到秒的操作时间戳,格林威治时间,如1522555200)string必传1823778531
bd_did设备稳定标识,需在设备SDK中获取BDDeviceID传入string可传ADBDDEDFALKZLKJFLAKJWLKJL227FAF2
ip用户操作时真实的IP地址string可传42.120.74.211
device_platform设备平台类型举例:1、android 2. ios 3. wap 4. webstring可传android
xmsg只在web端需要。接入web端SDK必传。 web页面接入SDK之后,在指定的请求header中带的参数。string可传BGr+YgfPHsIapGwJVTsFgnMZ67h7ikaY6aVvaZ9OOVCed9lsiu33Hz2GFUDvJpRRHs23+95LE8JlAae/ydex9qC5+ZobjO/RrgTcpxt8XQdHgqEMUj1cmP5N4UCX9CCwU/HsWU7gByJKWavVa1aSx8316+NgwhXO58M+AOLCL4g=
event_id事件,1下单,2支付int必传1
order_id订单IDstring必传3258387421
order_type订单类型,普通商品、秒杀等int必传1
product_id商品IDstring必传3258387421
product_type商品类别,鞋类、数码等int必传1
product_price商品价格int必传234
pay_money买家实际支付的金额int必传210
payment_method付款方式,如微信支付、信用卡、银联等int必传3
coupon_id平台优惠券ID,多种优惠券依次记录string必传4231,5210,4321
coupon_count平台优惠券数量,多种优惠券依次记录string必传1,2,3
platform_coupon_money平台优惠券金额,多种优惠券依次记录string必传21,21,32
recipient_name收件人姓名string必传韩梅梅
recipient_number收件人电话string必传13838038438
post_province收件省份string必传浙江
post_city收件城市string必传杭州
post_district收件所属区string必传萧山
post_detail收件详细地址string必传浙江省杭州市萧山区幸福路203号幸福小区138号
historical_purchase_count账号历史购物数量,不包含本次购物int可传3
historical_purchase_amount账号历史购物金额,不包含本次购物int可传300
historical_post_count账号历史购物地址数量去重,不包含本次购物int可传2
account_creation_time账号创建时间string可传1504909487
app_versionApp版本号string可传2.2.1
pay_openid支付端账号openidstring可传319196287

12. 账号风险查询

在需要获取账号风险信息时调用本接口。

Service字段取值:account_risk

建议超时:1s
字段名称字段描述字段类型是否必须示例数据
operate_time请求接口时的时间戳,可取当前时间,秒级时间戳int必传例如,格林威治时间2018-04-01 12:00:00,时间戳为1522555200
bd_did设备稳定标识,需在设备SDK中获取BDDeviceID传入string可传ADBDDEDFALKZLKJFLAKJWLKJL227FAF2L
country_code手机号国家码,如86表示中国string必传86
mobile手机号,不包括国家码string必传13811111111
mobile_sha1使用SHA-1算法对1开头,11位纯数字手机号进行加密后的值,40位小写。string必传(和mobile字段二选一)SHA-1前: 13811111111 SHA-1后: 6436d67be51be6080206cca378679f395a6fc27f
ip用户操作时真实的IP地址。string必传42.120.74.211