当前业务新用户注册流程中,在生成用户账号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, other | string | 必传 | |
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 |
channel | App下载渠道 | string | 必传 | wandoujia |
x_forwarded_for | 用户http请求的X-Forwarded-For头信息,或其他记录代理信息的http头信息 | string | 可传 | |
邮箱地址 | string | 可传 | example@volcengine.com | |
nick_name | 账户昵称 | string | 可传 | example |
openid | account_type 是 QQ 或微信开放账号时需传,如果是 QQ,则填入对应的 openid,微信用户则填入对应的 openid | string | 可传 | 9130088 |
unionid | 微信用户传入获取到的用户的unionid | string | 可传 | o6_bmasdasdsad6_2sgVt7hMZOPfL |
user_agent | http请求所带的userAgent | string | 可传 | 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 |
referer | http请求所带的referer | string | 可传 | https://www.volcengine.com/ |
app_version | App版本号 | string | 可传 | 1.9.8 |
device_platform | 设备平台类型举例:1、android 2. ios 3. wap 4. web | string | 可传 | android |
user_type | 用户类型 normal:普通用户 admin:业务系统管理员 white:业务白名单用户 | string | 可传 | normal |
avatar_type | 用户头像的类型. default:默认头像 defined:用户自己上传的头像 | string | 可传 | default |
avatar_url | 头像图片URL | string | 可传 | https://xxxx.png |
当前业务中登录请求验证完成后调用,在验证成功和验证失败的时候都需要进行调用。
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= |
channel | App下载渠道 | string | 必传 | wandoujia |
x_forwarded_for | 用户http请求的X-Forwarded-For头信息,或其他记录代理信息的http头信息 | string | 可传 | |
邮箱地址 | string | 可传 | example@volcengine.com | |
nick_name | 账户昵称 | string | 可传 | example |
openid | account_type 是 QQ 或微信开放账号时需传,如果是 QQ,则填入对应的 openid,微信用户则填入对应的 openid | string | 可传 | 9130088 |
unionid | 微信用户传入获取到的用户的unionid | string | 可传 | 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, other | string | 可传 | mobile |
register_ip | 该账户注册时所用ip | string | 可传 | 42.120.74.211 |
login_result | 登录是否成功 | bool | 可传 | true |
fail_reason | 登录失败的原因,请从如下类型中选择: wrong_password:用户名或密码错误 business_risk: 业务自己判定有风险 other: 其他 | string | 可传 | wrongPassword |
user_agent | http请求所带的userAgent | string | 可传 | 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 |
referer | http请求所带的referer | string | 可传 | https://www.volcengine.com/ |
app_version | App版本号 | string | 可传 | 1.9.8 |
device_platform | 设备平台类型举例:1、android 2. ios 3. wap 4. web | string | 可传 | android |
user_type | 用户类型 punished:被处罚的用户,例如被封禁 normal:未被处罚的普通用户 admin:业务系统管理员 white:业务白名单用户 | string | 可传 | normal |
avatar_type | 用户头像的类型. default:默认头像 defined:用户自己上传的头像 | string | 可传 | default |
avatar_url | 头像图片URL | string | 可传 | https://xxxx.png |
在用户裂变场景中,用户发起裂变邀请时,实时调用本接口,调用者可根据接口的返回结果进行相应的业务处理。
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= |
channel | App下载渠道 | string | 必传 | wandoujia |
x_forwarded_for | 用户http请求的X-Forwarded-For头信息,或其他记录代理信息的http头信息 | string | 可传 | |
邮箱地址 | string | 可传 | example@volcengine.com | |
nick_name | 账户昵称 | string | 可传 | example |
openid | account_type 是 QQ 或微信开放账号时需传,如果是 QQ,则填入对应的 openid,微信用户则填入对应的 openid | string | 可传 | 9130088 |
unionid | 微信用户传入获取到的用户的unionid | string | 可传 | 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, other | string | 可传 | mobile |
register_ip | 该账户注册时所用ip | string | 可传 | 42.120.74.211 |
login_result | 登录是否成功 | bool | 可传 | true |
fail_reason | 登录失败的原因,请从如下类型中选择: wrong_password:用户名或密码错误 business_risk: 业务自己判定有风险 other: 其他 | string | 可传 | wrongPassword |
user_agent | http请求所带的userAgent | string | 可传 | 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 |
referer | http请求所带的referer | string | 可传 | https://www.volcengine.com/ |
app_version | App版本号 | string | 可传 | 1.9.8 |
device_platform | 设备平台类型举例:1、android 2. ios 3. wap 4. web | string | 可传 | android |
user_type | 用户类型 punished:被处罚的用户,例如被封禁 normal:未被处罚的普通用户 admin:业务系统管理员 white:业务白名单用户 | string | 可传 | normal |
avatar_type | 用户头像的类型. default:默认头像 defined:用户自己上传的头像 | string | 可传 | default |
avatar_url | 头像图片URL | string | 可传 | https://xxxx.png |
当前业中场景中,接受邀请且邀请关系成功建立时,实时调用本接口,调用者可根据接口的返回结果进行相应的业务处理。
Service字段取值:accept_invite 建议超时:1s
字段名称 | 字段描述 | 字段类型 | 是否必须 | 示例数据 |
---|---|---|---|---|
master_id | 邀请人的账户id | string | 必传 | 101234567 |
group_id | 用户接受拼团时的拼团号 | string | 可传 | 113578 |
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 | |
channel | App下载渠道 | string | wandoujia | |
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, other | string | 必传 | |
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 | 可传 | |
邮箱地址 | string | 可传 | example@volcengine.com | |
nick_name | 账户昵称 | string | 可传 | example |
openid | account_type 是 QQ 或微信开放账号时需传,如果是 QQ,则填入对应的 openid,微信用户则填入对应的 openid | string | 可传 | 9130088 |
unionid | 微信用户传入获取到的用户的unionid | string | 可传 | o6_bmasdasdsad6_2sgVt7hMZOPfL |
user_agent | http请求所带的userAgent | string | 可传 | 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 |
referer | http请求所带的referer | string | 可传 | https://www.volcengine.com/ |
app_version | App版本号 | string | 可传 | 1.9.8 |
device_platform | 设备平台类型举例:1、android 2. ios 3. wap 4. web | string | 可传 | android |
user_type | 用户类型 normal:普通用户 admin:业务系统管理员 white:业务白名单用户 | string | 可传 | normal |
avatar_type | 用户头像的类型. default:默认头像 defined:用户自己上传的头像 | string | 可传 | default |
avatar_url | 头像图片URL | string | 可传 | https://xxxx.png |
做签到、玩小游戏、领取优惠券、抢红包、抽奖等可获益的行为,实时调用本接口,调用者可根据接口的返回参数进行相应的业务处理。
Service字段取值:activity 建议超时:1s
字段名称 | 字段描述 | 字段类型 | 是否必须 | 示例数据 |
---|---|---|---|---|
activity_id | 活动id | string | 必传 | hongbao1 |
activity_type | 活动类型 签到:sign,抽奖:lottery,领券:coupon,抢红包:envelope,玩游戏:game,其他:other | string | 必传 | sign |
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 | |
xmsg | 只在web端需要。接入web端SDK必传。 web页面接入SDK之后,在指定的请求header中带的参数。 | string | 可传 | BGr+YgfPHsIapGwJVTsFgnMZ67h7ikaY6aVvaZ9OOVCed9lsiu33Hz2GFUDvJpRRHs23+95LE8JlAae/ydex9qC5+ZobjO/RrgTcpxt8XQdHgqEMUj1cmP5N4UCX9CCwU/HsWU7gByJKWavVa1aSx8316+NgwhXO58M+AOLCL4g= |
channel | App下载渠道 | string | wandoujia | |
bd_did | 设备稳定标识,需在设备SDK中获取BDDeviceID传入 | string | 可传 | ADBDDEDFALKZLKJFLAKJWLKJL227FAF2L |
account_type | 用户账号注册方式,请从如下类型中选择: mobile, email, wechat, qq, other | string | 必传 | |
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 | 可传 | |
邮箱地址 | string | 可传 | example@volcengine.com | |
nick_name | 账户昵称 | string | 可传 | example |
openid | account_type 是 QQ 或微信开放账号时需传,如果是 QQ,则填入对应的 openid,微信用户则填入对应的 openid | string | 可传 | 9130088 |
unionid | 微信用户传入获取到的用户的unionid | string | 可传 | o6_bmasdasdsad6_2sgVt7hMZOPfL |
user_agent | http请求所带的userAgent | string | 可传 | 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 |
referer | http请求所带的referer | string | 可传 | https://www.volcengine.com/ |
app_version | App版本号 | string | 可传 | 1.9.8 |
device_platform | 设备平台类型举例:1、android 2. ios 3. wap 4. web | string | 可传 | android |
user_type | 用户类型 normal:普通用户 admin:业务系统管理员 white:业务白名单用户 | string | 可传 | normal |
avatar_type | 用户头像的类型. default:默认头像 defined:用户自己上传的头像 | string | 可传 | default |
当前业中场景中,用户提现,实时调用本接口,调用者可根据接口的返回参数进行相应的业务理。
Service字段取值:withdrawal 建议超时:1s
字段名称 | 字段描述 | 字段类型 | 是否必须 | 示例数据 |
---|---|---|---|---|
account_id | 用户的账户ID,唯一标识一个账户 | string | 必传 | 101234579 |
withdrawal_amount | 提现金额,单位为分(中国大陆货币人民币),100分 = 1元 | int | 必传 | 688(表示6元8毛8分) |
withdrawal_account_id | 提现账户ID,如支付宝账户ID | string | 必传 | 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 |
channel | App下载渠道 | string | 可传 | wandoujia |
bd_did | 设备稳定标识,需在设备SDK中获取BDDeviceID传入 | string | 可传 | ADBDDEDFALKZLKJFLAKJWLKJL227FAF2L |
account_type | 用户账号注册方式,请从如下类型中选择: mobile, email, wechat, qq, other | string | 必传 | |
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= |
channel | App下载渠道 | string | 可传 | wandoujia |
x_forwarded_for | 用户http请求的X-Forwarded-For头信息,或其他记录代理信息的http头信息 | string | 可传 | |
邮箱地址 | string | 可传 | example@volcengine.com | |
nick_name | 账户昵称 | string | 可传 | example |
openid | account_type 是 QQ 或微信开放账号时需传,如果是 QQ,则填入对应的 openid,微信用户则填入对应的 openid | string | 可传 | 9130088 |
unionid | 微信用户传入获取到的用户的unionid | string | 可传 | o6_bmasdasdsad6_2sgVt7hMZOPfL |
user_agent | http请求所带的userAgent | string | 可传 | 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 |
referer | http请求所带的referer | string | 可传 | https://www.volcengine.com/ |
app_version | App版本号 | string | 可传 | 1.9.8 |
device_platform | 设备平台类型举例:1、android 2. ios 3. wap 4. web | string | 可传 | android |
user_type | 用户类型 normal:普通用户 admin:业务系统管理员 white:业务白名单用户 | string | 可传 | normal |
avatar_type | 用户头像的类型. default:默认头像 defined:用户自己上传的头像 | string | 可传 | default |
avatar_url | 头像图片URL | string | 可传 | https://xxxx.png |
浏览商品、视频、文章等高价值数据时,实时调用本接口,调用者可根据接口的返回结果进行相应的业务处理。
Service字段取值:anti-crawl 建议超时:1s
APP端接入参数:
字段名称 | 字段描述 | 字段类型 | 是否必须 | 示例数据 |
---|---|---|---|---|
api | 客户端请求API | String | 必传 | 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 |
channel | App下载渠道 | 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 | 内容ID | int | 下载文书场景下必传 | 案例id、法律id等 |
device_platform | 平台系统类型 | string | 必传 | web |
os | 操作系统 | string | 必传 | windows |
openid | account_type 是 QQ 或微信开放账号时需传,如果是 QQ,则填入对应的 openid,微信用户则填入对应的 openid | string | 可传 | 9130088 |
unionid | 微信用户传入获取到的用户的unionid | string | 可传 | o6_bmasdasdsad6_2sgVt7hMZOPfL |
user_agent | http请求所带的userAgent | string | 必传 | 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_params | B端原始业务参数,json格式 | string | 可传 | "{\"page\":\"64\"}" |
app_version | App版本号 | string | 必传 | 1.9.8 |
latitude | 纬度 | string | 可传 | 39.23 |
longitude | 经度 | string | 可传 | 12.32 |
web端接入参数:
字段名称 | 字段描述 | 字段类型 | 是否必须 | 示例数据 |
---|---|---|---|---|
api | 客户端请求API | String | 必传 | 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 | 内容ID | int | 下载文书场景下必传 | 案例id、法律id等 |
device_platform | 平台系统类型 | string | 必传 | web |
os | 操作系统 | string | 必传 | windows |
referer | 当前流量的来源页面 | string | 必传 | faxin.cn |
root_referer | 第一次进入法信的来源页面 | string | 必传 | faxin.cn |
cookie_enabled | 是否禁用cookie | string | 必传 | 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,离线:0 | string | 必传 | 1 |
openid | account_type 是 QQ 或微信开放账号时需传,如果是 QQ,则填入对应的 openid,微信用户则填入对应的 openid | string | 可传 | 9130088 |
unionid | 微信用户传入获取到的用户的unionid | string | 可传 | o6_bmasdasdsad6_2sgVt7hMZOPfL |
user_agent | http请求所带的userAgent | string | 可传 | 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_params | B端原始业务参数,json格式 | string | 可传 | "{\"page\":\"64\"}" |
用户对内容或作者完成点赞、收藏、关注、订阅、送礼等行为时,实时调用本接口,调用者可根据接口的返回参数进行相应的业务处理。
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,其他:other | string | 必传 | like |
receive_account_id | 被喜好内容拥有者的账户ID | string | 可传 | 101234568 |
receive_object_id | 被喜好的作品ID | string | 可传 | 102314242 |
amount | 送礼或订阅花费的金额 | float | 可传 | 2.3 |
account_type | 用户账号注册方式,请从如下类型中选择: mobile, email, wechat, qq, other | string | 必传 | |
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= |
channel | App下载渠道 | string | 可传 | wandoujia |
x_forwarded_for | 用户http请求的X-Forwarded-For头信息,或其他记录代理信息的http头信息 | string | 可传 | |
邮箱地址 | string | 可传 | example@volcengine.com | |
nick_name | 账户昵称 | string | 可传 | example |
openid | account_type 是 QQ 或微信开放账号时需传,如果是 QQ,则填入对应的 openid,微信用户则填入对应的 openid | string | 可传 | 9130088 |
unionid | 微信用户传入获取到的用户的unionid | string | 可传 | o6_bmasdasdsad6_2sgVt7hMZOPfL |
user_agent | http请求所带的userAgent | string | 可传 | 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 |
referer | http请求所带的referer | string | 可传 | https://www.volcengine.com/ |
app_version | App版本号 | string | 可传 | 1.9.8 |
device_platform | 设备平台类型举例:1、android 2. ios 3. wap 4. web | string | 可传 | android |
user_type | 用户类型 normal:普通用户 admin:业务系统管理员 white:业务白名单用户 | string | 可传 | normal |
avatar_type | 用户头像的类型. default:默认头像 defined:用户自己上传的头像 | string | 可传 | default |
avatar_url | 头像图片URL | string | 可传 | https://xxxx.png |
用户发生聊天等行为时,实时调用本接口,调用者可根据接口的返回参数进行相应的业务处理。
Service字段取值:im 建议超时:1s
字段名称 | 字段描述 | 字段类型 | 是否必传 | 示例数据 |
---|---|---|---|---|
account_id | 用户的账户ID,唯一标识一个账户 | string | 必传 | 101234579 |
text | 聊天/私信的文本内容 | string | 必传 | 加V 28391248 |
channel_type | 聊天频道类型,公开频道:world,单聊频道:single | string | 可传 | 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 |
channel | App下载渠道 | string | 可传 | wandoujia |
bd_did | 设备稳定标识,需在设备SDK中获取BDDeviceID传入 | string | 可传 | ADBDDEDFALKZLKJFLAKJWLKJL227FAF2L |
nick_name | 账户昵称 | string | 可传 | example |
signature | 账户个性签名 | string | 可传 | 个性签名 |
account_type | 用户账号注册方式,请从如下类型中选择: mobile, email, wechat, qq, other | string | 必传 | |
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 | 可传 | |
邮箱地址 | string | 可传 | example@volcengine.com | |
openid | account_type 是 QQ 或微信开放账号时需传,如果是 QQ,则填入对应的 openid,微信用户则填入对应的 openid | string | 可传 | 9130088 |
unionid | 微信用户传入获取到的用户的unionid | string | 可传 | o6_bmasdasdsad6_2sgVt7hMZOPfL |
user_agent | http请求所带的userAgent | string | 可传 | 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 |
referer | http请求所带的referer | string | 可传 | https://www.volcengine.com/ |
app_version | App版本号 | string | 可传 | 1.9.8 |
device_platform | 设备平台类型举例:1、android 2. ios 3. wap 4. web | string | 可传 | android |
user_type | 用户类型 normal:普通用户 admin:业务系统管理员 white:业务白名单用户 | string | 可传 | normal |
avatar_type | 用户头像的类型. default:默认头像 defined:用户自己上传的头像 | string | 可传 | default |
avatar_url | 头像图片URL | string | 可传 | https://xxxx.png |
用户发生聊天(群聊)行为时,实时调用本接口,调用者可根据接口的返回参数进行相应的业务处理。
Service字段取值:group_im 建议超时:1s
字段名称 | 字段描述 | 字段类型 | 是否必传 | 示例数据 |
---|---|---|---|---|
account_id | 用户的账户ID,唯一标识一个账户 | string | 必传 | 101234579 |
text | 聊天/私信的文本内容 | string | 必传 | 加V 28391248 |
operate_time | 该用户发言时间戳, 精确到秒 | int | 必传 | 1823778531 |
group_name | 群名 | string | 可传 | 一起炒股,共同致富 |
group_id | 群唯一ID | string | 可传 | 518888 |
group_admin | 群主ID | string | 可传 | 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 |
channel | App下载渠道 | string | 可传 | wandoujia |
bd_did | 设备稳定标识,需在设备SDK中获取BDDeviceID传入 | string | 可传 | ADBDDEDFALKZLKJFLAKJWLKJL227FAF2L |
nick_name | 账户昵称 | string | 可传 | example |
signature | 账户个性签名 | string | 可传 | 个性签名 |
account_type | 用户账号注册方式,请从如下类型中选择: mobile, email, wechat, qq, other | string | 必传 | |
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 | 可传 | |
邮箱地址 | string | 可传 | example@volcengine.com | |
openid | account_type 是 QQ 或微信开放账号时需传,如果是 QQ,则填入对应的 openid,微信用户则填入对应的 openid | string | 可传 | 9130088 |
unionid | 微信用户传入获取到的用户的unionid | string | 可传 | o6_bmasdasdsad6_2sgVt7hMZOPfL |
user_agent | http请求所带的userAgent | string | 可传 | 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 |
referer | http请求所带的referer | string | 可传 | https://www.volcengine.com/ |
app_version | App版本号 | string | 可传 | 1.9.8 |
device_platform | 设备平台类型举例:1、android 2. ios 3. wap 4. web | string | 可传 | android |
user_type | 用户类型 normal:普通用户 admin:业务系统管理员 white:业务白名单用户 | string | 可传 | normal |
avatar_type | 用户头像的类型. default:默认头像 defined:用户自己上传的头像 | string | 可传 | default |
avatar_url | 头像图片URL | string | 可传 | https://xxxx.png |
给客户发送短信验证码时上报。
Service字段取值:send_sms_verify 建议超时:1s
字段名称 | 字段描述 | 字段类型 | 是否必传 | 示例数据 |
---|---|---|---|---|
account_id | 买家唯一表述ID | string | 必传 | 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. web | string | 可传 | 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 | 订单ID | string | 必传 | 3258387421 |
order_type | 订单类型,普通商品、秒杀等 | int | 必传 | 1 |
product_id | 商品ID | string | 必传 | 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_version | App版本号 | string | 可传 | 2.2.1 |
pay_openid | 支付端账号openid | string | 可传 | 319196287 |
在需要获取账号风险信息时调用本接口。
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 |