wawa
来自于:官方立即使用
SDK管理
用户账号管理
用户地址管理
物流查询
娃娃、积分、金币
申诉、举报
游戏房间管理
游戏管理
监听
概述
阿凡达娃娃机简介
阿凡达在线抓娃娃
模块概述
wawa 模块封装了阿凡达娃娃机的开放 SDK
模块使用攻略
1.注册阿凡达云账号 2.配置config文件
config 文件
配置方法如下:
- 名称:wawa
- 参数:appId、appKey
- 配置示例:
<feature name="wawa">
<param name="appId" value="2017110415504167" />
<param name="appKey" value="63e356c7158996538f01a801" />
</feature>
字段描述:
appId:在阿凡达娃娃机开放平台申请的 AppId
appKey:在阿凡达娃娃机开放平台申请的 AppKey
模块接口
setLogEnable
开启、关闭log
setLogEnable(callback(ret))
params
logEnable:
- 类型:布尔
- 描述:(可选项)是否开启log
- 默认:true
示例代码
var wawa = api.require('wawa');
wawa.setLogEnable({
logEnable:true
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
getVersion
获取版本号
getVersion(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
version: ‘’ //字符串类型;版本号
}
示例代码
var wawa = api.require('wawa');
wawa.getVersion(function(ret) {
alert(ret.version);
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
isRegisterAppSuccess
判断阿凡达娃娃机 SDK 是否初始化成功
isRegisterAppSuccess(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true //布尔型;true||false
}
示例代码
var wawa = api.require('wawa');
wawa.isRegisterAppSuccess(function(ret) {
if (ret.status) {
alert('已初始化');
} else {
alert('初始化失败');
}
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
registerApp
初始化阿凡达娃娃机 SDK, 向 SDK 注册 appid appkey
注意:App 启动时,模块会自动读取 config.xml
文件内的 appid 和 appkey 参数完成初始化注册。若App 启动时初始化失败,可调用本接口再次初始化。
registerApp(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true //布尔型;true||false
}
示例代码
var wawa = api.require('wawa');
wawa.registerApp(function(ret) {
if (ret.status) {
alert('已初始化');
} else {
alert('初始化失败');
}
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
setUserInfo
设置用户信息
setUserInfo({params})
params
uid:
- 类型:字符串
- 描述:uid
name:
- 类型:字符串
- 描述:用户名
avatar:
- 类型:字符串
- 描述:头像地址
示例代码
var wawa = api.require('wawa');
wawa.setUserInfo({
uid:'110',
name:'嘿嘿嘿',
avatar:'https://ss1.bdstatic.com/70cFuXSh_Q1YnxGkpoWK1HF6hhy/it/u=444225515,3056104404&fm=27&gp=0.jpg'
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
login
合作方,当用户从匿名,登陆之后,主动触发调用。
login(callback(ret))
callback(ret)
ret:
- 类型:JSON对象
- 描述:登录信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;登录信息
}
示例代码
var wawa = api.require('wawa');
wawa.login(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
logout
合作方,退出登录。
logout()
示例代码
var wawa = api.require('wawa');
wawa.logout();
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestUserInfo
请求当前登陆用户信息
requestUserInfo(callback(ret))
callback(ret)
ret:
- 类型:JSON对象
- 描述:登录信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;登录信息
userModel: { //JOSN对象;玩儿家信息描述
uid:, //数字类型;用户ID
gender:, //数字类型;性别, 1男 0女
portrait:, //字符串类型;头像
nickname:, //字符串类型;昵称
spoils: //数字类型;战利品个数
}
}
示例代码
var wawa = api.require('wawa');
wawa.requestUserInfo(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestCommonUserInfoWithUid
请求用户信息
requestCommonUserInfoWithUid({params},callback(ret))
params
uid:
- 类型:数字
- 描述:(可选项)要请求的用户uid。注意,这个uid不是接入方服务器分配的uid, 而是通过SDK接口获取的uid. 当看自己,传0
- 默认:0
callback(ret)
ret:
- 类型:JSON对象
- 描述:游戏记录信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;信息
userModel: { //JOSN对象;玩儿家信息描述
uid:, //数字类型;用户ID
gender:, //数字类型;性别, 1男 0女
portrait:, //字符串类型;头像
nickname:, //字符串类型;昵称
spoils: //数字类型;战利品个数
}
}
示例代码
var wawa = api.require('wawa');
wawa.requestCommonUserInfoWithUid({
uid:1
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestGameHistoryAtPage
请求用户游戏记录
requestGameHistoryAtPage({params},callback(ret))
params
page:
- 类型:数字
- 描述:页数,从1开始
- 默认:1
callback(ret)
ret:
- 类型:JSON对象
- 描述:游戏记录信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;信息
gameRecordModels:[{ //数组类型;游戏记录描述
dateline:, //字符串类型;游戏时间
orderId:, //字符串类型;记录Id
wawaId:, //数字类型;娃娃ID
status:, //数字类型;状态 0:失败(游戏失败,如机器故障); 1:未抓中; 2:抓中;
coin:, //数字类型;消耗金币
awardFishball:, //数字类型;消耗鱼丸
awardFishbal:, //字符串类型; 奖励鱼丸
video:{ //JONS对象;视频回放描述对象
machineStream:,//字符串类型;
livekey:, //字符串类型;
startTime:, //数字类型;时间戳,单位为秒,从1970-1-1 00:00:00开始
duration: //数字类型;单位为秒
},
wawa:{ //JONS对象;个人游戏记录
ID:, //数字类型;
flag:, //数字类型;
coin:, //数字类型;
pic:, //字符串类型;娃娃缩略图
icon:, //字符串类型;
name: //字符串类型;娃娃名称
}
}]
}
示例代码
var wawa = api.require('wawa');
wawa.requestGameHistoryAtPage({
page:1
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestUserWardrobeAtPage
请求用户战利品列表
requestUserWardrobeAtPage({params},callback(ret))
params
page:
- 类型:数字
- 描述:页数,从1开始
- 默认:1
userId:
- 类型:数字
- 描述:看谁的战利品,传谁的uid. 当登陆用户查看自己。 uid传0
- 默认:0
callback(ret)
ret:
- 类型:JSON对象
- 描述:游戏记录信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;信息
wardrobeModel:{ //JSON对象;战利品信息
warTrophyHead:{ //JSON对象;用户战利品数目
level1:, //数字类型;等级1的战利品数目
level2:, //数字类型;等级2的战利品数目
level3:, //数字类型;等级3的战利品数目
level4:, //数字类型;等级4的战利品数目
spoils:, //数字类型;战利品总数
},
warTrophyInfo:[{ //JSON对象;战利品信息
dateline:, //字符串类型;
uid:, //数字类型;
wawaId:, //数字类型;
total:, //数字类型;
wawa:{ //JSON对象;
ID:, //数字类型;
flag:, //数字类型;
coin:, //数字类型;
pic:, //字符串类型;娃娃缩略图
icon:, //字符串类型;
name: //字符串类型;娃娃名称
}
}]
}
}
示例代码
var wawa = api.require('wawa');
wawa.requestUserWardrobeAtPage({
page:1,
userId: 0
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestUserWawa
请求用户抓取到的娃娃列表
requestUserWawa({params},callback(ret))
params
type:
- 类型:字符串
- 描述:娃娃类型
- 默认:all
- 取值范围:
- deposit:寄存中
- deliver:运送中
- exchange:已兑换
- all:全部
callback(ret)
ret:
- 类型:JSON对象
- 描述:信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;信息
userWawaModel:{ //JSON对象;用户抓到娃娃与发货订单数据
expressTotalCount:, //数字类型;已经发货总数
exchangeTotalCount:, //数字类型;已兑换总数
depositTotalCount:, //数字类型;寄存中总数
expressList:[{ //数组类型;已发货的
orderId: , //字符串类型;订单 id
status: , //数字类型;快递状态,0发货准备中;1运送中;2已收货
dateline:, //字符串类型;申请发货时间
selected: , //布尔类型;标记选中
records:[{ //数组类型;娃娃发货订单条目
wid: , //数字类型;娃娃id
pic: , //字符串类型;娃娃详图
name: , //字符串类型;娃娃名称
coin: , //数字类型;价值
num: , //数字类型;娃娃数量
selected: //布尔类型;标记选中
}]
}],
exchangeList:[{}],//数组类型;已兑换列表内部字段同expressList
depositList:[{ //数组类型;寄存中
ID: , //数字类型;记录ID
wid: , //数字类型;娃娃id
expTime:, //数字类型;寄存剩余天数
pic: , //字符串类型;娃娃详图
icon: , //字符串类型;娃娃单体icon
portrait: , //字符串类型;娃娃缩头像
name: , //字符串类型;娃娃名称
coin: , //数字类型;价值
selected: //布尔类型;标记选中
}]
}
}
示例代码
var wawa = api.require('wawa');
wawa.requestUserWawa(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestCreateOrderWithWawaIds
请求发货
requestCreateOrderWithWawaIds({params},callback(ret))
params
wawaIds:
- 类型:数组
- 描述:娃娃寄存项ID数组
addressModel:
- 类型:JSON对象
- 描述:地址信息
- 内部字段:
{
ID:, //数字类型;地址ID
province:, //字符串类型;省份
city:, //字符串类型;城市
district:, //字符串类型;县,区
address:, //字符串类型;详细地址
name:, //字符串类型;联系人
phone:, //字符串类型;手机
isDefault: //布尔类型; 是否默认地址
}
callback(ret)
ret:
- 类型:JSON对象
- 描述:游戏记录信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;信息
}
示例代码
var wawa = api.require('wawa');
wawa.requestCreateOrderWithWawaIds({
wawaIds:[]
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestMyAddressList
请求用户地址列表
requestMyAddressList(callback(ret))
callback(ret)
ret:
- 类型:JSON对象
- 描述:地址信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;信息
addressModels:[{ //数组类型;玩家地址信息描述
ID:, //数字类型;地址ID
province:, //字符串类型;省份
city:, //字符串类型;城市
district:, //字符串类型;县,区
address:, //字符串类型;详细地址
name:, //字符串类型;联系人
phone:, //字符串类型;手机
isDefault: //布尔类型; 是否默认地址
}]
}
示例代码
var wawa = api.require('wawa');
wawa.requestMyAddressList(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestAddAddress
新加入一个收货地址
requestAddAddress({params},callback(ret))
params
addressModel:
- 类型:JSON对象
- 描述:地址信息
- 内部字段:
{
ID:, //数字类型;地址ID
province:, //字符串类型;省份
city:, //字符串类型;城市
district:, //字符串类型;县,区
address:, //字符串类型;详细地址
name:, //字符串类型;联系人
phone:, //字符串类型;手机
isDefault: //布尔类型; 是否默认地址
}
callback(ret)
ret:
- 类型:JSON对象
- 描述:修改结果
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;信息
}
示例代码
var wawa = api.require('wawa');
wawa.requestAddAddress({
addressModel:''
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestUpdateAddress
编辑修改一个收货地址。
此时ID,必须填写。使用正在编辑地址ID
requestUpdateAddress({params},callback(ret))
params
addressModel:
- 类型:JSON对象
- 描述:地址信息
- 内部字段:
{
ID:, //数字类型;地址ID
province:, //字符串类型;省份
city:, //字符串类型;城市
district:, //字符串类型;县,区
address:, //字符串类型;详细地址
name:, //字符串类型;联系人
phone:, //字符串类型;手机
isDefault: //布尔类型; 是否默认地址
}
callback(ret)
ret:
- 类型:JSON对象
- 描述:修改结果
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;信息
}
示例代码
var wawa = api.require('wawa');
wawa.requestUpdateAddress({
addressModel:''
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestSetDefaultAddress
设置已有一个地址为默认地址
requestSetDefaultAddress({params},callback(ret))
params
aId:
- 类型:数字
- 描述:地址ID
callback(ret)
ret:
- 类型:JSON对象
- 描述:修改结果
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;信息
}
示例代码
var wawa = api.require('wawa');
wawa.requestSetDefaultAddress({
aId:''
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestDeleteAddress
删除一个收货地址
requestDeleteAddress({params},callback(ret))
params
aID:
- 类型:字符串
- 描述:地址 id
callback(ret)
ret:
- 类型:JSON对象
- 描述:修改结果
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;信息
}
示例代码
var wawa = api.require('wawa');
wawa.requestDeleteAddress({
aID:''
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestExpressInfo
物流查询
requestExpressInfo({params},callback(ret))
params
orderId:
- 类型:字符串
- 描述:订单id
callback(ret)
ret:
- 类型:JSON对象
- 描述:返回信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;信息
expressInfo:{ //JSON对象;
number:, //字符串类型;
type:, //字符串类型;
company:, //字符串类型;
deliverystatus:, //数字类型;1.在途中 2. 派送中 3. 已签收 4. 派送失败或者拒收
issign:, //数字类型;
wawaNum:, //数字类型;
tel:, //字符串类型;
list:[{ //JSON对象;
status:, //字符串类型;
time:, //字符串类型;
isFirst:, //布尔类型;
isLast: //布尔类型;
}],
wawa:{ //JSON对象;
ID:, //数字类型;
flag:, //数字类型;
coin:, //数字类型;
pic:, //字符串类型;娃娃缩略图
icon:, //字符串类型;
name: //字符串类型;娃娃名称
}
}
}
示例代码
var wawa = api.require('wawa');
wawa.requestExpressInfo({
orderId:
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestConfirmReceived
确认收货
requestConfirmReceived({params},callback(ret))
params
orderId:
- 类型:字符串
- 描述:订单id
callback(ret)
ret:
- 类型:JSON对象
- 描述:返回信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;信息
}
示例代码
var wawa = api.require('wawa');
wawa.requestConfirmReceived({
orderId:
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestExchangeWawaWithType
将娃娃兑换为金币
requestExchangeWawaWithType({params},callback(ret))
params
type:
- 类型:字符串
- 描述:(可选项)娃娃类型
- 默认:all
- 取值范围:
- deposit:寄存中
- deliver:运送中
- exchange:已兑换
- all:全部
wawaIds:
- 类型:数组
- 描述:娃娃id数组
callback(ret)
ret:
- 类型:JSON对象
- 描述:信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;信息
}
示例代码
var wawa = api.require('wawa');
wawa.requestExchangeWawaWithType(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestMallListAtPage
请求积分商城列表
requestMallListAtPage({params},callback(ret))
params
page:
- 类型:数字
- 描述:页码,从1开始
callback(ret)
ret:
- 类型:JSON对象
- 描述:游戏记录信息
- 内部字段:
{
code: , //数字类型;状态码
success: '' //布尔类型;是否成功
mallList: [{ //数组对象;
code:, //字符串类型;
exchangeFishball:,//数字类型;
flag:, //数字类型;
ID:, //数字类型;
name:'', //字符串类型;
pic:'' //字符串类型;
}]
}
示例代码
var wawa = api.require('wawa');
wawa.requestMallListAtPage({
wawaIds:[]
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestMallExchangeWithWWID
积分兑换娃娃
requestMallExchangeWithWWID({params},callback(ret))
params
wid:
- 类型:数字
- 描述:兑换娃娃的 id
callback(ret)
ret:
- 类型:JSON对象
- 描述:商品信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;信息
}
示例代码
var wawa = api.require('wawa');
wawa.requestMallExchangeWithWWID({
wid:1
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestComplainReasonList
获取申诉的原因列表
requestComplainReasonList(callback(ret))
callback(ret)
ret:
- 类型:JSON对象
- 描述:游戏记录信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;信息
complainReasonList: [{ //数组类型;
ID:, //数字类型;
reason:'' //字符串类型;
}]
}
示例代码
var wawa = api.require('wawa');
wawa.requestComplainReasonList(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestComplainGame
请求申述游戏
requestComplainGame({params},callback(ret))
params
orderID:
- 类型:字符串
- 描述:订单 id
reason:
- 类型:字符串
- 描述:理由
reasonId:
- 类型:字符串
- 描述:理由 id
callback(ret)
ret:
- 类型:JSON对象
- 描述:游戏记录信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;信息
}
示例代码
var wawa = api.require('wawa');
wawa.requestComplainGame({
orderID:
reason:
reasonId:
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestComplainResultWithOrderID
游戏申述状态
requestComplainResultWithOrderID({params},callback(ret))
params
orderID:
- 类型:字符串
- 描述:订单 id
callback(ret)
ret:
- 类型:JSON对象
- 描述:游戏记录信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;信息
isComplain: //布尔类型;
}
示例代码
var wawa = api.require('wawa');
wawa.requestComplainResultWithOrderID(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestReportUser
房间内举报某个用户
requestReportUser({params},callback(ret))
params
uid:
- 类型:字符串
- 描述:用户id
type:
- 类型:字符串
- 描述:类型
- 默认:other
- 取值范围:
- other:其它内容
- porno:色情低俗
- political:政治敏感
- ad:广告欺诈
- abuse:骚扰谩骂
callback(ret)
ret:
- 类型:JSON对象
- 描述:游戏记录信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;信息
}
示例代码
var wawa = api.require('wawa');
wawa.requestReportUser({
uid:
type:
rid:
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestRoomListAtPage
请求房间列表
requestRoomListAtPage({params},callback(ret))
params
page:
- 类型:数字
- 描述:请求列表页,从1开始
- 默认:1
size:
- 类型:数字
- 描述:每页个数
- 默认:10
callback(ret)
ret:
- 类型:JSON对象
- 描述:信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;信息
roomModels:[{ //数组类型; 游戏房间描述对象
ID:, //数字类型;房间ID
state: , //数字类型;房间状态: 小于1:故障 1:补货 2:空闲 大于2:游戏中
uid: , //数字类型; 在玩的人uid
streamMaster:, //字符串类型;
streamSlave:, //字符串类型;
wawa:{ //JSON对象;玩具描述
ID: , //数字类型;娃娃ID
flag: , //数字类型;按位与运算,0位标识是否新品娃娃,1位标识是否热门
coin:, //数字类型;所需金币
fishball: , //数字类型;所需鱼丸
name:, //字符串类型;娃娃名称
icon:, //字符串类型;娃娃价值
pic: //字符串类型;娃娃缩略图
},
userModel: { //JOSN对象;玩儿家信息描述
uid:, //数字类型;用户ID
gender:, //数字类型;性别, 1男 0女
portrait:, //字符串类型;头像
nickname:, //字符串类型;昵称
spoils:, //字符串类型;生日 yyyy-MM-dd
}
}]
}
示例代码
var wawa = api.require('wawa');
wawa.requestRoomListAtPage(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestRoomListByIds
请求指定房间信息
requestRoomListByIds({params},callback(ret))
params
roomIds:
- 类型:数组
- 描述:房间列表的id组成的数组
callback(ret)
ret:
- 类型:JSON对象
- 描述:信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;信息
roomModels:[{ //数组类型; 游戏房间描述对象
ID:, //数字类型;房间ID
state: , //数字类型;房间状态: 小于1:故障 1:补货 2:空闲 大于2:游戏中
uid: , //数字类型; 在玩的人uid
streamMaster:, //字符串类型;
streamSlave:, //字符串类型;
wawa:{ //JSON对象;玩具描述
ID: , //数字类型;娃娃ID
flag: , //数字类型;按位与运算,0位标识是否新品娃娃,1位标识是否热门
coin:, //数字类型;所需金币
fishball: , //数字类型;所需鱼丸
name:, //字符串类型;娃娃名称
icon:, //字符串类型;娃娃价值
pic: //字符串类型;娃娃缩略图
},
userModel: { //JOSN对象;玩儿家信息描述
uid:, //数字类型;用户ID
gender:, //数字类型;性别, 1男 0女
portrait:, //字符串类型;头像
nickname:, //字符串类型;昵称
spoils:, //字符串类型;生日 yyyy-MM-dd
}
}]
}
示例代码
var wawa = api.require('wawa');
wawa.requestRoomListByIds(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
startRequestRoomTimer
启动首页数据刷新定时器
该方法首先会销毁当前刷新定时器,并根据当前period重新创建新的刷新定时器
startRequestRoomTimer({params},callback(ret))
params
interval:
- 类型:数字
- 描述:(可选项)定时器触发间隔,单位S, 最小10s
- 默认:15
示例代码
var wawa = api.require('wawa');
wawa.startRequestRoomTimer({
interval:20
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
cancelRequestRoomTimer
停止首页数据刷新定时器
该方法会立即停止当前激活的刷新定时器
cancelRequestRoomTimer()
示例代码
var wawa = api.require('wawa');
wawa.cancelRequestRoomTimer();
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestRoomInfo
获取房间信息与状态接口
requestRoomInfo({params},callback(ret))
params
roomId:
- 类型:数字
- 描述:房间列表的id
callback(ret)
ret:
- 类型:JSON对象
- 描述:信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;信息
roomModel:{ //JSON对象类型; 游戏房间描述对象
ID:, //数字类型;房间ID
state: , //数字类型;房间状态: 小于1:故障 1:补货 2:空闲 大于2:游戏中
uid: , //数字类型; 在玩的人uid
streamMaster:, //字符串类型;
streamSlave:, //字符串类型;
wawa:{ //JSON对象;玩具描述
ID: , //数字类型;娃娃ID
flag: , //数字类型;按位与运算,0位标识是否新品娃娃,1位标识是否热门
coin:, //数字类型;所需金币
fishball: , //数字类型;所需鱼丸
name:, //字符串类型;娃娃名称
icon:, //字符串类型;娃娃价值
pic: //字符串类型;娃娃缩略图
},
userModel: { //JOSN对象;玩儿家信息描述
uid:, //数字类型;用户ID
gender:, //数字类型;性别, 1男 0女
portrait:, //字符串类型;头像
nickname:, //字符串类型;昵称
spoils:, //字符串类型;生日 yyyy-MM-dd
}
}
}
示例代码
var wawa = api.require('wawa');
wawa.requestRoomInfo({
roomId:123
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestViewerWithRoomId
观众列表获取
requestViewerWithRoomId({params},callback(ret))
params
roomId:
- 类型:数字
- 描述:房间列表的id
page:
- 类型:数字
- 描述:页码
callback(ret)
ret:
- 类型:JSON对象
- 描述:信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;信息
userModels: [{ //数组类型;玩儿家信息描述
uid:, //数字类型;用户ID
gender:, //数字类型;性别, 1男 0女
portrait:, //字符串类型;头像
nickname:, //字符串类型;昵称
spoils:, //字符串类型;生日 yyyy-MM-dd
}]
}
示例代码
var wawa = api.require('wawa');
wawa.requestViewerWithRoomId({
roomId:123,
page:1
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
startRequestViewerTimer
开启定时刷新观众列表定时器,房间默认为当前进入的房间
startRequestViewerTimer({params},callback(ret))
params
interval:
- 类型:数字
- 描述:(可选项)定时器触发间隔,单位S, 最小10s
- 默认:15
示例代码
var wawa = api.require('wawa');
wawa.startRequestViewerTimer({
interval:20
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
cancelRequestViewerTimer
取消刷新观众列表定时器
cancelRequestViewerTimer()
示例代码
var wawa = api.require('wawa');
wawa.cancelRequestViewerTimer();
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestWawaDetail
娃娃详情查询
requestWawaDetail({params},callback(ret))
params
wid:
- 类型:数字
- 描述:娃娃的id
callback(ret)
ret:
- 类型:JSON对象
- 描述:信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;信息
wawaDetail:{ //JSON对象; 娃娃信息
ID:, //数字类型;娃娃 id
name: , //字符串类型;名称
size: , //数字类型;
coin:, //数字类型;单次抓娃娃消耗金币
recoverCoin:, //数字类型;可兑换金币数量
brand:, //字符串类型;品牌
suitAge:, //字符串类型;适用年龄
detailPics:, //字符串类型;娃娃详情图片,按逗号分开
filler:, //字符串类型;填充物
material:, //字符串类型;面料
icon:, //字符串类型;陈列柜图片
pic:, //字符串类型;封面图
level: //数字类型;等级
}
}
示例代码
var wawa = api.require('wawa');
wawa.requestWawaDetail({
roomId:123,
page:1
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestCatchHistory
查询房间最近抓中记录
requestCatchHistory({params},callback(ret))
params
roomId:
- 类型:数字
- 描述:房间 id
page:
- 类型:数字
- 描述:(可选项)请求第几页数据
- 默认:1
callback(ret)
ret:
- 类型:JSON对象
- 描述:信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;获取信息
roomCatchRecords:[{ //数组对象;房间内最近抓中游戏记录
dateline:, //字符串类型;
orderId: , //字符串类型;
wawaId: , //数字类型;
video: { //JSON对象;视频回放描述
machineStream:,//字符串类型;
livekey:, //字符串类型;
startTime:, //数字类型;单位为秒,从1970-1-1 00:00:00开始
duration: //数字类型;单位为秒
},
userModel: { //JOSN对象;抓中娃娃的人
uid:, //数字类型;用户ID
gender:, //数字类型;性别, 1男 0女
portrait:, //字符串类型;头像
nickname:, //字符串类型;昵称
spoils:, //数字类型;战利品个数
}
}]
}
示例代码
var wawa = api.require('wawa');
wawa.requestCatchHistory({
roomId: ,
page:
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestReplayVideoMessage
请求回放中 游戏操作信息
requestReplayVideoMessage({params},callback(ret))
params
roomId:
- 类型:数字
- 描述:房间 id
startTimeSecond:
- 类型:数字类型
- 描述:游戏开始时间,单位S,秒
piece:
- 类型:数字
- 描述:第几片数据 从1开始,1片30s
callback(ret)
ret:
- 类型:JSON对象
- 描述:信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;获取信息
infoList:[{}] //数组对象;信息数组,内部元素是JSON对象
}
示例代码
var wawa = api.require('wawa');
wawa.requestReplayVideoMessage({
roomId: ,
startTimeSecond:,
piece:
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestServerTime
获取当前的服务器时间
说明: 此接口用于分享游戏的时候获取服务器时间戳, 用于前端获取分享时间点, 进而获取分享时间点前后的游戏视频流
requestServerTime(callback(ret))
callback(ret)
ret:
- 类型:JSON对象
- 描述:信息
- 内部字段:
{
interval: //数字类型;状态码
}
示例代码
var wawa = api.require('wawa');
wawa.requestServerTime(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
enterRoom
加入房间
enterRoom({params},callback(ret))
params
roomModel:
- 类型:JSON对象
- 描述:房间描述
- 内部字段:
{
ID:, //数字类型;房间ID
streamMaster:, //字符串类型;
streamSlave: //字符串类型;
}
rect:
- 类型:JSON 对象
- 描述:(可选项)模块的位置及尺寸
- 内部字段:
{
x: 0, //(可选项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认:0
y: 0, //(可选项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认:0
w: 320, //(可选项)数字类型;模块的宽度;默认:'auto'
h: 200 //(可选项)数字类型;模块的高度;默认:'auto'
}
fixedOn:
- 类型:字符串类型
- 描述:(可选项)模块视图添加到指定 frame 的名字(只指 frame,传 window 无效)
- 默认:模块依附于当前 window
fixed:
- 类型:布尔
- 描述:(可选项)模块是否随所属 window 或 frame 滚动
- 默认值:true(不随之滚动)
callback(ret)
ret:
- 类型:JSON对象
- 描述:信息
- 内部字段:
{
status: //布尔类型;加入房间是否成功
}
示例代码
var wawa = api.require('wawa');
wawa.enterRoom({
rect:{
x:,
y:,
w:,
h:
},
fixedOn:'',
fixed:,
roomModel:{
}
},function(ret) {
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
showRoom
显示房间视频区域
showRoom()
示例代码
var wawa = api.require('wawa');
wawa.showRoom();
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
hideRoom
隐藏房间视频区域
hideRoom()
示例代码
var wawa = api.require('wawa');
wawa.hideRoom();
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
closeRoom
关闭房间视频区域
closeRoom()
示例代码
var wawa = api.require('wawa');
wawa.closeRoom();
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
exitRoom
销毁房间, 离开房间时务必调用, 否则会影响之后的逻辑
exitRoom()
示例代码
var wawa = api.require('wawa');
wawa.exitRoom();
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
startGamePlayer
开始播放娃娃机视频流换面
startGamePlayer()
示例代码
var wawa = api.require('wawa');
wawa.startGamePlayer();
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
stopGamePlayer
停止播放娃娃机视频流换面
stopGamePlayer()
示例代码
var wawa = api.require('wawa');
wawa.stopGamePlayer();
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestStartGame
特别注意: 在调用此接口前, 请确保用户信息已经注入到SDK用户信息回调中, 否则上机操作会直接失败
requestStartGame(callback(ret))
callback(ret)
ret:
- 类型:JSON对象
- 描述:信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //布尔类型;是否获取成功
orderID: '' //布尔类型;是否获取成功
}
示例代码
var wawa = api.require('wawa');
wawa.requestStartGame(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestOperation
游戏操作, 上下左右操作
requestOperation({params},callback(ret))
params
direction:
- 类型:字符串
- 描述:(可选项)方向
- 默认:up
- 取值范围:
- none:未知
- up:
- down:
- left:
- right:
- confirm:下抓
type:
- 类型:字符串
- 描述:(可选项)操作类型
- 默认:click
- 取值范围:
- click:点击
- longPress:长按
- release:抬起
- reverse:撤销长按
callback(ret)
ret:
- 类型:JSON对象
- 描述:信息
- 内部字段:
{
code: , //数字类型;状态码
msg: ‘’ //字符串类型;请求信息
}
示例代码
var wawa = api.require('wawa');
wawa.requestOperation({
direction: 'up',
type: longpress
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestClawWithForceRelease
游戏下爪操作
注: 下爪操作涉及到硬件上的判断娃娃到底有没有抓到, 所以结果回调需要相对较长的时间
参数说明: 要不要强制释放上机锁定(例如:用户点击了下爪之后,在结果回来之前就离开了房间,就放弃了再来一局的机会,需要传入YES来释放等待用户8s选择是否再来一局的必要)
requestClawWithForceRelease({params},callback(ret))
params
forceRelease:
- 类型:布尔
- 描述:(可选项)是否强制释放上机锁定
- 默认:false
callback(ret)
ret:
- 类型:JSON对象
- 描述:信息
- 内部字段:
{
code: , //数字类型;状态码
message: '' //字符串类型;信息
resultModel: { //JSON对象;抓取的结果
ID:, //数字类型;id
dateline:, //字符串类型;时间
orderId:, //字符串类型;订单号
uid:, //数字类型;用户ID
rid:, //数字类型;rid
playTimes:, //数字类型;上机时间
clawTimes:, //数字类型;游戏(摇爪操作)时间
video:, //字符串类型;游戏视频
coin:, //数字类型;奖励
awardFishball:,//数字类型;奖励
state:, //数字类型;状态, 0,1失败,2成功
stage:, //数字类型;-1上机失败,1:上机中,2:摇杆中, 3:下抓中, 4:游戏结束, 5: 游戏申述
wawaSuccess:, //数字类型;已有多少人抓住了娃娃
wawa:{ //JSON对象;抓取的娃娃信息
ID:, //数字类型;娃娃 ID
flag:, //数字类型;按位与运算,0位标识是否新品娃娃,1位标识是否热门
coin:, //数字类型;所需金币
name:, //字符串类型;娃娃名称
icon:, //字符串类型;娃娃价值
pic: //字符串类型;娃娃缩略图
}
}
}
示例代码
var wawa = api.require('wawa');
wawa.requestClawWithForceRelease({
forceRelease: true
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
sendDamuMsg
发送弹幕
sendDamuMsg({params})
params
msg:
- 类型:字符串
- 描述:要发送的字符串
示例代码
var wawa = api.require('wawa');
wawa.sendDamuMsg({
msg:‘抓啊!’
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
requestQuickOnBoard
快速上机请求, 无需传入参数, 会根据当前的机器空闲情况自动为用户分配可使用的机器
特别注意: 在调用此接口前, 请确保用户信息已经注入到SDK用户信息回调中, 否则上机操作会直接失败
requestQuickOnBoard(callback(ret))
callback(ret)
ret:
- 类型:JSON对象
- 描述:信息
- 内部字段:
{
code: , //数字类型;状态码
message: ‘’ //字符串类型;请求信息
room: { //JSON对象; 游戏房间描述对象
ID:, //数字类型;房间ID
state: , //数字类型;房间状态: 小于1:故障 1:补货 2:空闲 大于2:游戏中
uid: , //数字类型; 在玩的人uid
streamMaster:, //字符串类型;
streamSlave:, //字符串类型;
wawa:{ //JSON对象;玩具描述
ID: , //数字类型;娃娃ID
flag: , //数字类型;按位与运算,0位标识是否新品娃娃,1位标识是否热门
coin:, //数字类型;所需金币
name:, //字符串类型;娃娃名称
icon:, //字符串类型;娃娃价值
pic: //字符串类型;娃娃缩略图
},
userModel: { //JOSN对象;玩儿家信息描述
uid:, //数字类型;用户ID
gender:, //数字类型;性别, 1男 0女
portrait:, //字符串类型;头像
nickname:, //字符串类型;昵称
spoils:, //字符串类型;战利品个数
}
}
}
示例代码
var wawa = api.require('wawa');
wawa.requestQuickOnBoard(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
cameraSwitchIsFront
切换摄像头
cameraSwitchIsFront({params})
params
isFront:
- 类型:布尔
- 描述:(可选项)是否要切换到正面摄像头, 传入true会切换到正面摄像头, 传入false则会切换到侧面摄像头
- 默认:true
示例代码
var wawa = api.require('wawa');
wawa.cameraSwitchIsFront({
isFront: true
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
addEventListener
添加监听
addEventListener({params},callback(ret,err))
params
name:
- 类型:字符串
- 描述:指定监听的行为
取值范围:
userInfoError:用户信息错误事件
roomListChange:当前房间列表首页数据有变化
viewerListChange:当前进入房间的观众列表数据有变化
gameManagerError:游戏管理器错误信息事件
- onMasterStreamReady:主摄像头的流已经加载成功了
onSlaveStreamReady:辅摄像头的流已经加载成功了
reciveRemoteMsg:收到聊天回调
- reciveWatchNumber:收到 观看人数
- reciveRoomUpdateData:收到 房间状态更新
- reciveClawResult:房间内收到 抓娃娃结果通知
- reciveGlobleMessage:收到全平台 抓娃娃结果通知
- avatarTtlDidChanged:ping游戏服务器延迟变更, 没2s ping一次
callback(ret,err)
ret:
- 类型:JSON对象
- 描述:监听结果,当name 为onMasterStreamReady和onSlaveStreamReady时,仅回调事件,无任何参数
- 内部字段:
{
userInfoErrCode:1 //数字类型;用户信息错误码,仅当name 为 userInfoErr、gameManagerError时本字段有值
//-1:未知错误
//0:未登录
//1:财富信息不足
roomModels:[] //数组类型;同requestRoomListByIds接口返回的数据结构一致,仅当name 为roomListChange 时有值
userModels:[{ //数组类型;仅当name 为viewerListChange 时有值
uid:, //数字类型;用户ID
gender:, //数字类型;性别, 1男 0女
portrait:, //字符串类型;头像
nickname:, //字符串类型;昵称
spoils:, //字符串类型;战利品个数
}]
chatModel:{ //JSON对象;远端聊天信息,仅当name 为 reciveRemoteMsg 时本字段有值
content: '', //字符串类型;发言内容
fromUser:{ //JSON对象;发信息的用户
uid:, //数字类型;用户ID
gender:, //数字类型;性别, 1男 0女
portrait:, //字符串类型;头像
nickname:, //字符串类型;昵称
spoils:, //字符串类型;战利品个数
},
mentions:[{ //JSON对象;@的用户
uid:, //数字类型;用户ID
gender:, //数字类型;性别, 1男 0女
portrait:, //字符串类型;头像
nickname:, //字符串类型;昵称
spoils:, //字符串类型;战利品个数
}]
}
number: //数字类型;收到的观看人数,仅当name 为reciveWatchNumber时有值
liveData:{ //JSON对象;房间状态更新数据,仅当 name为reciveRoomUpdateData时有值
streamPlayer:, //字符串类型;上机者流地址(暂未提供游戏者推流)
user:{}, //JSON对象;同requestUserInfo接口返回值一致
state: //数字类型;取值范围如下:
//-100:机器回收
//-1:机器下架
//0:机器故障
//:补货中
//2: 空闲
//3:开始游戏
//4: 移动中
//5:下抓(等待结果)
//6: 等待重新上机
}
result:{ //JSON对象;房间内收到 抓娃娃结果,仅当name 为reciveClawResult时有值
status:, //数字类型;1:未抓中; 2:抓中;
user{} //JSON对象;同requestUserInfo接口返回值一致
}
message: //字符串类型;收到全平台 抓娃娃结果,仅当name 为reciveGlobleMessage时有值
ttl: //数字类型;ping游戏服务器延迟变更,仅当name 为avatarTtlDidChanged时有值
}
示例代码
var wawa = api.require('wawa');
wawa.addEventListener({
name:'userInfoError'
},function(ret){
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
removeEventListener
移除监听
removeEventListener({params},calback(ret))
params
name:
- 类型:字符串
- 描述:指定监听的行为
取值范围:
userInfoError:用户信息错误事件
roomListChange:当前房间列表首页数据有变化
viewerListChange:当前进入房间的观众列表数据有变化
gameManagerError:游戏管理器错误信息事件
- onMasterStreamReady:主摄像头的流已经加载成功了
onSlaveStreamReady:辅摄像头的流已经加载成功了
reciveRemoteMsg:收到聊天回调
- reciveWatchNumber:收到 观看人数
- reciveRoomUpdateData:收到 房间状态更新
- reciveClawResult:房间内收到 抓娃娃结果通知
- reciveGlobleMessage:收到全平台 抓娃娃结果通知
- avatarTtlDidChanged:ping游戏服务器延迟变更, 没2s ping一次
示例代码
var wawa = api.require('wawa');
wawa.removeEventListener({
name:'userInfoError'
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本