Source: https://ailoot.ai/docs/zh-hant-tw/cabinet/redeem/
Canonical: https://ailoot.ai/docs/zh-hant-tw/cabinet/redeem/
Language: zh-hant-tw

[控制台 API](https://ailoot.ai/docs/zh-hant-tw/) 

# 儲值碼

[Markdown](https://ailoot.ai/docs/zh-hant-tw/cabinet/redeem/index.md)

方法、請求欄位與回應。

本區共有 2 個方法。開啟方法即可查看存取條件、請求欄位與回應。

| 方法與路徑 | 說明 | 存取條件 |
| --- | --- | --- |
| `POST /api/v1/redeem` | 兌換代碼 | 控制台 token |
| `GET /api/v1/redeem/history` | 兌換紀錄 | 控制台 token |

**POST /api/v1/redeem** —兌換代碼

存取條件：控制台 token

POST`/api/v1/redeem`

## JSON／表單欄位

| 欄位 | 類型 | 必填 | 驗證／說明 |
| --- | --- | --- | --- |
| `code` | `string` | 是 | required |

請求主體範本

```json
{
  "code": "PLACEHOLDER_CODE (string)"
}
```

PLACEHOLDER 表示您的輸入及其型別。請替換值，並只保留需要的選填欄位；不要將字串標記當成數字、boolean、物件或陣列傳送。

請求結構描述：`RedeemRequest`

## 回應

JSON 回應包含 code、message與data。data 的內容請見下方結構描述。

回應資料的結構描述：`RedeemCode`。欄位與型別請見「資料結構描述」頁面。

回應結構描述，欄位值僅為示例

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "code": "PLACEHOLDER_CODE (string)",
    "type": "PLACEHOLDER_TYPE (string)",
    "value": "PLACEHOLDER_VALUE (number)",
    "status": "PLACEHOLDER_STATUS (string)",
    "used_by": "PLACEHOLDER_USED_BY (integer)",
    "used_at": "PLACEHOLDER_USED_AT (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "expires_at": "PLACEHOLDER_EXPIRES_AT (string)",
    "validity_days": "PLACEHOLDER_VALIDITY_DAYS (integer)",
    "notes": "PLACEHOLDER_NOTES (string)",
    "user": "PLACEHOLDER_USER (object)"
  }
}
```

注意事項：所有個人資料與物件，皆限於 JWT 主體的範圍。

注意事項：此操作會變更狀態，或繼續一次性授權流程；範例僅說明介面契約，不會執行。

此方法會變更資料。只有在方法標示 Idempotency-Key 時，重新傳送才是安全的。若回應遺失，請先確認操作結果 (例如金鑰清單)，再決定是否重新傳送請求。

**GET /api/v1/redeem/history** —兌換紀錄

存取條件：控制台 token

GET`/api/v1/redeem/history`

讀取；ID 取自您先前的回應

```bash
curl --fail-with-body "https://ailoot.ai/api/v1/redeem/history" \
  -H "Authorization: Bearer $TOKEN"
```

## 查詢參數

| 欄位 | 類型 | 必填 | 驗證／說明 |
| --- | --- | --- | --- |
| `page` | `integer` | 否 | ; 預設值：1；正整數 |
| `page_size` | `integer` | 否 | ; 預設值：20；正數；最大限制為 100 |

不需要請求主體。請在 URL 中傳入上述參數。

## 回應

JSON 回應包含 code、message與data。data 的內容請見下方結構描述。

回應資料的結構描述：`RedeemCode`。欄位與型別請見「資料結構描述」頁面。

回應結構描述，欄位值僅為示例

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "items": [
      {
        "id": "PLACEHOLDER_ID (integer)",
        "code": "PLACEHOLDER_CODE (string)",
        "type": "PLACEHOLDER_TYPE (string)",
        "value": "PLACEHOLDER_VALUE (number)",
        "status": "PLACEHOLDER_STATUS (string)",
        "used_by": "PLACEHOLDER_USED_BY (integer)",
        "used_at": "PLACEHOLDER_USED_AT (string)",
        "created_at": "PLACEHOLDER_CREATED_AT (string)",
        "expires_at": "PLACEHOLDER_EXPIRES_AT (string)",
        "validity_days": "PLACEHOLDER_VALIDITY_DAYS (integer)",
        "notes": "PLACEHOLDER_NOTES (string)",
        "user": "PLACEHOLDER_USER (object)"
      }
    ],
    "total": "PLACEHOLDER_TOTAL (integer)",
    "page": "PLACEHOLDER_PAGE (integer)",
    "page_size": "PLACEHOLDER_PAGE_SIZE (integer)",
    "pages": "PLACEHOLDER_PAGES (integer)"
  }
}
```

注意事項：所有個人資料與物件，皆限於 JWT 主體的範圍。

還有疑問嗎？請提供 Request ID與問題描述，我們會協助釐清。[聯絡支援](mailto:support@ailoot.ai)

## Ailoot · 公司及其專案組合





Ailoot以累積的營運經驗、廣大的客戶群、穩定的服務及持續的KPI管理為基礎。





公司及其專案組合：數百萬客戶，每月銷售額達數十億。





Ailoot將這些營運經驗用於API存取，讓客戶的產品、代理、應用程式及自動化流程使用AI功能。