媒體列出媒體
返回 Sofia

媒體

列出媒體

由新到舊分頁列出門市的媒體庫，附目前時間視窗內有效的簽章 URL。在測試模式和正式模式下都可以使用，用於挑選已有素材。

GEThttps://api.sofia-post.com/api/v1/media
GET/v1/media
curl -X GET 'https://api.sofia-post.com/api/v1/media' \
  -H "Authorization: Bearer $SOFIA_API_KEY"

授權

  • Authorizationstring必填

    你的個人金鑰或 OAuth 存取權杖，以 Bearer <token> 傳送。

查詢參數

  • establishmentIdstring必填

    要讀取其媒體庫的門市。

  • cursorstring

    上一頁回傳的 nextCursor。

  • limitnumber

    每頁數量，1 到 100（預設 20）。

回應

200application/json

一頁媒體；還有更多時包含 nextCursor。

  • dataobject[]必填

    本頁的媒體

    顯示子屬性
    • idstring必填

      媒體的識別碼，傳給貼文的 media[].id

    • typestring必填

      媒體類型

      允許的值： imagevideo

    • urlstring必填

      帶簽章的位址，在目前時間視窗內有效

    • fileNamestring必填

      檔名

    • contentTypestring必填

      檔案的 MIME 類型

    • sizenumber必填

      大小，單位為位元組

    • createdAtstring<date-time>必填

      媒體的新增時間

    • thumbnailUrlstring

      帶簽章的縮圖（影片為封面，圖片為方圖）

  • nextCursorstring

    作為 ?cursor= 傳入以取得下一頁；到末尾時不再出現

400

invalid_cursor，或 invalid_request。

404

establishment_not_found：權杖無法存取該門市。

4XXapplication/json

其他任何錯誤，以錯誤結構回傳。