貼文列出貼文

貼文

列出貼文

由新到舊列出權杖可存取門市的貼文,可按門市、狀態、日期範圍和作者篩選,分頁回傳,並用游標取得下一頁,每頁最多 100 筆。

GEThttps://api.sofia-post.com/api/v1/posts
GEThttps://api.sofia-post.com/api/v1/posts

列出貼文

由新到舊列出權杖可存取門市的貼文,可按門市、狀態、日期範圍和作者篩選,分頁回傳,並用游標取得下一頁,每頁最多 100 筆。

授權

Authorizationstring必填

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

僅保存在此分頁中,且僅傳送到 api.sofia-post.com。 取得 API 金鑰

查詢參數

establishmentIdstring

僅限此門市的貼文。

cursorstring

上一頁回傳的 nextCursor。

statusstring

正式模式:至少有一個網路處於該狀態。貼文的 status 是各網路的彙總,因此按 failed 篩選可能回傳 partial。

fromstring<date-time>

正式模式:至少有一個網路從此時起已發布(發布前則為已排程)。

tostring<date-time>

正式模式:並且早於此時(不含)。

createdBystring

正式模式:me 為權杖所代表使用者的貼文,app 為此應用建立的貼文。省略則為全部。

limitnumber

每頁數量,1 到 100(預設 20)。

GET /v1/posts 會列出權杖可存取的所有貼文,最新的在前,可按 establishmentId、status、from、to 和 createdBy(me 或 app)篩選。當一條貼文至少有一個平台處於該狀態時,它就匹配 status。參見分頁。

貼文可能的狀態見讀取貼文頁面。

授權

  • Authorizationstringheader必填

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

查詢參數

  • establishmentIdstring

    僅限此門市的貼文。

  • cursorstring

    上一頁回傳的 nextCursor。

  • statusstring

    正式模式:至少有一個網路處於該狀態。貼文的 status 是各網路的彙總,因此按 failed 篩選可能回傳 partial。

    允許的值: draftscheduledpublishingpublishedsent_to_inboxfailed

  • fromstring<date-time>

    正式模式:至少有一個網路從此時起已發布(發布前則為已排程)。

  • tostring<date-time>

    正式模式:並且早於此時(不含)。

  • createdBystring

    正式模式:me 為權杖所代表使用者的貼文,app 為此應用建立的貼文。省略則為全部。

    允許的值: meapp

  • limitnumber

    每頁數量,1 到 100(預設 20)。

回應

一頁貼文;還有更多時包含 nextCursor。

  • dataobject[]必填

    本頁的貼文

    顯示子屬性
    • idstring必填

      貼文的識別碼

    • statusstring必填

      跨所有網路的狀態;partial:在一個網路發布成功,在另一個失敗

      允許的值: draftscheduledpublishingpublishedsent_to_inboxfailedpartial

    • establishmentIdstring必填

      貼文所屬的門市

    • createdAtstring<date-time>必填

      貼文的建立時間

    • targetsobject[]必填

      每個網路和帳號一條:同一網路上的兩個帳號對應兩條

      顯示子屬性
      • platformstring必填

        目標所在的網路

      • accountIdstring必填

        負責發布的帳號(GET /v1/establishments/:id/accounts)

      • statestring必填

        目標在其網路上的狀態

        允許的值: draftscheduledpublishingpublishedsent_to_inboxfailed

      • publishedAtstring<date-time>

        目標發布的時間

      • permalinkstring

        指向網路上已發布貼文的連結

      • errorstring

        網路拒絕的原因

    • scheduledAtstring<date-time>

      貼文預計發布的時間

  • nextCursorstring

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

這個頁面對你有幫助嗎?