> ## Documentation Index
> Fetch the complete documentation index at: https://doc.va777.net/llms.txt
> Use this file to discover all available pages before exploring further.

# 取得活動獎項資訊

> 取得活動獎項資訊 API 的請求參數、回應格式與回應訊息碼。

> [!NOTE]
>
> * 查詢活動獎項資訊。
> * 此服務所需之活動代碼請向我方服務人員取得。

## 請求路徑

```text theme={null}
GET {host}/api/v2.0/info/activityRank
```

## Headers

<table>
  <colgroup>
    <col width="27%" />

    <col width="10%" />

    <col width="7%" />

    <col width="56%" />
  </colgroup>

  <thead><tr><th>欄位</th><th>型別</th><th>必填</th><th>說明</th></tr></thead>

  <tbody>
    <tr><td>`Authorization`</td><td>string</td><td>是</td><td>驗證令牌，由我方提供</td></tr>
  </tbody>
</table>

## 請求參數

<table>
  <colgroup>
    <col width="27%" />

    <col width="10%" />

    <col width="7%" />

    <col width="11%" />

    <col width="45%" />
  </colgroup>

  <thead><tr><th>欄位</th><th>型別</th><th>必填</th><th>參與簽章</th><th>說明</th></tr></thead>

  <tbody>
    <tr><td>`channelID`</td><td>number</td><td>是</td><td>✓</td><td>渠道編號 (若無渠道，請帶入1)</td></tr>
    <tr><td>`activityIV`</td><td>string</td><td>是</td><td>✓</td><td>活動代碼</td></tr>
    <tr><td>`sign`</td><td>string</td><td>是</td><td /><td>簽章，產生方式請參考[簽章規則](https://doc.va777.net/zh-Hant/v1/guides/signature.md)</td></tr>
  </tbody>
</table>

## 回應

成功（HTTP 狀態碼固定為 200，請以 `status.code` 判斷結果）

<table>
  <colgroup>
    <col width="34%" />

    <col width="12%" />

    <col width="54%" />
  </colgroup>

  <thead><tr><th>欄位</th><th>型別</th><th>說明</th></tr></thead>

  <tbody>
    <tr><td>`data`</td><td>object</td><td /></tr>
    <tr><td>`data.rankList`</td><td>object\[]</td><td>活動獎項列表</td></tr>
    <tr><td>`data.rankList[].activityName`</td><td>string</td><td>活動名稱</td></tr>
    <tr><td>`data.rankList[].activityIV`</td><td>string</td><td>活動代碼</td></tr>
    <tr><td>`data.rankList[].rank`</td><td>number</td><td>活動排名</td></tr>
    <tr><td>`data.rankList[].channelId`</td><td>number</td><td>渠道編號</td></tr>
    <tr><td>`data.rankList[].account`</td><td>string</td><td>會員帳號</td></tr>
    <tr><td>`data.rankList[].currency`</td><td>string</td><td>幣別 (請洽詢我方商務)</td></tr>
    <tr><td>`data.rankList[].prize`</td><td>number</td><td>活動獎金</td></tr>
    <tr><td>`data.rankList[].prizePayout`</td><td>number</td><td>已派發活動獎金</td></tr>
    <tr><td>`data.rankList[].isPrizePayout`</td><td>boolean</td><td>是否已派發活動獎金 (true:已派發、false:未派發)</td></tr>
    <tr><td>`data.rankList[].wagersId`</td><td>number</td><td>活動賽果群組編號</td></tr>
    <tr><td>`data.rankList[].transactionId`</td><td>string</td><td>派發活動獎金交易唯一碼</td></tr>
    <tr><td>`data.rankList[].prizePayoutTime`</td><td>string</td><td>派發活動獎金時間 (時區、格式請參考[API注意事項](https://doc.va777.net/zh-Hant/v1/guides/request-format.md#時間格式))</td></tr>
    <tr><td>`status`</td><td>object</td><td>回應狀態，請參考[回應格式](https://doc.va777.net/zh-Hant/v1/guides/request-format.md#回應格式)</td></tr>
  </tbody>
</table>

### 回應範例

```json theme={null}
{
  "data": {
    "rankList": [
      {
        "activityName": "龍虎榜第一期",
        "activityIV": "53f4103b",
        "rank": 1,
        "channelId": 1,
        "account": "player001",
        "currency": "CNY",
        "prize": 888,
        "prizePayout": 888,
        "isPrizePayout": true,
        "wagersId": 1052,
        "prizePayoutTime": "2022-06-30T22:54:29.649+08:00",
        "transactionId": "E8F0A4F5FE9C41D3AE55D33B85F20D85"
      }
    ]
  },
  "status": {
    "code": "0",
    "message": "success",
    "datetime": "2022-07-01T10:13:54.920+08:00",
    "traceCode": "7cf25e1957cc47fe8e01f1a7c6d504d6"
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.