开发者文档 / 带货内容发布
取消发布
通过发布任务的 postId 取消尚未进入终态的发布任务。
POST
/v1/creator/post/cancel- 鉴权:
- 请求头 x-api-key: <YOUR_API_KEY>;密钥仅保存在服务端。
- 成功判断:
- HTTP 2xx 且响应 code=0;异步任务还需查询最终状态。
请求字段
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
postId | string | 是 | 创建发布任务时返回的 postId |
已完成、已失败或已取消的任务不能再次取消。
请求体
{
"postId": "post_xxx"
}成功响应
{
"code": 0,
"data": null,
"message": "success"
}响应与错误
主要响应字段来自接口规范;完整层级、联合类型和校验规则见 JSON Schema。必填指字段所在对象中的约束。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
code | integer | 是 | 固定值:0 |
data | null | 是 | — |
message | string | 是 | — |
timestamp | integer | 否 | 响应时间戳,单位毫秒。 |
HTTP 400请求参数或请求体无效,请修正后重试。HTTP 401API 密钥缺失或无效,请检查 x-api-key。HTTP 403API 密钥没有此接口的调用权限。HTTP 429请求过于频繁,请采用指数退避重试。HTTP 500服务端发生错误;对于暂时性故障采用指数退避重试。
参数、权限或授权错误需先修正。创建发布或生成任务超时后先查询已有任务,避免重复创建;不要因轮询中断而重复提交。
最后更新 · 2026-09-29