Skip to main content
POST
将原项目媒体发布或定时发布到当前账户已连接的 YouTube/TikTok 频道,可选择添加动态字幕。此操作会向外部平台发布内容;如需公开访问,请明确选择隐私设置。

身份验证和权限

string
必填
在此请求头中发送 VoiceCheap API 密钥。也支持通过 Authorization: Bearer 发送同一 API 密钥。OAuth 访问令牌仅适用于 MCP,此 REST 端点不接受 OAuth 访问令牌。
所需权限: publishing:write, projects:read. 需要有效的付费订阅。权限不会改变团队角色、资源归属、媒体额度或套餐限制。

参数

string
必填
文本值。最小长度: 1. 最大长度: 200. 匹配模式: ^[^/\\]+$.
string
必填
文本值。最小长度: 1. 最大长度: 200. 匹配模式: ^[^/\\]+$.
string
必填
文本值。最小长度: 1. 最大长度: 100.
string
文本值。最大长度: 5000.
array
值列表。项目结构请参阅完整输入架构。最多项目数: 20.
array
值列表。项目结构请参阅完整输入架构。最多项目数: 20.
string
文本值。允许的值: “public”, “unlisted”, “private”. 默认值: “private”.
string
文本值。允许的值: “PUBLIC_TO_EVERYONE”, “MUTUAL_FOLLOW_FRIENDS”, “FOLLOWER_OF_CREATOR”, “SELF_ONLY”. 默认值: “SELF_ONLY”.
boolean
布尔值。默认值: false.
string
文本值。格式: “date-time”. 匹配模式: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$.
string
在传输层可选:如果省略,服务器会在验证前注入标识符。请自行提供稳定的 UUID v4,以便在响应丢失后安全恢复。格式: “uuid”. 匹配模式: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$.
以下 JSON Schema 保留了发现接口公开的确切字段名、嵌套类型、默认值、范围和可接受值。其他跨字段规则列于操作说明中。

幂等性

为每次修改操作在 requestId 或 Idempotency-Key HTTP 请求头中提供 UUID v4。网络故障后,请使用相同标识符和完全相同的参数重试。如果同时提供这两个值,它们必须一致。重放已保存的请求不会重复执行操作,也不会再次扣除月度调用次数。失败或中断的请求不会自动重新执行。 对于每次修改操作,如果重试时发现同一请求仍在运行,即使首次执行通常为同步操作,也可能返回 HTTP 202。如果执行已完成但 resultStored 为 false,重试会返回 HTTP 200 和已保存的请求状态,而非原始结果。请通过对应领域的历史记录、结果或下载操作获取输出。

请求示例

请将示例资源标识符和媒体键替换为账户返回的值。重试同一次修改操作时,请保持请求标识符不变。

响应

此操作在运行期间返回 HTTP 202。请保存 requestId,并使用该标识符和原始操作名称轮询 action_request_get。轮询状态包括 running、completed、failed 和 interrupted。已完成的结果可能指向独立的媒体任务;请继续使用该操作对应的状态或输出操作。 向所选频道请求发布或安排发布时间后,返回刷新的公开原版发布状态。

结果字段

恢复并轮询此请求

即使连接丢失,也应使用同一标识符。如果 resultStored 为 false,请通过相应的历史记录、结果或下载操作获取输出。切勿仅为查看进度而启动第二次生成。
HTTP 200

操作说明

  • 此操作会对外发布,要求拥有项目所有权。youtubeChannelIds 或 tiktokChannelIds 至少有一个数组须包含已连接到经过身份验证的调用者的频道;每个数组最多允许 20 个条目。
  • 即使选择的媒体是原始视频,workId 也必须属于此项目。
  • 集成默认使用 youtubePrivacyStatus private 和 tiktokPrivacyLevel SELF_ONLY。如果希望扩大访问范围,请明确设置所需的隐私级别。
  • includeDynamicSubtitles 默认为 false,启用时需要 subtitles:write。它使用常规字幕限额和媒体额度。
  • scheduledAt 为可选的带时区偏移量的 ISO 日期时间。只有严格晚于当前时间的时间才会为原始媒体工作流安排定时发布;有效的过去时间戳不会安排定时发布,并可能立即发布。
  • 这是一个长时间运行的操作。请先轮询 action_request_get,等待处理程序完成,然后轮询 publishing_list 获取资源发布进度或定时发布结果。
  • 无可用状态时,originalPublish 可为 null,也可显示 in-progress、scheduled、completed 或 failed 状态。各渠道的结果位于 channels 中,因此返回结果不保证每个渠道都发布成功。

用量

每次成功调用消耗一次月度 API/MCP 调用额度。媒体额度和操作本身的生成限额也适用。

错误