帳號與工作空間

列出收件匣通知

讀取使用者的應用程式內收件匣，最新優先（最多 50 筆），可選擇僅未讀或某一種類型。

POST /identity-api/user/inbox/list

契約檢閱日期： 2026-10-21 · sha256:563d2d581da0ad29

閱讀 Markdown 下載公開契約下載 OpenAPI

概覽

讀取使用者的應用程式內收件匣，最新優先（最多 50 筆），可選擇僅未讀或某一種類型。

成功 HTTP 回應可能表示請求已接受，並非已完成。背景工作請儲存回傳 ID，持續檢查同一操作直到完成。已排程或已接受的貼文，只有平台確認後才算已發布；用戶端逾時無法證明結果。

驗證與權限

接受的憑證類別: user_session, delegated_oauth, personal_access_token
委派能力: agent:operate
最低工作空間角色: 此契約沒有最低工作空間角色要求；擁有權與授權檢查仍然適用。
存取範圍: 此使用者有權存取的資源
需要所有工作空間同意: 否
變更狀態: 否
操作完成時: synchronous_http_response

權杖只能使用其擁有者持有的權利。每次請求會檢查工作空間成員資格、資源擁有權、所選工作空間及已授予能力。core 與 full 設定檔只變更顯示的工具，不會授予存取權。

請求欄位

「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。

請求欄位
欄位 / 分支	類型 / 必填	約束
`$`	`object`在父物件中必填	`additionalProperties: false`
`kind`	`string`選填／項目	`minLength: 1` `maxLength: 64`
`unread_only`	`boolean`選填／項目	—
`limit`	`integer`選填／項目	`minimum: 1` `maximum: 50`

完整 JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "unread_only": {
      "type": "boolean"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    }
  },
  "additionalProperties": false
}

回應與完成

成功 HTTP 狀態：200。操作完成時： synchronous_http_response.

「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。

回應與完成
欄位 / 分支	類型 / 必填	約束
`$`	`object`在父物件中必填	—
`notifications`	`array`在父物件中必填	—
`notifications[]`	`object`選填／項目	—
`notifications[].id`	`string`在父物件中必填	`format: "uuid"` `pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}\|00000000-0000-0000-0000-000000000000\|ffffffff-ffff-ffff-ffff-ffffffffffff)$"`
`notifications[].workspace_id`	`string`在父物件中必填	`format: "uuid"` `pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}\|00000000-0000-0000-0000-000000000000\|ffffffff-ffff-ffff-ffff-ffffffffffff)$"`
`notifications[].kind`	`string`在父物件中必填	—
`notifications[].title`	`string`在父物件中必填	—
`notifications[].body`	`string \| null`在父物件中必填	—
`notifications[].body`anyOf 1	`string`在父物件中必填	—
`notifications[].body`anyOf 2	`null`在父物件中必填	—
`notifications[].link_url`	`string \| null`在父物件中必填	—
`notifications[].link_url`anyOf 1	`string`在父物件中必填	—
`notifications[].link_url`anyOf 2	`null`在父物件中必填	—
`notifications[].payload`	`object`在父物件中必填	`default: {}` `additionalProperties: {}`
`notifications[].payload.*`	`any JSON value`選填／項目	—
`notifications[].read_at`	`string \| null`在父物件中必填	—
`notifications[].read_at`anyOf 1	`string`在父物件中必填	—
`notifications[].read_at`anyOf 2	`null`在父物件中必填	—
`notifications[].created_at`	`string`在父物件中必填	—

完整 JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "notifications": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
          },
          "workspace_id": {
            "type": "string",
            "format": "uuid",
            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
          },
          "kind": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "body": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "link_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "payload": {
            "default": {},
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {}
          },
          "read_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "created_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "workspace_id",
          "kind",
          "title",
          "body",
          "link_url",
          "payload",
          "read_at",
          "created_at"
        ]
      }
    }
  },
  "required": [
    "notifications"
  ]
}

錯誤與安全重試

檢查 HTTP 狀態和回應內容。400 驗證錯誤可能包含 ZodError；處理常式錯誤使用 error、message 和 code 欄位。保留 request_id 或 x-request-id 以便診斷，但不要保留憑證。先解決 401/403 存取錯誤再重試，並在收到 429 時遵循 Retry-After。如寫入結果不確定或回傳 5xx，先讀取現有結果。僅在支援時重複使用冪等鍵；重試行為因操作而異，並不保證恰好傳送一次。

故障排查指南

範例

這些範例使用已依結構描述檢查的虛構值。請將 ID 替換為您有權使用的 ID、將媒體替換為已就緒素材，並將日期替換為已確認的發布時間。提交寫入前，請檢查帳號資格。本頁不會傳送 API 請求。

在伺服器上將 SOSOAPI_ACCESS_TOKEN 設為此操作接受的憑證，且不要放入瀏覽器程式碼。代理程式請使用 sosoapi auth login 透過瀏覽器登入，並由 CLI 更新憑證。

request.json

{}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/user/inbox/list" \
  -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

JavaScript

// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/user/inbox/list", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.

CLI

npx sosoapi api post /identity-api/user/inbox/list < request.json

合成回應範例

{
  "notifications": []
}

MCP： sosoapi_list_inbox_notifications

全部 API 操作驗證與權限