帖子
发布帖子
正式应用可立即发布、定时发布或存为草稿,测试应用只做模拟。加上 ?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
其他任何错误,以错误结构返回。