Skip to main content
POST
列出可访问的项目,支持分页、按名称搜索,以及语言和状态筛选。团队访客只能看到自己通过 API 创建的项目。

身份验证和权限

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

参数

string
文本值。最小长度: 1. 最大长度: 200.
integer
整数值。最小值: 0. 最大值: 100000. 默认值: 0.
integer
整数值。最小值: 1. 最大值: 50. 默认值: 20.
string
文本值。允许的值: “afrikaans”, “albanian”, “amharic”, “arabic”, “armenian”, “assamese”, “azerbaijani”, “basque”, “belarusian”, “bengali”, “bosnian”, “bulgarian”, “catalan”, “croatian”, “czech”, “danish”, “dutch”, “english”, “british english”, “estonian”, “finnish”, “french”, “french canadian”, “galician”, “german”, “greek”, “gujarati”, “hebrew”, “hindi”, “hungarian”, “icelandic”, “indonesian”, “irish”, “italian”, “japanese”, “kannada”, “kazakh”, “khmer”, “korean”, “lao”, “latvian”, “lithuanian”, “macedonian”, “malay”, “malayalam”, “mandarin”, “marathi”, “mongolian”, “nepali”, “norwegian”, “persian”, “polish”, “portuguese”, “brazilian portuguese”, “pt_brazil”, “punjabi”, “romanian”, “russian”, “serbian”, “slovak”, “slovenian”, “spanish”, “swahili”, “swedish”, “tagalog”, “tamil”, “telugu”, “thai”, “turkish”, “ukrainian”, “urdu”, “vietnamese”, “welsh”, “yoruba”, “zulu”.
string
文本值。允许的值: “af”, “sq”, “am”, “ar”, “hy”, “as”, “ast”, “az”, “ba”, “eu”, “be”, “bn”, “bs”, “br”, “bg”, “my”, “ca”, “ceb”, “zh”, “hr”, “cs”, “da”, “nl”, “en”, “eo”, “at”, “et”, “fil”, “fo”, “fi”, “fr”, “fr-CA”, “fy”, “ff”, “gd”, “gl”, “lg”, “ka”, “de”, “el”, “gu”, “ht”, “ha”, “haw”, “he”, “hi”, “hu”, “is”, “ig”, “ilo”, “id”, “ia”, “ga”, “it”, “ja”, “jv”, “kea”, “kn”, “kk”, “km”, “kur”, “kir”, “ko”, “lo”, “la”, “luo”, “lv”, “lb”, “ln”, “lt”, “mk”, “mg”, “ms”, “ml”, “mt”, “mi”, “mr”, “mo”, “mn”, “ne”, “no”, “nn”, “nso”, “nya”, “oc”, “or”, “pa”, “ps”, “fa”, “pl”, “pt”, “ro”, “ru”, “sa”, “sr”, “sn”, “sd”, “si”, “sk”, “sl”, “so”, “es”, “su”, “sw”, “ss”, “sv”, “tl”, “tg”, “ta”, “tt”, “te”, “th”, “bo”, “tn”, “tr”, “tk”, “ug”, “uk”, “umb”, “ur”, “uz”, “vi”, “cy”, “wo”, “xh”, “yi”, “yo”, “zu”, “cmn”, “yue”, “en-GB”, “en-US”, “en-AU”, “auto-detect”.
string
文本值。允许的值: “awaitingProofreading”, “translated”, “failed”.
string
文本值。允许的值: “newestFirst”, “oldestFirst”. 默认值: “newestFirst”.
string
文本值。最小长度: 1. 最大长度: 200. 匹配模式: ^[^/\\]+$.
以下 JSON Schema 保留了发现接口公开的确切字段名、嵌套类型、默认值、范围和可接受值。其他跨字段规则列于操作说明中。

请求示例

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

响应

首次执行成功时返回 HTTP 200,操作结果位于 data 下。重放请求时可能改为返回已保存的请求状态。示例展示了一种支持的响应,并未包含所有可选字段。 返回一页可访问的项目摘要和基于偏移量的分页元数据。

结果字段

操作说明

  • offset 默认为 0,limit 默认为 20(最大为 50),sort 默认为 newestFirst。query 按项目名称搜索;folderId、源语言、目标语言和状态用于筛选列表。
  • 返回的项目字段为 projectId、projectName、originalLanguage、targetLanguages、duration、createdAt、progressStep 和 folderId。未存储的可选字段可能被省略;targetLanguages 默认为 [],duration 默认为 0,folderId 默认为 null。
  • 当底层获取的页面包含 limit 个条目时,会设置 nextOffset;它不是总数,也不证明存在下一个可访问结果。
  • 团队访客只能看到该成员在同一团队中通过 API 创建的项目。即使存在 nextOffset,筛选后返回的 projects 数组也可能较短。
  • originalLanguage 使用 fr 或 en 等源语言代码(在允许时也可使用 auto-detect);targetLanguage 使用 english 等受支持的目标语言名称。

用量

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

错误