# 通用API
**最近更新： 2026-04-02**
## API基本信息
* 請API都需加入Headers參數`signature`,簽名方式如下,所有API通用。
* 請求格式為 `application/x-www-form-urlencoded` 格式
* 回傳格式為 `JSON` 格式
* 所有時間和時間戳相關欄位均以**毫秒為預設單位**。
* 簽名格式:\
hex(sha256(appSecret + requestTime))\
Golang範例:
```
requestTimeStr := strconv.Itoa(requestTime)
hash := sha256.Sum256([]byte(appSecret + requestTimeStr))
signature := hex.EncodeToString(hash[:])
```
### 請求標頭(Request Header):
| 參數 | 類型 | 是否必填 | 描述 |
| --------- | ------ | ---- | ------------------------------------------------------- |
| signature | string | YES | 营运商呼叫平台時必填，驗證請求簽名, hex(sha256(appSecret + requestTime)) |
## 登入遊戲
```
POST /player/launch
```
**参数:**
| 名称 | 类型 | 是否必须 | 描述 |
| ----------- | ------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| operatorID | string | YES | 营运商ID |
| requestTime | int64 | YES | 請求時間限制15分鐘內 (millisecond) |
| playerID | string | YES | 玩家ID |
| clientIP | string | YES | 玩家IP |
| tableID | string | NO | 加入tableid参数，可指定进入该游戏桌。 桌号可参考通用API`/game/gamelist`。帶入`MULTI` 進入多桌模式。帶入`MULTIXD` 進入色碟多桌模式。 |
| token | string | YES | `單一錢包`運營商提供的玩家令牌,轉帳錢包可不用帶入此參數 |
| isDemo | boolean | NO | 設定為"true"時,提供试玩连结,试玩额度为2000。该连结的效其为15分钟。 |
| platform | string | NO | 使用裝置
● Unknown-未知
● Desktop-PC
● Mobile-手机
|
| lang | string | NO | 加入lang参数,可指定游戏内的预设语系，可参考语系参数说明。 |
| redirectUrl | string | NO | ● empty 不作任何跳转
● postback window\.parent.postMessage("close")
● histback window\.history.back()
● url (必須以http或https开头）window\.location.href=url 备注:以下三项仅支援 ,真人,区块链 ,其他类型的游戏不试用
● home 桌机版返回键设定返回至游戏大厅,同時隱藏"退出遊戲"按鈕
|
| uictl | string | NO | 隱藏錢包餘額“balance\_hide” , 默認靜音“audio\_mute” ,五局沒下注不踢出桌台"ingame\_retain" ,大於一個元件時,使用逗號連接。 |
**响应:**
```json
{
"url": "https://uat-game-client.ora.com?lang=&timezone=UTC-4&token=ugs.cBx.08chr" //兩小時內未進入.則該連結失效
}
```
### 觸發js關閉項目
```json
gameClientWindow.postMessage({ type: "uictl", data: { action: 'menu_close' }, "*"); //關閉菜單
gameClientWindow.postMessage({ type: "uictl", data: { action: 'audio_mute' }, "*"); //關閉聲音
gameClientWindow.postMessage({ type: "uictl", data: { action: 'audio_unmute' }, "*"); //開啟聲音
```
### 通知父視窗
```json
window.parent.postMessage("game_audio_mute", "*"); //遊戲靜音
window.parent.postMessage("game_audio_unmute", "*"); //取消遊戲聲音
window.parent.postMessage("stream_audio_mute", "*"); //視訊靜音
window.parent.postMessage("stream_audio_unmute", "*"); //取消視訊靜音
```
## 取得桌號列表
提供桌號清單以及其維護狀態。
```
POST /game/gamelist
```
**請求參數:**
| 參數 | 類型 | 是否必填 | 描述 |
| ----------- | ------ | ---- | ------------------------ |
| operatorID | string | Y | 註冊的營運商 ID |
| requestTime | int64 | Y | 請求時間限制15分鐘內（millisecond） |
**響應資料格式:** `JSON`
```json
{
"data": [{
"gameID": "STUDIO-BAC-PKG030", // string 游戏ID
"isMaintain": false, // bool 游戏维护状态
"gameType": "BAC", // string 游戏类别
"gameTheme": "flagship", // string 遊戲主題
"topics": "live_preferred", // string 推薦 live_preferre優選 live_flagship 旗艦廳 live_high_odds 高賠廳 live_show 真人秀
"cn": "经典百家乐 30", // string 简体中文
"en": "Classic 30", // string 英文
"zh": "經典百家樂 30", // string 繁體中文
"id": "Klasik 30", // string 印尼文
"th": "คลาสสิก 30", // string 泰文
"vi": "Cổ điển 30", // string 越南文
"ko": "클래식 30", // string 韩文
"ja": "クラシック 30", // string 日文
"pt": "Clássico 30", // string 葡萄牙文
"tl": "Classic 30", // string 菲律宾文
"my": "Classic 30", // string 缅甸文
"in": "Classic 30", // string 印度文
"es": "Classic 30", // string 西班牙文
"tr": "Klasik 30", // string 土耳其文
"ru": "Classic 30", // string 俄語
"fr": "Classic 30", // string 法文
"dealerImage": "https://cap.xcck0688.xyz/weph/table058_acam_720.jpg" // string 即時荷官圖片
}]
}
```
## 遊戲即時資料
所有的遊戲的即時資料, 此接口需要聯絡客服特別開通
```
POST /game/realtime
```
**請求參數:**
| 參數 | 類型 | 是否必填 | 描述 |
| ----------- | ------ | ---- | ------------------------ |
| operatorID | string | Y | 註冊的營運商 ID |
| requestTime | int64 | Y | 請求時間限制15分鐘內（millisecond） |
**響應資料格式:** `JSON`
```json
{
"streamDomains": ["pull-os.pkg888.com", "pull-os.pkgming.tv"], //串流網址
"shuffleRoomPath": "/ph/w2h_000_sd.flv", //洗牌房串流路徑
"data": [
{
"serverTs": 1234444444112, // 系統時間 (millisecond)
"gameID": "STUDIO-BAA-1", // 遊戲編號
"gameCode": "STUDIO-BAA-1", // 遊戲編號, same as gameID
"gameType": "BA", // 遊戲類型
"gameState": "active", // 遊戲狀態
"gameGenre": "LIVE", // 遊戲系列 (LIVE)
"gameTheme": "flagship", // string 遊戲主題
"gameDescr": { // object 遊戲名稱
"zh": "百家樂1",
"en": "Baccarat 1",
"cn": "百家樂1"
},
"dealerImage": "https://faed2.wrf.qw/table001_dealer.jpg",
"dealerCode": "dealer0001",
"dealerName": "Mandy Ford",
"streamPathHd": "/ph/p6g_037_hd.flv", // 高清畫質串流路徑
"streamPathSd": "/ph/p6g_037_sd.flv", // 流暢畫質串流路徑
"playerCnt": 1234, // 本桌人數 (int32)
"roundId": "BAC013r1233q324e1123", // 本局流水號
"roundStartTs": 1234567890123, // 本局開始時間 (millisecond)
"roundStopTs": 1234567890123, // 本局結束時間 (millisecond)
"roundResultTs": 1234567890123, // 本局結果時間 (millisecond)
"roundShoe": 123456918466, // 本局靴號 (int64)
"roundNum": 3327645156300393, // 本局局號 (int64)
"roundSec": 45, // 本局倒數秒數 (int32)
"roundFlag": 0, // 本局標示（例如頭局，尾局）(int32)
"roundState": "start", // 本局狀態 (start, stop, result,shuffle, card, newshoe)
"roundWin": "1,0,0,0", 可參考[遊戲牌局結果]
// 本局遊戲卡牌結果
"roundCard": "12,23,12,33,2a,4c", // 本局遊戲卡牌結果
"roundLucky": "", // 此參數已包含在roundMeta內
"roundMeta": { // 本局遊戲其它資訊
"addOdds": "bpAddOdds:0,ppAddOdds:4,tieAddOdds:1,bAddOdds:0.1,pAddOdds:0.2",
// 百家樂浮動賠率,範例分別為莊對,閒對,和,莊,閒 公式為原始賠率+加權賠率=浮動賠率
"roundLucky": "38:3,41:2,18:2,34:2,35:3"
// 財神/幸運系列 的賠率 範例為 (梅花♣️3)3倍, (方塊♦️1)2倍,(黑桃♠️8)2倍,(梅花♣️4)2倍,(梅花♣️5)3倍,
// 超級骰寶 "SPECIFIC_1_2:20,SPECIFIC_6_3:88" 代表指定骰子1雙骰20倍,指定骰子6三骰88倍
},
"accumCards": ["12,23,12,33,2a,4c", "12,23,12,33,2a,4c", "12,23,12,33,2a,4c"], //本靴遊戲卡牌結果
"roadmap": {
"rt0": "0,0,2,0;1,0,2,0;2,0,2,0",
"rt1": "0,0,2,0;1,0,2,0;2,0,2,0",
"grt": ""
},
"goodRoad": "LONGB", //好路
"jpEnabled": true, // jp info
"jpCurrency": "CNY",
"jpGrandAmt": 123456789.11,
"jpMajorAmt": 2345677.12,
"jpMinorAmt": 314567.33,
"jpMiniAmt": 15167.33, // 包桌功能是否開啟(BAP only)
"reserveEnabled": true, // 包桌狀態(free=無桌主, own=有桌主, 但可以進, private=有桌主, 已包桌)
"reserveState": "private",
"reserveSeatBalLimit": 100000.00, // 包桌入座最低餘額
"reserveExclBalLimit": 500000.00, // 包桌獨佔最低餘額
}
]
}
```
## 取得細單連結
取得注單詳細資訊頁面的連結,該連結的效其為5分鐘，紀錄保留一個月 細單連結加上lang參數可以設定顯示語言，目前支援英文(en)、繁體中文(zh)、簡體中文(cn)
```
POST /report/betrecord
```
**請求參數:**
| 參數 | 類型 | 是否必填 | 描述 |
| ----------- | ------ | ---- | --------------------------- |
| operatorID | string | Y | 註冊的營運商 ID |
| betID | string | Y | 注單 ID |
| requestTime | int64 | Y | 請求時間限制15分鐘內（millisecond） |
| lang | string | N | 英文 (en)、繁體中文 (zh)、簡體中文 (cn) |
**響應資料格式:** `JSON`
```json
{
"url": "https://uat-op-api.dvweg.com/report/betrecord?ecret=JDJhJ4454545g5QmG" //string 细单URL
}
```
## 投注紀錄
可取得最多500000筆資料，1分鐘內可調用150次，結束與開始時間間隔不得大於一個月， 金額以分為單位，以投注時間搜尋開始時間與結束時間內的數據，預設資料筆數為50筆。
```
POST /report/bet
```
**請求參數:**
| 參數 | 類型 | 是否必填 | 描述 |
| ---------------- | ------ | ---- | ------------------------------------------------------------------------------------------------ |
| operatorID | string | Y | 註冊的營運商 ID |
| startTime | int64 | Y | 搜尋開始時間（millisecond），與結束時間間隔不得大於一個月 |
| endTime | int64 | Y | 搜尋結束時間（millisecond），與開始時間間隔不得大於一個月 |
| playerID | string | N | 玩家 ID（最大長度：20 字元） |
| betID | string | N | 注單 ID |
| betStatus | string | N | 注單狀態（new：未結算，complete：已結算，cancel：取消，error：錯誤） |
| limit | int | N | 資料限制筆數（預設：50，最大：500000） |
| offset | int | N | 過掉筆數（可用於分頁） |
| isSettlementTime | bool | N | 設定為 "true" 時，開始與結束時間不得大於一個小時 可查詢 "取消時間" 或 "重新結算時間" 或 "結算時間" 其一符合查詢之時間區間，預設為 "false" 以 Bowie 時間查詢 |
| requestTime | int64 | Y | 請求時間限制15分鐘內（millisecond） |
**響應資料格式:** `JSON`
```json
{
"dataCount": 50, // int64 资料笔数
"limit" : 50 // int 资料限制笔数
"data": [{
"betID": "BT6OV8IHE4OK8HBBQT80", // string 注单ID
"operatorID": "xf", // string 注册的营运商ID
"playerID": "mike", // string 玩家ID
"opPlayerID": "BPH0RNMR44SMP26OK6G0", // string 营运商玩家ID
"betDateTime": 1598918562000, // int64 时间(millisecond)
"settlementTime": 159891875000, // int64 结算时间(millisecond)
"betStatus": "complete",//string 注单状态
"odds": "1", // string 赔率
"betCode": "BANKER", // string 投注内容
"validBetAmount": 8000, // int64 有效投注额
"gameResult": "Banker (B9 P5)", // string 游戏结果
"device": "web", // string 投注设备
"betAmount": 10000, // int64 下注金额
"dpsAmount": 10000, // int64 押金,或財神費
"winlossAmount": -10000, // int64 赢输金额
"category": "Live", // string 游戏組別
"gameType": "RO", // string 游戏类别
"gameRoundID": "BT6P69IHE4OK8HBBRDT0", // string 游戏回合ID
"tableID": "STUDIO-BAB-1", // string 游戏桌ID
"ip": "192.168.0.1" // string IP位址
"trackID": "" // string 主机ID
"cardresult": { // object 卡牌結果**只有**卡牌遊戲才會有結果
"A1": "club_2",
"A2": "heart_9",
"A3": "diamond_9",
"B1": "diamond_8",
"B2": "heart_3",
"B3": "spade_10"
},
"roundCard": "32,29,49,48,23,1a", // 遊戲牌局卡牌
"roundLucky": "38:3,41:2,18:2,34:2,35:3",
// 財神/幸運系列 的賠率 範例為 (梅花♣️3)3倍, (方塊♦️1)2倍,(黑桃♠️8)2倍,(梅花♣️4)2倍,(梅花♣️5)3倍,
"roundWin": "2,0,0,0", // 遊戲牌局結果
"addOdds": "bpAddOdds:0,ppAddOdds:4,tieAddOdds:1,bAddOdds:0.1,pAddOdds:0.2",
// 百家樂浮動賠率,範例分別為莊對,閒對,和,莊,閒 公式為原始賠率+加權賠率=浮動賠率
"resettleTime" : 1716220196000, // int64 重新结算时间 (millisecond)
"cancelTime" : 1715220196000, // int64 取消时间 (millisecond)
"tipAmount" : 0, // int64 小费金额
"type" : "bet", // string 交易类型
}],
}
```
## 取得玩家投注紀錄摘要
以投注時間搜尋開始時間與結束時間內,每一位玩家的ID、下注與輸贏的數據總和統計， 1分鐘內可調用150次，結束與開始時間間隔不得大於一個月， 金額以分為單位，以投注時間搜尋開始時間與結束時間內的數據，預設資料筆數為50筆。
```
POST /report/playersummary
```
**請求參數:**
| 參數 | 類型 | 是否必填 | 描述 |
| ---------------- | ------ | ---- | --------------------------------------------------- |
| operatorID | string | Y | 註冊的營運商 ID |
| startTime | int64 | Y | 搜尋開始時間（millisecond），與結束時間間隔不得大於一個月 |
| endTime | int64 | Y | 搜尋結束時間（millisecond），與開始時間間隔不得大於一個月 |
| playerID | string | N | 可輸入單一或多個玩家 ID，需以逗號隔開（例如：player1,player2），空白時為查詢所有玩家 |
| isSettlementTime | bool | N | 設定為 "true" 時，開始與結束時間以結算時間搜尋，預設以 Bowie 時間搜尋 |
| requestTime | int64 | Y | 請求時間限制15分鐘內（millisecond） |
**響應資料格式:** `JSON`
```json
{
"data": [{
"operatorID": "xf", // string 注册的营运商ID
"playerID": "mike", // string 玩家ID
"currency": "RMB", // string 货币
"betamount": 760000, // int64 下注金额
"validBetAmount": 200000, // int64 有效投注额
"winAmount": 160000, // int64 淨输赢 ( 单位:分 )
"numberOfBet": 70, // int64 总注单数量
}]
}
```
## 投注記錄統計
投注記錄統計，限制1分鐘內可呼叫150次，
以投注時間搜尋開始時間與結束時間內的數據統計
```
POST /report/summary
```
**請求參數:**
| 參數 | 類型 | 是否必填 | 描述 |
| ---------------- | ------ | ---- | ------------------------------------- |
| operatorID | string | Y | 註冊的營運商 ID |
| startTime | int64 | Y | 搜尋開始時間（millisecond），與結束時間間隔不得大於一個月 |
| endTime | int64 | Y | 搜尋結束時間（millisecond），與開始時間間隔不得大於一個月 |
| requestTime | int64 | Y | 請求時間限制15分鐘內（millisecond） |
| isSettlementTime | bool | N | 設定為 "true" 時，開始與結束時間以結算時間搜尋，預設以投注時間搜尋 |
**響應資料格式:** `JSON`
```json
{
"currencyBetAmount": 240000, // int64 总下注额 ( 单位:分 )
"currencyValidBetAmount": 100000, // int64 有效投注额 ( 单位:分 )
"currencyWinAmount": 160000, // int64 淨输赢 ( 单位:分 )
"totalBetAmount": 120000, // int64 USDT总下注额 (单位:分 )
"totalWinAmount": 80000, // int64 USDT净输赢 ( 单位:分 )
"totalValidBetAmount": 50000, // int64 USDT有效投注额 ( 单位:分 )
"numberOfBet": 70, // int64 总注单数量
}
```
## 登出玩家
```
POST /player/logout
```
**請求參數:**
| 參數 | 類型 | 是否必填 | 描述 |
| ----------- | ------ | ---- | --------------------------------------------------- |
| operatorID | string | Y | 註冊的營運商 ID |
| playerID | string | N | 可輸入單一或多個玩家 ID，需以逗號隔開（例如：player1,player2），空白時為查詢所有玩家 |
| requestTime | int64 | Y | 請求時間限制15分鐘內（millisecond） |
**響應資料格式:** `JSON`
```json
{
"error": null, // string 错误信息
}
```
## 測試連接
```
POST /check
```
此API不須加入參數以及signature
**響應資料格式:** `JSON`
```json
{
"success": true, // bool 是否正常
}
```
## 取得額度紀錄
```
POST /history/reconcile
```
**請求參數:**
| 參數 | 類型 | 是否必填 | 描述 |
| ----------- | ------ | ---- | --------------------------------------------------------------------------------------------------------------------- |
| operatorID | string | Y | 註冊的營運商 ID |
| startTime | int64 | Y | 搜尋開始時間（millisecond），與結束時間間隔不得大於一個月 |
| endTime | int64 | Y | 搜尋結束時間（millisecond），與開始時間間隔不得大於一個月 |
| playerID | string | N | 玩家 ID（最大長度：20 字元） |
| betId | string | N | 注單 ID |
| tranId | string | N | 交易 ID |
| tranType | string | N | 交易類型（可依逗點增加）：transfer\_in:轉入、transfer\_out:轉出、bet\_result:下注結果、bet:下注、recharge:轉帳、live\_tip:荷官打賞、activity\_prize:活动派彩 |
| cursor | string | N | 分頁碼（首次請求不需填寫） |
| limit | int | N | 資料限制筆數（預設：2000，最大：500000） |
| requestTime | int64 | Y | 請求時間限制15分鐘內（millisecond） |
**響應資料格式:** `JSON`
```json
{
"cursor": "17f697c4f6137b60_6ecd7509-e81e-4916-a909-4473f6a34a4c_02986a7db0c8c900be012612a98c1e29", // string 分页码
"data": [{
playerID: "guest9847" // string 玩家ID
balAfter: 2230 // int64 交易后金额
balBefore: 2430 // int64 交易前金额
balChange: -200 // int64 变化金额
tranId: "ec48613a-fdb7-4b63-938f-431a83090a13" // string 交易ID
betId: "345bf26b-1aae-452b-a189-6377e86bdb21" // string betId
tranTime: 159891875000 // int64 交易时间 (millisecond)
gameGenre: "LIVE" // string 游戏组别
gameType: "BAS" // string 游戏类别
gameCode: "STUDIO-BAS-109" // string 游戏ID
roundCode: "ABSPH1240913F02R1357" // string 游戏局ID
tranState: "normal" // string 交易状态
tranType: "bet" // string 交易类型
}]
}
```
## 遊戲維護通知
***此API是平台呼叫營運商***
每當有遊戲桌開關/維護等狀態時會觸發此API，此功能需要設定callback，並且手動開通
```
POST {營運商API_URL}/updategamestatus
```
**請求:** `application/x-www-form-urlencoded`
**請求標頭:** NONE
**請求參數:**
| 參數 | 類型 | 是否必填 | 描述 |
| ---------- | ------ | ---- | ------ |
| category | string | Y | 遊戲組別 |
| gameType | string | N | 遊戲類型 |
| gameID | string | N | 遊戲 ID |
| isMaintain | bool | Y | 遊戲維護狀態 |
**響應資料格式:** `JSON`
```json
{
"operatorID": "test12345" //string 注册的营运商ID
}
```
## 取得遊戲结果
```
POST /game/gameresults
```
**請求參數:**
| 參數 | 類型 | 是否必填 | 描述 |
| ----------- | ------ | ---- | ---------------------------------- |
| operatorID | string | Y | 註冊的營運商 ID |
| requestTime | int64 | Y | 請求時間限制15分鐘內（millisecond） |
| startTime | int64 | Y | 搜尋開始時間（millisecond），與結束時間間隔不得大於一個月 |
| endTime | int64 | Y | 搜尋結束時間（millisecond），與開始時間間隔不得大於一個月 |
| gameType | string | Y | 游戏类型 |
| tableID | string | N | 桌号ID |
**響應資料格式:** `JSON`
```json
[
{
"gameType":"BAC", // string 游戏类别
"tableId": "STUDIO-BAC-117", // string 游戏桌ID
"resultList": [{
"roundCode": "BT6P69IHE4OK8HBBRDT0", // string 游戏回合ID
"startTime": 159891875000, // int64 时间(millisecond)
"settlementTime": 169891875000, // int64 结算时间millisecond)
"gameResult": "Banker", // string 游戏结果
"cardrResult": { //结果说明
"A1": "club_2",
"A2": "heart_9",
"A3": "diamond_9",
"B1": "diamond_8",
"B2": "heart_3",
"B3": "spade_10"
},
"roundCard": "32,29,49,48,23,1a", // 遊戲牌局卡牌
"roundWin": "2,0,0,0", // 遊戲牌局結果
}]
}
]
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.pkg333.app/common-api_cn.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.