德扑开放平台

Version	Update Time	Status	Author	Description
v2025-06-23 11:04:58	2025-06-23 11:04:58	auto	@root	Created by smart-doc

Version

Update Time

Status

Author

Description

v2025-06-23 11:04:58

2025-06-23 11:04:58

auto

@root

Created by smart-doc

1.接入流程

1.1.接入规则

URL: ./process/step1

Type: POST

Content-Type: application/x-www-form-urlencoded

Description:
联系我司运营人员获取应用ID以及密钥

请求规则:

1.所有的请求都是POST

2.所有的请求体报文格式Content-Type: application/json

3.http响应码，只处理20X为成功，其他均失败

必要的请求头：

Authorization：认证令牌，应用ID，用于我们双方通信认证唯一标识

X-Timestamp：发送请求时的UTC时间戳，如果不在3分钟范围内，服务器会拒绝

X-Signature：请求签名，=AES-128(密钥，原文)，签名规则如下

签名原文，由4个部分组成，uri、发送时间、认证令牌、请求体（json字符串）。每个部分换行隔开，没有则空行，例如：

密钥：n3IB7Tl6jEKRYxZK2VH7wA==

签名原文如下：

/login
1745911956858
d7ec4e5e80ae448abfe21c64335bc9cb
json字符串(这儿因为一些插件解析原因普通文本字符串代替)

签名结果：KKoei6UEAKvAvxVjl/631j5AwAWkKxx1RXLK2QB47iwDfS6ViVLoxBjzv/9STj+vl//DSKmUqnTOc5N+sWsFGqNFdDDB5x7EgFKZAiPFOFPq+yar1ZBn5+ASbw644zCHilKkPMVaiG+ZsbeaIH3U9hqLr2/Voh39G49j5iULeg1N1ZRSwi9tTE/wmKAhyWWw

<b>回调地址</b>, 联系我方运营人员修改

Request-headers:

Header	Type	Description	Required	Since
Authorization	string	APP ID	true	-
X-Timestamp	string	发送时间	true	-
X-Signature	string	防伪签名	true	-

Header

Type

Description

Required

Since

Authorization

string

APP ID

true

X-Timestamp

string

发送时间

true

X-Signature

string

防伪签名

true

Request-example:

curl -X POST -H "Authorization" -H "X-Timestamp" -H "X-Signature" -i './process/step1'

Response-example:

Return void.

2.注册与登录

2.1.注册

URL: ./register

Type: POST

Content-Type: application/json

Description: 如果用户的上级不存在，则会自动创建上级

Request-headers:

Header	Type	Description	Required	Since
Authorization	string	APP ID	true	-
X-Timestamp	string	发送时间	true	-
X-Signature	string	防伪签名	true	-

Header

Type

Description

Required

Since

Authorization

string

APP ID

true

X-Timestamp

string

发送时间

true

X-Signature

string

防伪签名

true

Body-parameters:

Parameter	Type	Description	Required	Since
openId	string	用户ID，唯一标识	true	-
name	string	昵称	true	-
parentOpenId	string	上级openId，默认无上级	false	-
userProxy	boolean		false	-

Parameter

Type

Description

Required

Since

openId

string

用户ID，唯一标识

true

name

string

昵称

true

parentOpenId

string

上级openId，默认无上级

false

userProxy

boolean

false

Request-example:

curl -X POST -H "Content-Type: application/json" -H "Authorization" -H "X-Timestamp" -H "X-Signature" -i './register' --data '{"openId":"UUID","name":"大飞","parentOpenId":"","userProxy":false
默认普通用户，是否是上级代理用户，会创建私人俱乐部，可以绑定下级}'

Response-fields:

Field	Type	Description	Since
openId	string	id	-
userId	int32	名称	-

Field

Type

Description

Since

openId

string

userId

int32

名称

Response-example:

[
  {
    "openId": "",
    "userId": 0
  }
]

2.2.登录

URL: ./joinGameLink

Type: POST

Content-Type: application/json

Description: 用户登录，返回加入游戏的连接

Request-headers:

Header	Type	Description	Required	Since
Authorization	string	APP ID	true	-
X-Timestamp	string	发送时间	true	-
X-Signature	string	防伪签名	true	-

Header

Type

Description

Required

Since

Authorization

string

APP ID

true

X-Timestamp

string

发送时间

true

X-Signature

string

防伪签名

true

Body-parameters:

Parameter	Type	Description	Required	Since
openId	string	用户ID 唯一标识	true	-
name	string	用户昵称，非必须，如果存在则会更新用户的名称	false	-

Parameter

Type

Description

Required

Since

openId

string

用户ID 唯一标识

true

name

string

用户昵称，非必须，如果存在则会更新用户的名称

false

Request-example:

curl -X POST -H "Content-Type: application/json" -H "Authorization" -H "X-Timestamp" -H "X-Signature" -i './joinGameLink' --data '{
  "openId": "",
  "name": ""
}'

Response-example:

string

3.转账钱包API

3.1.余额查询

URL: ./getBalance

Type: POST

Content-Type: application/json

Description: 如果返回得结果集中不包含某个openId的数据，则该openId对应的用户不存在

Request-headers:

Header	Type	Description	Required	Since
Authorization	string	APP ID	true	-
X-Timestamp	string	发送时间	true	-
X-Signature	string	防伪签名	true	-

Header

Type

Description

Required

Since

Authorization

string

APP ID

true

X-Timestamp

string

发送时间

true

X-Signature

string

防伪签名

true

Body-parameters:

Parameter	Type	Description	Required	Since
openIds	array	用户开放ID	false	-

Parameter

Type

Description

Required

Since

openIds

array

用户开放ID

false

Request-example:

curl -X POST -H "Content-Type: application/json" -H "Authorization" -H "X-Timestamp" -H "X-Signature" -i './getBalance' --data '{
  "openIds": [
    ""
  ]
}'

Response-fields:

Field	Type	Description	Since
openId	string	用户开放ID	-
balance	number	余额	-
updateAt	string	最后更新时间	-

Field

Type

Description

Since

openId

string

用户开放ID

balance

number

余额

updateAt

string

最后更新时间

Response-example:

[
  {
    "openId": "",
    "balance": 0,
    "updateAt": "yyyy-MM-dd HH:mm:ss"
  }
]

3.2.上下分

URL: ./transferWallet

Type: POST

Content-Type: application/json

Description: 上下分

Request-headers:

Header	Type	Description	Required	Since
Authorization	string	APP ID	true	-
X-Timestamp	string	发送时间	true	-
X-Signature	string	防伪签名	true	-

Header

Type

Description

Required

Since

Authorization

string

APP ID

true

X-Timestamp

string

发送时间

true

X-Signature

string

防伪签名

true

Body-parameters:

Parameter	Type	Description	Required	Since
openId	string	用户ID Validation[Length(min=1, max=32, message=用户字符长度在1-32之间) ]	true	-
amount	number	金额	true	-
memo	string	备注，该字段提供数据过滤，建议贵司系统订单号 Validation[Length(min=0, max=200, message=备注字符在1-200之间) ]	false	-
extend	string	拓展数据 Validation[Length(min=0, max=500, message=拓展信息字符在1-500之间) ]	false	-

Parameter

Type

Description

Required

Since

openId

string

用户ID Validation[Length(min=1, max=32, message=用户字符长度在1-32之间) ]

true

amount

number

金额

true

memo

string

备注，该字段提供数据过滤，建议贵司系统订单号 Validation[Length(min=0, max=200, message=备注字符在1-200之间) ]

false

extend

string

拓展数据 Validation[Length(min=0, max=500, message=拓展信息字符在1-500之间) ]

false

Request-example:

curl -X POST -H "Content-Type: application/json" -H "Authorization" -H "X-Timestamp" -H "X-Signature" -i './transferWallet' --data '{
  "openId": "",
  "amount": 0,
  "memo": "",
  "extend": ""
}'

Response-fields:

Field	Type	Description	Since
tradeId	int32	交易ID	-
success	boolean	是否成功	-
balance	number	余额	-
realChange	number	实际变更金额	-

Field

Type

Description

Since

tradeId

int32

交易ID

success

boolean

是否成功

balance

number

余额

realChange

number

实际变更金额

Response-example:

{
  "tradeId": 0,
  "success": true,
  "balance": 0,
  "realChange": 0
}

3.3.余额变动记录

URL: ./transferWalletLog

Type: POST

Content-Type: application/json

Description: 余额变动记录

Request-headers:

Header	Type	Description	Required	Since
Authorization	string	APP ID	true	-
X-Timestamp	string	发送时间	true	-
X-Signature	string	防伪签名	true	-

Header

Type

Description

Required

Since

Authorization

string

APP ID

true

X-Timestamp

string

发送时间

true

X-Signature

string

防伪签名

true

Body-parameters:

Parameter	Type	Description	Required	Since
openId	string	开放用户ID	false	-
tradeId	int32	交易记录ID，唯一，该参数存在时忽略其他参数	false	-
memo	string	备注，可以存外部系统订单号，或者其他用于检索的数据提供备注查询，该参数存在时，忽略其他时间参数只会返回与该参数相等的记录	false	-
startAt	int64	开始时间，UTC时间戳，包含（左开右闭区间）	false	-
endAt	int64	截至时间，UTC时间戳，不包含（左开右闭区间）	false	-

Parameter

Type

Description

Required

Since

openId

string

开放用户ID

false

tradeId

int32

交易记录ID，唯一，该参数存在时忽略其他参数

false

memo

string

备注，可以存外部系统订单号，或者其他用于检索的数据提供备注查询，该参数存在时，忽略其他时间参数只会返回与该参数相等的记录

false

startAt

int64

开始时间，UTC时间戳，包含（左开右闭区间）

false

endAt

int64

截至时间，UTC时间戳，不包含（左开右闭区间）

false

Request-example:

curl -X POST -H "Content-Type: application/json" -H "Authorization" -H "X-Timestamp" -H "X-Signature" -i './transferWalletLog' --data '{
  "openId": "",
  "tradeId": 0,
  "memo": "",
  "startAt": 0,
  "endAt": 0
}'

Response-fields:

Field	Type	Description	Since
id	int32	记录ID	-
openId	string	用户ID	-
type	enum	日志类型 [Enum: bringIn-("bringIn","入座，个人钱包带入到牌桌，扣钱负数"),bringOut-("bringOut","离座，牌桌金额返还到个人钱包，加钱正数"),clubWithDraw-("clubWithDraw","私人俱乐部资产转出到个人钱包，加钱正数"),charge-("charge","上分，或者外部系统充值到个人钱包，加钱正数"),withdraw-("withdraw","下分，或者转出到外部系统，扣钱负数"),squidBringOut-("squidBringOut","离座，牌桌剩余鱿鱼金额返还到个人钱包，加钱正数"),squidBringIn-("squidBringIn","入座，鱿鱼游戏质押，个人钱包带入到牌桌，扣钱负数"),delay-("delay","道具消费，使用延迟下注"),viewFold-("viewFold","道具消费，游戏结束后查看他人的弃牌"),rabbit-("rabbit","道具消费，游戏结束后查看未发完的公牌"),squidBack-("squidBack","鱿鱼游戏对局异常退还鱿鱼")]	-
change	number	变更金额	-
after	number	变更后的金额	-
memo	string	备注	-
extend	string	拓展字段，附加数据	-
createAt	string	创建时间	-

Field

Type

Description

Since

int32

记录ID

openId

string

用户ID

type

enum

日志类型
[Enum: bringIn-("bringIn","入座，个人钱包带入到牌桌，扣钱负数"),bringOut-("bringOut","离座，牌桌金额返还到个人钱包，加钱正数"),clubWithDraw-("clubWithDraw","私人俱乐部资产转出到个人钱包，加钱正数"),charge-("charge","上分，或者外部系统充值到个人钱包，加钱正数"),withdraw-("withdraw","下分，或者转出到外部系统，扣钱负数"),squidBringOut-("squidBringOut","离座，牌桌剩余鱿鱼金额返还到个人钱包，加钱正数"),squidBringIn-("squidBringIn","入座，鱿鱼游戏质押，个人钱包带入到牌桌，扣钱负数"),delay-("delay","道具消费，使用延迟下注"),viewFold-("viewFold","道具消费，游戏结束后查看他人的弃牌"),rabbit-("rabbit","道具消费，游戏结束后查看未发完的公牌"),squidBack-("squidBack","鱿鱼游戏对局异常退还鱿鱼")]

change

number

变更金额

after

number

变更后的金额

memo

string

备注

extend

string

拓展字段，附加数据

createAt

string

创建时间

Response-example:

[
  {
    "id": 0,
    "openId": "",
    "type": "bringIn",
    "change": 0,
    "after": 0,
    "memo": "",
    "extend": "",
    "createAt": "yyyy-MM-dd HH:mm:ss"
  }
]

3.4.查看用户是否在游戏中，以及预估待回收余额

URL: ./fastWithDrawAll

Type: POST

Content-Type: application/json

Description: 快速回收用户所有的牌桌钱包，不一定成功

Request-headers:

Header	Type	Description	Required	Since
Authorization	string	APP ID	true	-
X-Timestamp	string	发送时间	true	-
X-Signature	string	防伪签名	true	-

Header

Type

Description

Required

Since

Authorization

string

APP ID

true

X-Timestamp

string

发送时间

true

X-Signature

string

防伪签名

true

Body-parameters:

Parameter	Type	Description	Required	Since
openId	string	用户开放ID	false	-

Parameter

Type

Description

Required

Since

openId

string

用户开放ID

false

Request-example:

curl -X POST -H "Content-Type: application/json" -H "Authorization" -H "X-Timestamp" -H "X-Signature" -i './fastWithDrawAll' --data '{
  "openId": ""
}'

Response-fields:

Field	Type	Description	Since
gaming	boolean	是否在游戏中	-
balance	number	转账钱包余额	-
tableBalance	number	牌桌余额	-

Field

Type

Description

Since

gaming

boolean

是否在游戏中

balance

number

转账钱包余额

tableBalance

number

牌桌余额

Response-example:

{
  "gaming": true,
  "balance": 0,
  "tableBalance": 0
}

4.单一钱包模式回调接口

4.1.查询用户信息

URL: ./userinfo

Type: POST

Content-Type: application/json

Description: 查询用户信息

Request-headers:

Header	Type	Description	Required	Since
Authorization	string	APP ID	true	-
X-Timestamp	string	发送时间	true	-
X-Signature	string	防伪签名	true	-

Header

Type

Description

Required

Since

Authorization

string

APP ID

true

X-Timestamp

string

发送时间

true

X-Signature

string

防伪签名

true

Body-parameters:

Parameter	Type	Description	Required	Since
openId	string	用户ID	true	-

Parameter

Type

Description

Required

Since

openId

string

用户ID

true

Request-example:

curl -X POST -H "Content-Type: application/json" -H "Authorization" -H "X-Timestamp" -H "X-Signature" -i './userinfo'

Response-fields:

Field	Type	Description	Since
openId	string	用户 ID	-
name	string	昵称	-
balance	number	余额	-

Field

Type

Description

Since

openId

string

用户 ID

name

string

昵称

balance

number

余额

Response-example:

{
  "openId": "",
  "name": "",
  "balance": 0
}

4.2.变更余额

URL: ./changeBalance

Type: POST

Content-Type: application/json

Description: 变更余额

Request-headers:

Header	Type	Description	Required	Since
Authorization	string	APP ID	true	-
X-Timestamp	string	发送时间	true	-
X-Signature	string	防伪签名	true	-

Header

Type

Description

Required

Since

Authorization

string

APP ID

true

X-Timestamp

string

发送时间

true

X-Signature

string

防伪签名

true

Body-parameters:

Parameter	Type	Description	Required	Since
openId	string	开放ID	true	-
amount	number	变更额度，有正负	true	-
type	enum	变更类型，参考数据字典 [Enum: bringIn-("bringIn","带入"),bringOut-("bringOut","带出"),clubWithDraw-("clubWithDraw","俱乐部提现"),squidBringOut-("squidBringOut","鱿鱼带出"),squidBringIn-("squidBringIn","鱿鱼带入"),squidBack-("squidBack","鱿鱼退还"),delay-("delay","下注加时"),viewFold-("viewFold","局后弃牌查看"),rabbit-("rabbit","局后公牌查看")]	true	-
orderId	int64	订单ID，全局唯一	true	-
symbol	string	货币符号	true	-

Parameter

Type

Description

Required

Since

openId

string

开放ID

true

amount

number

变更额度，有正负

true

type

enum

变更类型，参考数据字典
[Enum: bringIn-("bringIn","带入"),bringOut-("bringOut","带出"),clubWithDraw-("clubWithDraw","俱乐部提现"),squidBringOut-("squidBringOut","鱿鱼带出"),squidBringIn-("squidBringIn","鱿鱼带入"),squidBack-("squidBack","鱿鱼退还"),delay-("delay","下注加时"),viewFold-("viewFold","局后弃牌查看"),rabbit-("rabbit","局后公牌查看")]

true

orderId

int64

订单ID，全局唯一

true

symbol

string

货币符号

true

Request-example:

curl -X POST -H "Content-Type: application/json" -H "Authorization" -H "X-Timestamp" -H "X-Signature" -i './changeBalance' --data '{
  "openId": "",
  "amount": 0,
  "type": "bringIn",
  "orderId": 0,
  "symbol": ""
}'

Response-fields:

Field	Type	Description	Since
success	boolean	是否成功	-
balance	number	无论成功与否，更新余额	-

Field

Type

Description

Since

success

boolean

是否成功

balance

number

无论成功与否，更新余额

Response-example:

{
  "success": true,
  "balance": 0
}

4.3.撤销订单

URL: ./cancel

Type: POST

Content-Type: application/json

Description: 撤销订单

Request-headers:

Header	Type	Description	Required	Since
Authorization	string	APP ID	true	-
X-Timestamp	string	发送时间	true	-
X-Signature	string	防伪签名	true	-

Header

Type

Description

Required

Since

Authorization

string

APP ID

true

X-Timestamp

string

发送时间

true

X-Signature

string

防伪签名

true

Body-parameters:

Parameter	Type	Description	Required	Since
ids	string	订单ID集	false	-

Parameter

Type

Description

Required

Since

ids

string

订单ID集

false

Request-example:

curl -X POST -H "Content-Type: application/json" -H "Authorization" -H "X-Timestamp" -H "X-Signature" -i './cancel'

Response-example:

Return void.

4.4.订单状态确认

URL: ./check

Type: POST

Content-Type: application/json

Description: 数据一致性以我方为准，确认我方与贵司订单状态是否一致

如果返回了与我方不一致的数据，我方处理如下：

如果我方正常，则重新发起 /changeBalance
如果我方已取消，则重新发起 /cancel

Request-headers:

Header	Type	Description	Required	Since
Authorization	string	APP ID	true	-
X-Timestamp	string	发送时间	true	-
X-Signature	string	防伪签名	true	-

Header

Type

Description

Required

Since

Authorization

string

APP ID

true

X-Timestamp

string

发送时间

true

X-Signature

string

防伪签名

true

Body-parameters:

Parameter	Type	Description	Required	Since
orderId	int64	订单ID	true	-
canceled	boolean	交易状态： true 交易已取消 false 交易正常	true	-

Parameter

Type

Description

Required

Since

orderId

int64

订单ID

true

canceled

boolean

交易状态：

true 交易已取消

false 交易正常

true

Request-example:

curl -X POST -H "Content-Type: application/json" -H "Authorization" -H "X-Timestamp" -H "X-Signature" -i './check' --data '[
  {
    "orderId": 0,
    "canceled": true
  }
]'

Response-example:

[
  0,
  0
]

5.游戏数据查询接口

5.1.对局数据批量查询

URL: ./roundInfos

Type: POST

Content-Type: application/json

Description: 对局数据批量查询

Request-headers:

Header	Type	Description	Required	Since
Authorization	string	APP ID	true	-
X-Timestamp	string	发送时间	true	-
X-Signature	string	防伪签名	true	-

Header

Type

Description

Required

Since

Authorization

string

APP ID

true

X-Timestamp

string

发送时间

true

X-Signature

string

防伪签名

true

Body-parameters:

Parameter	Type	Description	Required	Since
page	int32	页码，从 1 开始	false	-
startAt	int64	对局时间开始，UTC 时间戳，包含（左开右闭区间）	true	-
endAt	int64	对局时间截至，UTC 时间戳，不包含（左开右闭区间）	true	-

Parameter

Type

Description

Required

Since

page

int32

页码，从 1 开始

false

startAt

int64

对局时间开始，UTC 时间戳，包含（左开右闭区间）

true

endAt

int64

对局时间截至，UTC 时间戳，不包含（左开右闭区间）

true

Request-example:

curl -X POST -H "Content-Type: application/json" -H "Authorization" -H "X-Timestamp" -H "X-Signature" -i './roundInfos' --data '{
  "page": 1,
  "startAt": 0,
  "endAt": 0
}'

Response-fields:

Field	Type	Description	Since
list	array	数据	-
└─table	object	牌桌信息	-
└─id	int32	牌桌ID	-
└─shortFlag	boolean	是否是短牌模式	-
└─aofConfig	object	如果是AOF推推乐模式，推推乐游戏配置	-
└─forceBringIn	boolean	筹码不足时，强制带入	-
└─forceBringOut	boolean	筹码多余时，强制带出	-
└─name	string	牌桌名称	-
└─ante	number	前注	-
└─small	number	小盲	-
└─big	number	大盲	-
└─straddle	boolean	是否是抢抓模式	-
└─insuranceFlag	boolean	是否开启保险	-
└─squidConfig	object	如果牌桌是鱿鱼游戏牌桌，鱿鱼的配置	-
└─chips	number	鱿鱼价值（大盲倍数）	-
└─minUser	int32	鱿鱼游戏触发，最少玩家数量	-
└─maxUser	int32	鱿鱼游戏最多支持多少个玩家	-
└─noActionGiftSquid	boolean	无动作是否发放鱿鱼	-
└─firstSquidAutoShowHands	boolean	第一次赢得鱿鱼后是否自动秀牌	-
└─chargeConfig	object	服务费配置	-
└─serviceFeeMode	enum	收费模式 [Enum: NONE("无") , RATE_CHARGE("百分比抽取") , FIXED_CHARGE("固定值") ]	-
└─serviceFeeFrom	enum	手续费来源 [Enum: POT("全底池") , PROFIT("水上抽") ]	-
└─calcRate	int32	抽水比例，10 （10%）	-
└─preFlopFreeFlag	boolean	翻牌圈结束是否免费	-
└─threePeopleOffFlag	boolean	手续费，玩家低于3人5折	-
└─potBelowFreeFlag	boolean	底池低于此值是否免费，功能是否启用	-
└─potBelowFree	int32	底池低于此值免费，大盲倍数	-
└─serviceFeeCap	int32	服务费封顶，大盲倍数，负数无封顶	-
└─round	object	对局	-
└─id	int32	对局ID	-
└─tableId	int32	牌桌ID	-
└─boards	array	公牌	-
└─rabbitCards	array	游戏结束后，使用猎兔道具查看未发完的公牌	-
└─rabbitUserIds	array	游戏结束后，使用猎兔看牌的用户ID	-
└─flagCompareHands	boolean	是否进入了最终的比牌模式	-
└─process	array	对局过程	-
└─stage	enum	阶段 [Enum: PRE_FLOP, FLOP, TURN, RIVER, SETTLE]	-
└─details	array	阶段明细	-
└─userId	int32	用户ID	-
└─event	enum	事件 [Enum: none, small, big, check, call, raise, straddle, fold, all_in, ins, ins_hit, refund, show]	-
└─chips	number	筹码量	-
└─boards	array	该阶段的公牌记录	-
└─delayBetUserIds	array	使用延迟下注的玩家ID集	-
└─pots	array	底池备份数据	-
└─id	int32	底池ID	-
└─chips	int32	筹码量，（10筹码 = 1货币单位）	-
└─joinCompareHandsUserIds	array	该底池比牌玩家 ID集	-
└─turnCanBuyInsUsers	array	转牌圈，能够购买保险的玩家ID集	-
└─riverCanBuyInsUsers	array	和牌圈，能够购买保险的玩家ID集	-
└─winners	array	最终底池赢家 ID集	-
└─avgBet	int32	平均下注筹码（ 10筹码 = 1真实货币）	-
└─turnOuts	object	转牌保险 outs 信息	-
└─mapKey	object	保险信息	-
└─win	array	赢 outs	-
└─tie	array	平 outs	-
└─ins	array	反超 outs	-
└─minBuy	int32	最小购买金额，筹码（10筹码 = 1真实货币）	-
└─maxBuy	int32	最大购买金额，筹码（10筹码 = 1真实货币）	-
└─buy	int32	实际购买金额，筹码（10筹码 = 1真实货币）	-
└─hitPay	int32	保险命中赔付金额，筹码（10筹码 = 1真实货币）	-
└─odds	int32	保险赔率 300（30倍赔付）	-
└─timeout	int64	操作凭证，utc时间戳	-
└─back	boolean	是否是保险背回，及强制购买	-
└─riverOuts	object	河牌保险 outs 信息	-
└─mapKey	object	保险信息	-
└─win	array	赢 outs	-
└─tie	array	平 outs	-
└─ins	array	反超 outs	-
└─minBuy	int32	最小购买金额，筹码（10筹码 = 1真实货币）	-
└─maxBuy	int32	最大购买金额，筹码（10筹码 = 1真实货币）	-
└─buy	int32	实际购买金额，筹码（10筹码 = 1真实货币）	-
└─hitPay	int32	保险命中赔付金额，筹码（10筹码 = 1真实货币）	-
└─odds	int32	保险赔率 300（30倍赔付）	-
└─timeout	int64	操作凭证，utc时间戳	-
└─back	boolean	是否是保险背回，及强制购买	-
└─startAt	string	开始时间	-
└─endAt	string	结束时间	-
└─roundDetails	array	对局明细	-
└─id	int32	对局明细ID	-
└─tableId	int32	牌桌ID	-
└─roundId	int32	对局ID	-
└─userId	int32	用户ID	-
└─name	string	用户昵称	-
└─viewFoldUserIds	array	对局结束后被其他玩家使用了，偷偷看的玩家列表	-
└─hands	array	手牌	-
└─showCards	array	是否秀牌	-
└─role	enum	对局中的角色 [Enum: SB, BB, UTG, UTG1, UTG2, LJ, HJ, CO, BTN]	-
└─betTotal	number	累计下注	-
└─win	number	赢	-
└─commission	number	抽水金额	-
└─commissionDetail	array	抽水计算过程	-
└─way	enum	扣减方式 [Enum: before_stage_free, user_less_percent_discount, pot_less_free, arrive_max_commission_fee_fixed_discount]	-
└─before	int32	扣减前 before	-
└─discount	int32	扣减筹码值	-
└─after	int32	扣减之后	-
└─turnInsBuy	number	转牌圈保险购买金额	-
└─turnInsHit	number	转牌圈保险赔付金额	-
└─riverInsBuy	number	和牌圈保险购买金额	-
└─riverInsHit	number	和牌圈保险赔付金额	-
└─flagActive	boolean	是否弃牌	-
└─flagFinalCompare	boolean	是否参与最终比牌	-
└─flagBet	boolean	是否入池	-
└─squidResult	enum	是否赢得鱿鱼游戏 [Enum: none, win, lose, avg, runaway]	-
page	int32	页码	-
size	int32	页数据量	-
total	int32	总记录条数	-
totalPage	int32	总页数	-

Field

Type

Description

Since

list

array

数据

└─table

object

牌桌信息

└─id

int32

牌桌ID

└─shortFlag

boolean

是否是短牌模式

└─aofConfig

object

如果是AOF推推乐模式，推推乐游戏配置

└─forceBringIn

boolean

筹码不足时，强制带入

└─forceBringOut

boolean

筹码多余时，强制带出

└─name

string

牌桌名称

└─ante

number

前注

└─small

number

小盲

└─big

number

大盲

└─straddle

boolean

是否是抢抓模式

└─insuranceFlag

boolean

是否开启保险

└─squidConfig

object

如果牌桌是鱿鱼游戏牌桌，鱿鱼的配置

└─chips

number

鱿鱼价值（大盲倍数）

└─minUser

int32

鱿鱼游戏触发，最少玩家数量

└─maxUser

int32

鱿鱼游戏最多支持多少个玩家

└─noActionGiftSquid

boolean

无动作是否发放鱿鱼

└─firstSquidAutoShowHands

boolean

第一次赢得鱿鱼后是否自动秀牌

└─chargeConfig

object

服务费配置

└─serviceFeeMode

enum

收费模式
[Enum: NONE("无")
, RATE_CHARGE("百分比抽取")
, FIXED_CHARGE("固定值")
]

└─serviceFeeFrom

enum

手续费来源
[Enum: POT("全底池")
, PROFIT("水上抽")
]

└─calcRate

int32

抽水比例，10 （10%）

└─preFlopFreeFlag

boolean

翻牌圈结束是否免费

└─threePeopleOffFlag

boolean

手续费，玩家低于3人5折

└─potBelowFreeFlag

boolean

底池低于此值是否免费，功能是否启用

└─potBelowFree

int32

底池低于此值免费，大盲倍数

└─serviceFeeCap

int32

服务费封顶，大盲倍数，负数无封顶

└─round

object

对局

└─id

int32

对局ID

└─tableId

int32

牌桌ID

└─boards

array

公牌

└─rabbitCards

array

游戏结束后，使用猎兔道具查看未发完的公牌

└─rabbitUserIds

array

游戏结束后，使用猎兔看牌的用户ID

└─flagCompareHands

boolean

是否进入了最终的比牌模式

└─process

array

对局过程

└─stage

enum

阶段
[Enum: PRE_FLOP, FLOP, TURN, RIVER, SETTLE]

└─details

array

阶段明细

└─userId

int32

用户ID

└─event

enum

事件
[Enum: none, small, big, check, call, raise, straddle, fold, all_in, ins, ins_hit, refund, show]

└─chips

number

筹码量

└─boards

array

该阶段的公牌记录

└─delayBetUserIds

array

使用延迟下注的玩家ID集

└─pots

array

底池备份数据

└─id

int32

底池ID

└─chips

int32

筹码量，（10筹码 = 1货币单位）

└─joinCompareHandsUserIds

array

该底池比牌玩家 ID集

└─turnCanBuyInsUsers

array

转牌圈，能够购买保险的玩家ID集

└─riverCanBuyInsUsers

array

和牌圈，能够购买保险的玩家ID集

└─winners

array

最终底池赢家 ID集

└─avgBet

int32

平均下注筹码（ 10筹码 = 1真实货币）

└─turnOuts

object

转牌保险 outs 信息

└─mapKey

object

保险信息

└─win

array

赢 outs

└─tie

array

平 outs

└─ins

array

反超 outs

└─minBuy

int32

最小购买金额，筹码（10筹码 = 1真实货币）

└─maxBuy

int32

最大购买金额，筹码（10筹码 = 1真实货币）

└─buy

int32

实际购买金额，筹码（10筹码 = 1真实货币）

└─hitPay

int32

保险命中赔付金额，筹码（10筹码 = 1真实货币）

└─odds

int32

保险赔率 300（30倍赔付）

└─timeout

int64

操作凭证，utc时间戳

└─back

boolean

是否是保险背回，及强制购买

└─riverOuts

object

河牌保险 outs 信息

└─mapKey

object

保险信息

└─win

array

赢 outs

└─tie

array

平 outs

└─ins

array

反超 outs

└─minBuy

int32

最小购买金额，筹码（10筹码 = 1真实货币）

└─maxBuy

int32

最大购买金额，筹码（10筹码 = 1真实货币）

└─buy

int32

实际购买金额，筹码（10筹码 = 1真实货币）

└─hitPay

int32

保险命中赔付金额，筹码（10筹码 = 1真实货币）

└─odds

int32

保险赔率 300（30倍赔付）

└─timeout

int64

操作凭证，utc时间戳

└─back

boolean

是否是保险背回，及强制购买

└─startAt

string

开始时间

└─endAt

string

结束时间

└─roundDetails

array

对局明细

└─id

int32

对局明细ID

└─tableId

int32

牌桌ID

└─roundId

int32

对局ID

└─userId

int32

用户ID

└─name

string

用户昵称

└─viewFoldUserIds

array

对局结束后被其他玩家使用了，偷偷看的玩家列表

└─hands

array

手牌

└─showCards

array

是否秀牌

└─role

enum

对局中的角色
[Enum: SB, BB, UTG, UTG1, UTG2, LJ, HJ, CO, BTN]

└─betTotal

number

累计下注

└─win

number

赢

└─commission

number

抽水金额

└─commissionDetail

array

抽水计算过程

└─way

enum

扣减方式
[Enum: before_stage_free, user_less_percent_discount, pot_less_free, arrive_max_commission_fee_fixed_discount]

└─before

int32

扣减前 before

└─discount

int32

扣减筹码值

└─after

int32

扣减之后

└─turnInsBuy

number

转牌圈保险购买金额

└─turnInsHit

number

转牌圈保险赔付金额

└─riverInsBuy

number

和牌圈保险购买金额

└─riverInsHit

number

和牌圈保险赔付金额

└─flagActive

boolean

是否弃牌

└─flagFinalCompare

boolean

是否参与最终比牌

└─flagBet

boolean

是否入池

└─squidResult

enum

是否赢得鱿鱼游戏
[Enum: none, win, lose, avg, runaway]

page

int32

页码

size

int32

页数据量

total

int32

总记录条数

totalPage

int32

总页数

Response-example:

{"list":[{"table":{"id":0,"shortFlag":true,"aofConfig":{"forceBringIn":true,"forceBringOut":true},"name":"","ante":0,"small":0,"big":0,"straddle":true,"insuranceFlag":true,"squidConfig":{"chips":0,"minUser":0,"maxUser":0,"noActionGiftSquid":true,"firstSquidAutoShowHands":true},"chargeConfig":{"serviceFeeMode":"NONE","serviceFeeFrom":"POT","calcRate":0,"preFlopFreeFlag":true,"threePeopleOffFlag":true,"potBelowFreeFlag":true,"potBelowFree":0,"serviceFeeCap":0}},"round":{"id":0,"tableId":0,"boards":[""],"rabbitCards":[""],"rabbitUserIds":[0],"flagCompareHands":true,"process":[{"stage":"PRE_FLOP","details":[{"userId":0,"event":"none","chips":0}],"boards":[""],"delayBetUserIds":[0]}],"pots":[{"id":0,"chips":0,"joinCompareHandsUserIds":[0],"turnCanBuyInsUsers":[0],"riverCanBuyInsUsers":[0],"winners":[0],"avgBet":0,"turnOuts":{"mapKey":{"win":[""],"tie":[""],"ins":[""],"minBuy":0,"maxBuy":0,"buy":0,"hitPay":0,"odds":0,"timeout":0,"back":true}}"riverOuts":{"mapKey":{"win":[""],"tie":[""],"ins":[""],"minBuy":0,"maxBuy":0,"buy":0,"hitPay":0,"odds":0,"timeout":0,"back":true}}}],"startAt":"yyyy-MM-dd HH:mm:ss","endAt":"yyyy-MM-dd HH:mm:ss"},"roundDetails":[{"id":0,"tableId":0,"roundId":0,"userId":0,"name":"","viewFoldUserIds":[0],"hands":[""],"showCards":[""],"role":"SB","betTotal":0,"win":0,"commission":0,"commissionDetail":[{"way":"before_stage_free","before":0,"discount":0,"after":0}],"turnInsBuy":0,"turnInsHit":0,"riverInsBuy":0,"riverInsHit":0,"flagActive":true,"flagFinalCompare":true,"flagBet":true,"squidResult":"none"}]}],"page":0,"size":0,"total":0,"totalPage":0}

5.2.用户牌局钱包记录

URL: ./userTableWalletLog

Type: POST

Content-Type: application/json

Description: 用户牌局钱包记录

Request-headers:

Header	Type	Description	Required	Since
Authorization	string	APP ID	true	-
X-Timestamp	string	发送时间	true	-
X-Signature	string	防伪签名	true	-

Header

Type

Description

Required

Since

Authorization

string

APP ID

true

X-Timestamp

string

发送时间

true

X-Signature

string

防伪签名

true

Body-parameters:

Parameter	Type	Description	Required	Since
tableId	int32	No comments found.	false	-
openId	string	No comments found.	false	-

Parameter

Type

Description

Required

Since

tableId

int32

No comments found.

false

openId

string

No comments found.

false

Request-example:

curl -X POST -H "Content-Type: application/json" -H "Authorization" -H "X-Timestamp" -H "X-Signature" -i './userTableWalletLog' --data '{
  "tableId": 0,
  "openId": ""
}'

Response-fields:

Field	Type	Description	Since
normal	array	普通钱包日志	-
└─id	int32	No comments found.	-
└─change	number	数量	-
└─after	number	变化后余额	-
└─type	enum	类型 [Enum: gameBringIn("带入") , gamingBringIn("游戏中带入") , gamingBringOut("游戏中带出") , gameBringOut("带出") , balanceSettle("结算") , firstBring("鱿鱼首次带入") , squidBack("鱿鱼退还") , win("鱿鱼赢") , bringOut("带出") , lose("鱿鱼输") , avg("平分鱿鱼") , run("鱿鱼逃跑") , autoBring("自动带入") ]	-
└─roundId	int32	轮次id	-
└─memo	string	备注	-
└─createAt	string	创建时间	-
squid	array	鱿鱼钱包日志	-
└─id	int32	No comments found.	-
└─change	number	数量	-
└─after	number	变化后余额	-
└─type	enum	类型 [Enum: gameBringIn("带入") , gamingBringIn("游戏中带入") , gamingBringOut("游戏中带出") , gameBringOut("带出") , balanceSettle("结算") , firstBring("鱿鱼首次带入") , squidBack("鱿鱼退还") , win("鱿鱼赢") , bringOut("带出") , lose("鱿鱼输") , avg("平分鱿鱼") , run("鱿鱼逃跑") , autoBring("自动带入") ]	-
└─roundId	int32	轮次id	-
└─memo	string	备注	-
└─createAt	string	创建时间	-

Field

Type

Description

Since

normal

array

普通钱包日志

└─id

int32

No comments found.

└─change

number

数量

└─after

number

变化后余额

└─type

enum

类型
[Enum: gameBringIn("带入")
, gamingBringIn("游戏中带入")
, gamingBringOut("游戏中带出")
, gameBringOut("带出")
, balanceSettle("结算")
, firstBring("鱿鱼首次带入")
, squidBack("鱿鱼退还")
, win("鱿鱼赢")
, bringOut("带出")
, lose("鱿鱼输")
, avg("平分鱿鱼")
, run("鱿鱼逃跑")
, autoBring("自动带入")
]

└─roundId

int32

轮次id

└─memo

string

备注

└─createAt

string

创建时间

squid

array

鱿鱼钱包日志

└─id

int32

No comments found.

└─change

number

数量

└─after

number

变化后余额

└─type

enum

└─roundId

int32

轮次id

└─memo

string

备注

└─createAt

string

创建时间

Response-example:

{
  "normal": [
    {
      "id": 0,
      "change": 0,
      "after": 0,
      "type": "gameBringIn",
      "roundId": 0,
      "memo": "",
      "createAt": "yyyy-MM-dd HH:mm:ss"
    }
  ],
  "squid": [
    {
      "id": 0,
      "change": 0,
      "after": 0,
      "type": "gameBringIn",
      "roundId": 0,
      "memo": "",
      "createAt": "yyyy-MM-dd HH:mm:ss"
    }
  ]
}

6.数据字典

6.1.错误码

Name	Code	Type	Description
requestCheck_appIdInvalid	1000	int32	无效APPID
requestCheck_appIdNotEnable	1001	int32	未启用APPID
requestCheck_timeInvalid	1002	int32	无效请求时间
requestCheck_signatureInvalid	1003	int32	无效签名
transferWallet_notSupportTransferWallet	1004	int32	不支持转账到钱包
user_userNotFound	1005	int32	用户不存在
limit_request	429	int32	请求限流
round_roundNotFound	1006	int32	对局不存在
loginError_userNotFound	1007	int32	用户不存在
registerError_userExist	1008	int32	账号已被注册
requestCheck_openIdInvalid	1009	int32	无效openId

Name

Code

Type

Description

requestCheck_appIdInvalid

1000

int32

无效APPID

requestCheck_appIdNotEnable

1001

int32

未启用APPID

requestCheck_timeInvalid

1002

int32

无效请求时间

requestCheck_signatureInvalid

1003

int32

无效签名

transferWallet_notSupportTransferWallet

1004

int32

不支持转账到钱包

user_userNotFound

1005

int32

用户不存在

limit_request

429

int32

请求限流

round_roundNotFound

1006

int32

对局不存在

loginError_userNotFound

1007

int32

用户不存在

registerError_userExist

1008

int32

账号已被注册

requestCheck_openIdInvalid

1009

int32

无效openId

6.2.订单类型

Name	Code	Type	Description
bringIn	bringIn	string	带入
bringOut	bringOut	string	带出
clubWithDraw	clubWithDraw	string	俱乐部提现
squidBringOut	squidBringOut	string	鱿鱼带出
squidBringIn	squidBringIn	string	鱿鱼带入
squidBack	squidBack	string	鱿鱼退还
delay	delay	string	下注加时
viewFold	viewFold	string	局后弃牌查看
rabbit	rabbit	string	局后公牌查看

Name

Code

Type

Description

bringIn

string

带入

bringOut

string

带出

clubWithDraw

string

俱乐部提现

squidBringOut

string

鱿鱼带出

squidBringIn

string

鱿鱼带入

squidBack

string

鱿鱼退还

delay

string

下注加时

viewFold

string

局后弃牌查看

rabbit

string

局后公牌查看

6.3.转账钱包余额变动记录类型

Name	Code	Type	Description
bringIn	bringIn	string	入座，个人钱包带入到牌桌，扣钱负数
bringOut	bringOut	string	离座，牌桌金额返还到个人钱包，加钱正数
clubWithDraw	clubWithDraw	string	私人俱乐部资产转出到个人钱包，加钱正数
charge	charge	string	上分，或者外部系统充值到个人钱包，加钱正数
withdraw	withdraw	string	下分，或者转出到外部系统，扣钱负数
squidBringOut	squidBringOut	string	离座，牌桌剩余鱿鱼金额返还到个人钱包，加钱正数
squidBringIn	squidBringIn	string	入座，鱿鱼游戏质押，个人钱包带入到牌桌，扣钱负数
delay	delay	string	道具消费，使用延迟下注
viewFold	viewFold	string	道具消费，游戏结束后查看他人的弃牌
rabbit	rabbit	string	道具消费，游戏结束后查看未发完的公牌
squidBack	squidBack	string	鱿鱼游戏对局异常退还鱿鱼

Name

Code

Type

Description

bringIn

string

入座，个人钱包带入到牌桌，扣钱负数

bringOut

string

离座，牌桌金额返还到个人钱包，加钱正数

clubWithDraw

string

私人俱乐部资产转出到个人钱包，加钱正数

charge

string

上分，或者外部系统充值到个人钱包，加钱正数

withdraw

string

下分，或者转出到外部系统，扣钱负数

squidBringOut

string

离座，牌桌剩余鱿鱼金额返还到个人钱包，加钱正数

squidBringIn

string

入座，鱿鱼游戏质押，个人钱包带入到牌桌，扣钱负数

delay

string

道具消费，使用延迟下注

viewFold

string

道具消费，游戏结束后查看他人的弃牌

rabbit

string

道具消费，游戏结束后查看未发完的公牌

squidBack

string

鱿鱼游戏对局异常退还鱿鱼

Top