社区提供的接口说明

1.授权用户

接口地址

/tenant/authorization

简要描述

授权租户下的用户到社区

参数

参数名	必选	类型	说明
token	是	string	授权令牌
avatar	否	string	头像URL
nick	是	string	昵称
uid	是	string	用户ID
tenantId	是	string	租户ID

返回示例

  {
    "success": true,
    "code": 0,
    "data": {}
}

返回参数说明

参数名	类型	说明
success	Boolean	成功与否
code	Integer	错误码
data	JSONObject	返回信息

备注

code 错误码 0 成功非0 不成功如1040201 余额不足

2.发送会员钱包信息(接入方->社区方)

接口地址

/tenant/event

简要描述

发送会员钱包信息,如现金，彩金，NBC币，积分余额

参数

参数名	必选	类型	说明	参数值
type	是	string	事件名	member_balance.sync
data	是	string	事件数据	见data参数
tenantId	是	string	租户id

data参数

参数名	必选	类型	说明
cash	是	string	现金余额
bonus	是	string	彩金余额
nbc	是	string	nbc币余额
score	是	string	积分余额
uid	是	string	会员uid

返回示例

  {
    "success": true,
    "code": 0,
    "data": {}
}

返回参数说明

参数名	类型	说明
success	Boolean	成功与否
code	Integer	错误码
data	JsonOjbect	返回信息

备注

code 错误码 0 成功非0 不成功如1040201 余额不足

3.发送会员打开转盘事件(接入方->社区方)

接口地址

/tenant/event

简要描述

发送会员打开转盘事件,传递打开转盘时消耗类型，会员终端类型，会员分层id

参数

参数名	必选	类型	说明	参数值
type	是	string	事件名	turntable.open
data	是	string	事件数据	见data参数
tenantId	是	string	租户id

data参数

参数名	必选	类型	说明
consumeType	是	string	消耗余额类型 1-彩金 2-nbc币 3-积分 4-现金
terminalType	是	string	会员终端类型 3--h5 4--android app 5--ios app 6--pwa
rankId	是	string	会员分层id
uid	是	string	会员uid

返回示例

  {
    "success": true,
    "code": 0,
    "data": {}
}

返回参数说明

参数名	类型	说明
success	Boolean	成功与否
code	Integer	错误码
data	JsonOjbect	返回信息

备注

code 错误码 0 成功非0 不成功如1040203 消耗类型不存在

4.发送租户分层列表事件(接入方->社区方)

接口地址

/tenant/event

简要描述

发送租户分层列表事件,租户分层列表有变动时实时通知社区方

参数

参数名	必选	类型	说明	参数值
type	是	string	事件名	tenant.rank.sync
data	是	string	事件数据	见data参数
tenantId	是	string	租户id

data参数

参数名	必选	类型	说明
rankList	是	Array	租户分层列表 [{"id":243143124,"name":"测试分层"}]

返回示例

  {
    "success": true,
    "code": 0,
    "data": {}
}

返回参数说明

参数名	类型	说明
success	Boolean	成功与否
code	Integer	错误码
data	JsonOjbect	返回信息

备注

code 错误码 0 成功非0 不成功如1040204 分层列表数据为空

5.发送会员打开红包雨事件(接入方->社区方)

接口地址

/tenant/event

简要描述

发送会员打开红包雨事件,传递打开红包雨时消耗类型，会员终端类型，会员分层id

参数

参数名	必选	类型	说明	参数值
type	是	string	事件名	redpacket.rain.open
data	是	string	事件数据	见data参数
tenantId	是	string	租户id

data参数

参数名	必选	类型	说明
consumeType	是	string	消耗余额类型 1-彩金 2-nbc币 3-积分 4-现金
terminalType	是	string	会员终端类型 3--h5 4--android app 5--ios app 6--pwa
rankId	是	string	会员分层id
uid	是	string	会员uid

返回示例

  {
    "success": true,
    "code": 0,
    "data": {}
}

返回参数说明

参数名	类型	说明
success	Boolean	成功与否
code	Integer	错误码
data	JsonOjbect	返回信息

备注

code 错误码 0 成功非0 不成功如1040203 消耗类型不存在

6.接收会员在社区组件中的奖信息事件(社区方->接入方)

接口地址

社区管理端后台配置的接入方回调地址

简要描述

接收会员转盘中奖信息，如中奖金额，打码量倍数，消耗类型，组件名，用户id

参数

参数名	必选	类型	说明	参数值
type	是	string	事件名	player.reward
data	是	string	事件数据	见data参数
tenantId	是	string	租户id

data参数

参数名	必选	类型	说明
consumeType	是	string	消耗余额类型 1-彩金 2-nbc币 3-积分 4-现金
amount	是	string	中奖金额
betRate	是	string	打码量倍数
gameName	是	string	参与的组件名(各组件要唯一)
uid	是	string	会员uid

返回示例

  {
    "success": true,
    "code": 0,
    "data": {}
}

返回参数说明

参数名	类型	说明
success	Boolean	成功与否
code	Integer	错误码
data	JsonObject	返回信息

备注

code 错误码 0 成功非0 不成功如1040206 游戏数据不正确

7.接收会员在社区组件中的消耗金额事件(社区方->接入方)

接口地址

社区管理端后台配置的接入方回调地址

简要描述

接收会员在社区组件中的消耗金额信息，如金额，消耗类型

参数

参数名	必选	类型	说明	参数值
type	是	string	事件名	player.consume
data	是	string	事件数据	见data参数
tenantId	是	string	租户id

data参数

参数名	必选	类型	说明
consumeType	是	string	消耗余额类型 1-彩金 2-nbc币 3-积分 4-现金
amount	是	string	中奖金额
gameName	是	string	参与的组件名(各组件要唯一)
uid	是	string	会员uid

返回示例

  {
    "success": true,
    "code": 0,
    "data": {}
}

返回参数说明

参数名	类型	说明
success	Boolean	成功与否
code	Integer	错误码
data	JsonObject	返回信息

备注

code 错误码 0 成功非0 不成功如1040207 消耗类型不存在

8.加减用户虚拟币余额

接口地址

/tenant/event

简要描述

更新用户当前虚拟币余额

参数

参数名	必选	类型	说明	参数值
type	是	string	事件名	coin.balance.update
data	是	string	事件数据	见data参数
tenantId	是	string	租户id

data参数

参数名	必选	类型	说明
amount	是	string	增减的金额(扣余额传负数金额)
userId	是	string	会员id

返回示例

  {
    "success": true,
    "code": 0,
    "data": {}
}

返回参数说明

参数名	类型	说明
success	Boolean	成功与否
code	Integer	错误码
data	JSONObject	返回信息

备注

code 错误码 0 成功非0 不成功如1040211 会员不存在

9.查询用户虚拟币余额

接口地址

/tenant/event

简要描述

查询用户当前虚拟币余额

参数

参数名	必选	类型	说明	参数值
type	是	string	事件名	coin.balance
data	是	string	事件数据	见data参数
tenantId	是	string	租户id

data参数

参数名	必选	类型	说明
userId	是	string	会员id

返回示例

  {
    "success": true,
    "code": 0,
    "data": {}
}

返回参数说明

参数名	类型	说明
success	Boolean	成功与否
code	Integer	错误码
data	JSONObject	返回信息

备注

code 错误码 0 成功非0 不成功如1040211 会员不存在

10.转盘狀態状态事件(接入方->社区方)

接口地址

/tenant/event

简要描述

发送会员打开转盘事件,传递打开转盘时消耗类型，会员终端类型，会员分层id

参数

参数名	必选	类型	说明	参数值
type	是	string	事件名	turntable.status
data	是	string	事件数据	见data参数
tenantId	是	string	租户id

data参数

返回示例

  {
    "success": true,
    "code": 0,
    "data": {}
}

返回参数说明

参数名	类型	说明
success	Boolean	成功与否
code	Integer	错误码
data	JsonOjbect	返回信息

data参数

参数名	必选	类型	说明
status	是	integer	狀態 1:開啟,0:未開啟

备注

code 错误码 0 成功非0 不成功如1040203 消耗类型不存在

11.红包雨状态(接入方->社区方)

接口地址

/tenant/event

简要描述

发送会员打开红包雨事件,传递打开红包雨时消耗类型，会员终端类型，会员分层id

参数

参数名	必选	类型	说明	参数值
type	是	string	事件名	redpacket.rain.status
data	是	string	事件数据	见data参数
tenantId	是	string	租户id

data参数

返回示例

  {
    "success": true,
    "code": 0,
    "data": {}
}

返回参数说明

参数名	类型	说明
success	Boolean	成功与否
code	Integer	错误码
data	JsonOjbect	返回信息

data参数

参数名	必选	类型	说明
status	是	integer	狀態 1:開啟,0:未開啟

备注

code 错误码 0 成功非0 不成功如1040203 消耗类型不存在

12.获取社区所有活动状态事件(接入方->社区方)

接口地址

/tenant/event

简要描述

获取社区里转盘，红包雨，签到等各种活动的开启关闭状态，用于接入方判断是否显示社区活动

参数

参数名	必选	类型	说明	参数值
type	是	string	事件名	activity.status
data	是	string	事件数据	见data参数
tenantId	是	string	租户id

data参数

返回示例

  {
    "success": true,
    "code": 0,
    "data": {}
}

返回参数说明

参数名	类型	说明
success	Boolean	成功与否
code	Integer	错误码
data	JsonOjbect	返回信息

data参数

参数名	必选	类型	说明
status	是	integer	狀態 1:開啟,0:未開啟

备注

code 错误码 0 成功非0 不成功如1040203 服务异常

C2C红包组件

1.发送会员C2C代付事件(接入方->社区方)

接口地址

/tenant/event

简要描述

发送会员C2C代付事件,传递提现会员的银行信息，卡号，会员id，提现金额等

参数

参数名	必选	类型	说明	参数值
type	是	string	事件名	c2c.withdraw.daifu
data	是	string	事件数据	见data参数
tenantId	是	string	租户id

data参数

参数名	必选	类型	说明
callbackUrl	是	String	回调地址
withdrawMoney	是	BigDecimal	提现金额
username	是	string	会员用户名
orderNo	是	string	提现订单号
userId	是	Long	提现会员id
bankCardNo	是	string	银行卡号
bankName	是	string	银行名称

返回示例

  {
    "success": true,
    "code": 0,
    "data": {"thirdOrderNo":"C1341992474"}
}

返回参数说明

参数名	类型	说明
success	Boolean	成功与否
code	Integer	错误码
data	JsonOjbect	返回信息

备注

code 错误码 0 成功非0 不成功如1040203 会员不存在

2.发送会员C2C充值事件(接入方->社区方)

接口地址

/tenant/event

简要描述

发送会员发起C2C充值事件,接入方会员充值时向社区发起充值，社区返回充值跳转链接(聊天室链接,即有单可以抢的聊天室链接)

参数

参数名	必选	类型	说明	参数值
type	是	string	事件名	c2c.deposit.daishou
data	是	string	事件数据	见data参数
tenantId	是	string	租户id

data参数

参数名	必选	类型	说明
callbackUrl	是	string	充值成功与否的回调地址(社区方发送回调)
merchNo	否	string	社区分配给接入方的商户号
merchSecret	否	Long	社区分配给接入方的商户秘钥
amount	否	BigDecimal	充值金额
userId	是	Long	充值会员id
orderTime	否	String	订单时间如 'yyyy-MM-dd HH:mm:ss'

返回示例

  {
    "success": true,
    "code": 0,
    "data": {"link":"https://community.chat.com/3245141231/cid/2341",cid:2341,"thirdOrderNo":"C1341992474"}
}

返回参数说明

参数名	类型	说明
success	Boolean	成功与否
code	Integer	错误码
data	JSONOjbect	返回信息

备注

code 错误码 0 成功非0 不成功如1040203 会员不存在

3.接收会员C2C充值回调事件(社区方->接入方)

接口地址

接入方发起充值c2c代付时传过去的回调地址

简要描述

接收会员在社区-聊天室中的充值成功或失败时的回调事件，回传社区抢单充值订单号，提现单订单号，会员id等信息

参数

无

返回示例

  {
    "success": true,
    "code": 0,
    "data": {"depositOrderNo":"D3478213941234","amount":100.50,"withdrawOrderNo":"W987921436134","userId":746283141237}
}

返回参数说明

参数名	类型	说明
success	Boolean	成功与否
code	Integer	错误码
data	JsonOjbect	返回信息

返回的data参数说明

参数名	类型	说明
depositOrderNo	String	充值订单号
amount	BigDecimal	充值金额
withdrawOrderNo	String	接入方开始时发给社区的订单号
userId	Long	抢单会员id

备注

code 错误码 0 成功非0 不成功如1040213 订单已过期

4.获取社区用于c2c的可用聊天室列表(接入方->社区方)

接口地址

/tenant/event

简要描述

获取社区用于c2c的可用聊天室列表,用于接入方发起c2c提现代付时选择进入哪个聊天室

参数

参数名	必选	类型	说明	参数值
type	是	string	事件名	c2c.chat.list
data	是	string	事件数据	见data参数
tenantId	是	string	租户id

返回示例

  {
    "success": true,
    "code": 0,
    "data": {}
}

返回参数说明

参数名	类型	说明
success	Boolean	成功与否
code	Integer	错误码
data	JsonOjbect	返回信息

返回data参数

参数名	必选	类型	说明
link	是	String	聊天室链接地址
chatId	是	String	聊天室id
sortNo	是	Integer	排序号
chatName	是	String	聊天室名称

备注

code 错误码 0 成功非0 不成功如1040203 暂无c2c聊天室列表

5.获取社区会员抢单凭证(接入方->社区方)

接口地址

/tenant/event

简要描述

获取社区会员在聊天室里抢单后上传的凭证，以供接入方站长或会员确认凭证
注：接入方在收到会员C2C充值回调事件之后才去调用此接口获取对应凭证

参数

参数名	必选	类型	说明	参数值
type	是	string	事件名	c2c.deposit.certificate
data	是	string	事件数据	见data参数
tenantId	是	string	租户id

data参数

参数名	必选	类型	说明
depositOrderNo	是	string	充值(抢单时生成的)订单号

返回示例

  {
    "success": true,
    "code": 0,
    "data": {}
}
file:MultipartFile //文件流

返回参数说明

参数名	类型	说明
success	Boolean	成功与否
code	Integer	错误码
data	JsonOjbect	返回信息
file	MultipartFile	抢单凭证文件(社区方请先压缩)

备注

code 错误码 0 成功非0 不成功如1040203 暂无此订单号对应的凭证文件

6. 同步充值及提现单状态(接入方->社区方)

接口地址

/tenant/event

简要描述

接入方站长或会员确认凭证且接入方平台处理订单后，将凭证确认结果，订单处理结果同步通知给社区方以便更新社区抢单的订单状态等信息

参数

参数名	必选	类型	说明	参数值
type	是	string	事件名	c2c.deposit.withdraw.sync
data	是	string	事件数据	见data参数
tenantId	是	string	租户id

data参数

参数名	必选	类型	说明
depositOrderNo	是	string	充值(抢单时生成的)订单号
orderStatus	是	Integer	订单处理状态 0--成功 1--失败
certConfirmStatus	是	Integer	确认状态 0--通过 1--不通过

返回示例

  {
    "success": true,
    "code": 0,
    "data": {}
}

返回参数说明

参数名	类型	说明
success	Boolean	成功与否
code	Integer	错误码
data	JsonOjbect	返回信息

备注

code 错误码 0 成功非0 不成功如1040203 订单号不存在

社区提供的接口说明 ​

1.授权用户 ​

接口地址 ​

简要描述 ​

参数 ​

返回示例 ​

返回参数说明 ​

备注 ​

2.发送会员钱包信息(接入方->社区方) ​

接口地址 ​

简要描述 ​

参数 ​

data参数 ​

返回示例 ​

返回参数说明 ​

备注 ​

3.发送会员打开转盘事件(接入方->社区方) ​

接口地址 ​

简要描述 ​

参数 ​

data参数 ​

返回示例 ​

返回参数说明 ​

备注 ​

4.发送租户分层列表事件(接入方->社区方) ​

接口地址 ​

简要描述 ​

参数 ​

data参数 ​

返回示例 ​

返回参数说明 ​

备注 ​

5.发送会员打开红包雨事件(接入方->社区方) ​

接口地址 ​

简要描述 ​

参数 ​

data参数 ​

返回示例 ​

返回参数说明 ​

备注 ​

6.接收会员在社区组件中的奖信息事件(社区方->接入方) ​

接口地址 ​

简要描述 ​

参数 ​

data参数 ​

返回示例 ​

返回参数说明 ​

备注 ​

7.接收会员在社区组件中的消耗金额事件(社区方->接入方) ​

接口地址 ​

简要描述 ​

参数 ​

data参数 ​

返回示例 ​

返回参数说明 ​

备注 ​

8.加减用户虚拟币余额 ​

接口地址 ​

简要描述 ​

参数 ​

data参数 ​

返回示例 ​

返回参数说明 ​

备注 ​

9.查询用户虚拟币余额 ​

接口地址 ​

简要描述 ​

参数 ​

data参数 ​

返回示例 ​

返回参数说明 ​

备注 ​

10.转盘狀態状态事件(接入方->社区方) ​

接口地址 ​

简要描述 ​

参数 ​

data参数 ​

返回示例 ​

返回参数说明 ​

data参数 ​

社区提供的接口说明

1.授权用户

接口地址

简要描述

参数

返回示例

返回参数说明

备注

2.发送会员钱包信息(接入方->社区方)

接口地址

简要描述

参数

data参数

返回示例

返回参数说明

备注

3.发送会员打开转盘事件(接入方->社区方)

接口地址

简要描述

参数

data参数

返回示例

返回参数说明

备注

4.发送租户分层列表事件(接入方->社区方)

接口地址

简要描述

参数

data参数

返回示例

返回参数说明

备注

5.发送会员打开红包雨事件(接入方->社区方)

接口地址

简要描述

参数

data参数

返回示例

返回参数说明

备注

6.接收会员在社区组件中的奖信息事件(社区方->接入方)

接口地址

简要描述

参数

data参数

返回示例

返回参数说明

备注

7.接收会员在社区组件中的消耗金额事件(社区方->接入方)

接口地址

简要描述

参数

data参数

返回示例

返回参数说明

备注

8.加减用户虚拟币余额

接口地址

简要描述

参数

data参数

返回示例

返回参数说明

备注

9.查询用户虚拟币余额

接口地址

简要描述

参数

data参数

返回示例

返回参数说明

备注

10.转盘狀態状态事件(接入方->社区方)

接口地址

简要描述

参数

data参数

返回示例

返回参数说明

data参数