帖子列出帖子
返回 Sofia

帖子

列出帖子

按从新到旧列出令牌可访问门店的帖子，可按门店、状态、日期范围和作者筛选，分页返回，并用游标取得下一页，每页最多 100 条。

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

授权

  • Authorizationstring必填

    你的个人密钥或 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）。

响应

200application/json

一页帖子；还有更多时包含 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= 传入以获取下一页；到末尾时不再出现

400

invalid_cursor，或参数格式错误时的 invalid_request。

401

令牌缺失、未知、已过期或已被撤销。

403

令牌没有 posts:read scope。

404

establishment_not_found：令牌无法访问该门店。

4XXapplication/json

其他任何错误，以错误结构返回。