> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 获取项目发布状态

> 获取可访问项目的原视频发布进度、翻译版本发布尝试和计划发布记录。

获取可访问项目的原视频发布进度、翻译版本发布尝试和计划发布记录。

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/publishing_list
```

## 身份验证和权限

<ParamField header="x-api-key" type="string" required>
  在此请求头中发送 VoiceCheap API 密钥。也支持通过 Authorization: Bearer 发送同一 API 密钥。OAuth 访问令牌仅适用于 MCP，此 REST 端点不接受 OAuth
  访问令牌。
</ParamField>

所需权限: `publishing:read`.

需要有效的付费订阅。权限不会改变团队角色、资源归属、媒体额度或套餐限制。

## 参数

<ParamField body="projectId" type="string" required>
  文本值。

  最小长度: 1. 最大长度: 200. 匹配模式: `^[^/\\]+$`.
</ParamField>

<Accordion title="完整输入架构">
  以下 JSON Schema 保留了发现接口公开的确切字段名、嵌套类型、默认值、范围和可接受值。其他跨字段规则列于操作说明中。

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "projectId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200,
        "pattern": "^[^/\\\\]+$"
      }
    },
    "required": ["projectId"],
    "additionalProperties": false
  }
  ```
</Accordion>

## 请求示例

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

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/publishing_list' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"projectId":"project_launch_2026"}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    projectId: 'project_launch_2026',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/publishing_list', {
    method: 'POST',
    headers: {
      'x-api-key': process.env.VOICECHEAP_API_KEY,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify(input),
  });
  const body = await response.json();
  if (!response.ok) throw new Error(body.code + ': ' + body.message);
  console.log(body);
  ```

  ```python Python theme={null}
  import os
  import requests

  response = requests.post(
      "https://api.voicecheap.ai/v1/actions/publishing_list",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"projectId": "project_launch_2026"},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## 响应

首次执行成功时返回 HTTP 200，操作结果位于 data 下。重放请求时可能改为返回已保存的请求状态。示例展示了一种支持的响应，并未包含所有可选字段。

返回项目的原版发布状态、公开的翻译版发布尝试，以及调用者为该项目安排的定时发布。

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "projectId": "project_launch_2026",
      "originalPublish": {
        "id": "7db6b953-7664-4bc2-811a-6aa7aa29038d",
        "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
        "title": "Product launch",
        "description": "Meet the new product.",
        "status": "completed",
        "useDynamicSubtitles": false,
        "createdAt": 1792152000000,
        "updatedAt": 1792152060000,
        "channels": [
          {
            "channelId": "UC1234567890abcdefghijkl",
            "platform": "youtube",
            "status": "completed",
            "videoId": "example1234",
            "videoUrl": "https://www.youtube.com/watch?v=example1234"
          }
        ]
      },
      "translations": [
        {
          "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
          "translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
          "targetLanguage": "english",
          "attempts": [],
          "publishedVideos": []
        }
      ],
      "scheduled": [
        {
          "id": "9c186772-fdba-4da7-9f37-b860e319a754",
          "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
          "translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
          "platform": "youtube",
          "status": "scheduled",
          "scheduledAt": 1918375200000,
          "title": "English product launch"
        }
      ]
    }
  }
  ```
</ResponseExample>

## 结果字段

| 字段 | 说明 |
| - | - |
| `data.projectId` | 父项目标识符。 |
| `data.originalPublish` | 公开的原始媒体发布状态；项目没有该状态时为 null。 |
| `data.translations` | 每个翻译版本对应一个条目，包含 workId、translatedVersionId、targetLanguage、attempts 和 publishedVideos。尝试和发布列表为空时返回 \[]。 |
| `data.translations[].attempts` | 可选的公开发布尝试数组：id、status、origin，以及可选的 scheduledAt、processingStartedAt、publishedAt、failedAt、privacyStatus、url、videoId、errorMessage。 |
| `data.translations[].publishedVideos` | 可选数组，包含 type、videoId、privacyStatus，以及可选的 url、datePublished、origin、scheduledAt、plannedPublicationId。 |
| `data.scheduled` | 属于已认证调用者和此项目的定时发布记录。包含 id、可选的 workId 和 translatedVersionId、platform、status、scheduledAt、title 和可选的 publishedVideoUrl。 |
| `data.scheduled[].scheduledAt` | 定时时间，以 Unix 毫秒表示。 |
| `data.originalPublish.id` | 原始媒体发布尝试的标识符。 |
| `data.originalPublish.workId` | 原始发布流程使用的可选语言内容标识符。 |
| `data.originalPublish.title` | 发布标题。 |
| `data.originalPublish.description` | 可选描述。 |
| `data.originalPublish.status` | idle、scheduled、in-progress、completed 或 failed。 |
| `data.originalPublish.useDynamicSubtitles` | 原始发布流程是否请求了动态字幕。 |
| `data.originalPublish.dynamicSubtitlesVideoUrl` | 可选的已生成字幕视频 URL。 |
| `data.originalPublish.scheduledAt` | 可选的定时时间，采用 Unix 毫秒时间戳。 |
| `data.originalPublish.createdAt` | 创建时间，以 Unix 毫秒表示。 |
| `data.originalPublish.updatedAt` | 最新更新时间，采用 Unix 毫秒时间戳。 |
| `data.originalPublish.channels` | 各频道的状态，包含 channelId、platform、status，以及可选的 videoId、videoUrl、scheduledAt。 |

## 操作说明

* 项目没有原版发布状态时，originalPublish 为 null。其投影不包含已存储的额度核算、频道身份验证、隐私配置和原始错误消息。
* 每个 translations 条目都包含 attempts 和 publishedVideos 数组；没有记录时也会包含 \[]。
* scheduled 同时按 projectId 和通过身份验证的调用者筛选，而非按实际团队计费所有者筛选。
* 发布操作完成请求级执行后，使用此操作轮询资源状态。
* 已保存的失败返回 VoiceCheap 错误代码和固定消息。请根据代码和资源的当前状态决定如何恢复。

## 用量

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

## 错误

| HTTP 状态 | 代码 | 含义或恢复方式 |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | 凭证通过 access\_token 或 api\_key 查询参数提供。请在标头中发送凭证。 |
| 400 | `VALIDATION_ERROR` | 请根据架构更正输入。无效或不一致的值会在执行前被拒绝。 |
| 401 | `API_KEY_EXPIRED` | API 密钥已过期。 |
| 401 | `INVALID_API_KEY` | 请提供有效且未过期的 API 密钥。 |
| 401 | `INVALID_CREDENTIAL` | Authorization 标头格式错误或与 x-api-key 冲突。 |
| 401 | `MISSING_CREDENTIAL` | 未提供可用的请求头凭据，或其长度超过 4096 个字符。 |
| 401 | `USER_NOT_FOUND` | 该凭据对应的账户已不存在。 |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | 此凭据对应的用户属于多个团队，因此计费上下文不明确。 |
| 403 | `FORBIDDEN` | 通过身份验证的调用者无权访问此项目。 |
| 403 | `INSUFFICIENT_SCOPE` | 请授予全部所需权限，或选择其他凭据。 |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | 无法验证该账户的集成限制。 |
| 403 | `SUBSCRIPTION_REQUIRED` | 请使用有效的付费订阅。 |
| 403 | `TEAM_OWNER_NOT_FOUND` | 找不到实际生效的团队所有者账户。 |
| 404 | `PROJECT_NOT_FOUND` | 可访问的账户中不存在此项目。 |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | 请等待月度额度重置，或更改套餐。 |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | 如果提供了 Retry-After，请等待其指定的时间，并采用退避重试。 |
| 500 | `INTERNAL_ERROR` | 在决定是否重试修改操作前，请检查已保存的请求状态和资源历史记录。 |
| 503 | `SERVER_RESTARTING` | 服务器正在重启。请稍后重试；对于修改操作，请保持请求标识符不变。 |

```json theme={null}
{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["publishing:read"]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.