互动功能模块 功能API 说明
调用方式: VHALL_ZK.init完成之后
API列表 使用VHALL_ZK.$api作为句柄调用
API名 |
功能描述 |
参数 |
返回值 |
备注 |
getUser |
获取用户信息 |
无 |
Object |
用户的基本信息 |
updateUser |
更新用户信息 |
Object |
Promise |
- |
updateMobile |
更新手机号 |
Object |
Promise |
- |
userShareRecord |
用户分享记录 |
无 |
Promise |
数据上报用 |
getOnlineNum |
获取在线人数 |
无 |
Promise |
- |
visitorInfo |
获取初始化时的游客信息 |
无 |
Object |
- |
getVisitorInfo |
实时获取游客信息 |
无 |
Promise |
- |
joinActivity |
用户加入活动 |
无 |
Promise |
- |
代码示例
VHALL_ZK.$api.getUser()
/* 可以只更新单项 */
VHALL_ZK.$api.updateUser({
nick_name: ''
})
/* 也可以只更新多项 */
VHALL_ZK.$api.updateUser({
avatar: '' // 头像
nick_name: '', // 昵称
email: '' // 邮箱
}).then((res) => {
console.log(res)
})
/* 修改用户手机号 */
VHALL_ZK.$api.updateUserMobile({
mobile: '', // 手机号
code: '', // 用户输入的手机验证码
code_token: this.code_token // 验证短信码后的code_token, 通过verifyCode接口获取
}).then((res) => {
console.log(res)
})
VHALL_ZK.$api.userShareRecord()
VHALL_ZK.$api.getOnlineNum().then((res) => {
// 真实浏览人数 res.data.visit_num
// 真实在线人数 res.data.online_num
// 虚拟在线人数 res.data.init_online_num
console.log(res)
})
const visitorInfo = VHALL_ZK.$api.visitorInfo()
visitorInfo.visit_id // 游客id
visitorInfo.visit_name // 游客名称
VHALL_ZK.$api.getVisitorInfo().then(info => {
info.visit_id // 游客id
info.visit_name // 游客名称
})
/* 用户参会 */
VHALL_ZK.$api.joinActivity({
activity_id: '', // 必填, 活动id
join_source: '4', // 必填, 参会来源页:1.官网,2.引导页,3.观看页,4.邀请卡
share_id: '', // 必填,分享人id
refer: '' // 非必填,渠道
}).then((res) => {
console.log(res)
})
渠道来源refer
值 |
来源 |
0 |
邮件 |
1 |
微信 |
2 |
短信 |
1000-10000 |
自定义渠道 |
99999 |
微信扫描 |
'' |
不填写表示,主渠道 |