貼文
發布貼文
正式應用可立即發布、定時發布或存為草稿,測試應用只做模擬。加上 ?dry_run=true 則只檢查、不寫入。
授權
Authorizationstring必填你的個人金鑰或 OAuth 存取權杖,以
Bearer <token>傳送。
查詢參數
dry_runstringtrue:執行傳送時會做的全部檢查(網路規則、帳號、媒體、建立、正式訂閱),不寫入任何內容。回傳 200ready或 422post_refused。允許的值:
truefalse
標頭
Idempotency-Keystring用相同請求本文重放時回傳相同回應,不會再建立一條貼文。試執行不會消耗該金鑰。
請求本文
application/json
establishmentIdstring必填門市,須在權杖授權的 Workspace 內(
GET /v1/establishments)targetsobject[]必填每個目標一個網路
顯示子屬性
platformstring必填目標網路
允許的值:
instagramfacebookxlinkedintiktoktextstring必填在此網路上發布的文案
mediaobject[]附加的媒體
顯示子屬性
idstring門市媒體庫中某個媒體的識別碼(否則用
url和type)urlstring媒體的公開位址(正式模式下為 https);不提供識別碼時使用
typestring按位址提供的媒體的類型
允許的值:
imagevideo
formatstring格式(
post、reel、story、carousel等);預設為該網路會採用的格式accountIdstring正式模式:負責發布的已連結帳號,在門市於該網路有多個帳號時使用(
GET /v1/establishments/:id/accounts)
scheduledAtstring<date-time>排程時間(ISO 8601),須為未來時間;省略則立即發布。不能與
status為draft同時使用statusstringdraft:草稿(僅限正式模式),建立時不帶日期,不傳送任何內容;用PATCH /v1/posts/:id排程允許的值:
draft
回應
200application/json
試執行:所有檢查均已通過。
statusstring必填始終為
ready允許的值:
readydryRunboolean必填始終為
true允許的值:
truetargetsobject[]必填已檢查的目標
顯示子屬性
platformstring必填目標所在的網路
statestring必填始終為
ready允許的值:
readyaccountIdstring正式模式:將發布的帳號
handlestring正式模式:其顯示的使用者名稱
201application/json
正式:publishing 或 scheduled。測試:simulated。
idstring必填貼文的識別碼,可用
GET /v1/posts/:id讀回statusstring必填建立時貼文的狀態
允許的值:
draftpublishingscheduledestablishmentIdstring必填貼文所屬的門市
targetsobject[]必填貼文的目標
顯示子屬性
platformstring必填目標所在的網路
accountIdstring必填負責發布的帳號
statestring必填建立時目標的狀態
允許的值:
draftpublishingscheduledfailed
scheduledAtstring<date-time>貼文預計發布的時間
400
請求本文格式錯誤。
401
權杖缺失、未知、已過期或已被撤銷。
402
subscription_required(正式模式,試執行也包括在內)。
403
權杖沒有 posts:write scope。
404
establishment_not_found:不在權杖所屬 Workspace 內。
422application/json
post_refused:某個網路、門市或建立會拒絕;media_import_refused(正式模式)並附原因;idempotency_key_reused。
4XXapplication/json
其他任何錯誤,以錯誤結構回傳。