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"}'
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);
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)
{
"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"
}
]
}
}
Publiceren
Publicatiestatus van een project ophalen
Haal de publicatievoortgang van het origineel, publicatiepogingen van vertalingen en geplande publicaties voor een toegankelijk project op.
POST
/
v1
/
actions
/
publishing_list
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"}'
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);
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)
{
"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"
}
]
}
}
Haal de publicatievoortgang van het origineel, publicatiepogingen van vertalingen en geplande publicaties voor een toegankelijk project op.
Vereiste machtigingen:
POST https://api.voicecheap.ai/v1/actions/publishing_list
Authenticatie en machtigingen
string
vereist
Stuur een VoiceCheap API-sleutel mee in deze header. Authorization: Bearer met dezelfde API-sleutel wordt ook ondersteund. OAuth-toegangstokens
worden alleen door MCP geaccepteerd, niet door dit REST-endpoint.
publishing:read.
Een actief betaald abonnement is vereist. Machtigingen wijzigen geen teamrollen, eigendom van resources, mediategoed of abonnementslimieten.
Parameters
string
vereist
Tekstwaarde.Minimale lengte: 1. Maximale lengte: 200. Patroon:
^[^/\\]+$.Volledig invoerschema
Volledig invoerschema
Het onderstaande JSON Schema behoudt de exacte veldnamen, geneste typen, standaardwaarden, grenzen en toegestane waarden die discovery beschikbaar stelt. Aanvullende regels tussen velden staan in de opmerkingen bij de bewerking.
{
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/\\\\]+$"
}
},
"required": ["projectId"],
"additionalProperties": false
}
Voorbeeldaanvragen
Vervang de voorbeeldidentificaties van resources en mediasleutels door waarden die voor je account zijn geretourneerd. Behoud dezelfde aanvraagidentificatie wanneer je dezelfde wijziging opnieuw probeert.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"}'
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);
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)
Antwoord
Een geslaagde eerste uitvoering retourneert HTTP 200 met het resultaat van de bewerking onder data. Een herhaalde aanvraag kan in plaats daarvan de opgeslagen aanvraagstatus retourneren. Het voorbeeld toont één ondersteund antwoord, niet alle optionele velden. Retourneert de oorspronkelijke publicatiestatus van het project, openbare publicatiepogingen van vertalingen en de ingeplande publicaties van de actor voor dat project.{
"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"
}
]
}
}
Resultaatvelden
| Veld | Beschrijving |
|---|---|
data.projectId | ID van het bovenliggende project. |
data.originalPublish | Openbare publicatiestatus van het origineel, of null wanneer het project die niet heeft. |
data.translations | Eén item per vertaalversie met workId, translatedVersionId, targetLanguage, attempts en publishedVideos. Lege lijsten met pogingen en publicaties worden geretourneerd als []. |
data.translations[].attempts | Optionele array met openbare publicatiepogingen: id, status, origin, plus optioneel scheduledAt, processingStartedAt, publishedAt, failedAt, privacyStatus, url, videoId, errorMessage. |
data.translations[].publishedVideos | Optionele array met type, videoId, privacyStatus en optioneel url, datePublished, origin, scheduledAt, plannedPublicationId. |
data.scheduled | Geplande publicatierecords die bij de aangemelde uitvoerende gebruiker en dit project horen. Bevat id, optioneel workId en translatedVersionId, platform, status, scheduledAt, title en optioneel publishedVideoUrl. |
data.scheduled[].scheduledAt | Gepland tijdstip in Unix-milliseconden. |
data.originalPublish.id | ID van de oorspronkelijke publicatiepoging. |
data.originalPublish.workId | Optionele taalversie-ID die door de oorspronkelijke publicatieworkflow wordt gebruikt. |
data.originalPublish.title | Publicatietitel. |
data.originalPublish.description | Optionele beschrijving. |
data.originalPublish.status | idle, scheduled, in-progress, completed of failed. |
data.originalPublish.useDynamicSubtitles | Of de oorspronkelijke publicatieworkflow dynamische ondertitels heeft aangevraagd. |
data.originalPublish.dynamicSubtitlesVideoUrl | Optionele URL van de gegenereerde ondertitelde video. |
data.originalPublish.scheduledAt | Optioneel gepland tijdstip in Unix-milliseconden. |
data.originalPublish.createdAt | Aanmaaktijdstip in Unix-milliseconden. |
data.originalPublish.updatedAt | Tijd van de laatste bijwerking in Unix-milliseconden. |
data.originalPublish.channels | Status per kanaal met channelId, platform, status en optioneel videoId, videoUrl, scheduledAt. |
Opmerkingen bij de bewerking
- originalPublish is null wanneer het project geen oorspronkelijke publicatiestatus heeft. De projectie ervan bevat geen opgeslagen tegoedadministratie, kanaalauthenticatie, privacyconfiguratie of ruwe foutmeldingen.
- Elke translations-vermelding heeft arrays voor attempts en publishedVideos, inclusief [] wanneer er geen records bestaan.
- scheduled wordt gefilterd op zowel projectId als de geauthenticeerde uitvoerende gebruiker, niet op de daadwerkelijke factureringseigenaar van het team.
- Dit is de actie om de resourcestatus op te vragen nadat een publicatieactie haar uitvoering op aanvraagniveau heeft voltooid.
- Opgeslagen fouten geven VoiceCheap-foutcodes en vaste berichten terug. Gebruik de code en de huidige resourcestatus om te bepalen hoe u kunt herstellen.
Verbruik
Elke geslaagde aanroep verbruikt één maandelijkse API/MCP-aanroep. Ook het mediategoed en de eigen generatielimieten van de bewerking zijn van toepassing.Fouten
| HTTP-status | Code | Betekenis of herstel |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | Inloggegevens zijn opgegeven in een queryparameter access_token of api_key. Stuur inloggegevens in headers. |
| 400 | VALIDATION_ERROR | Corrigeer de invoer aan de hand van het schema. Ongeldige of tegenstrijdige waarden worden vóór de uitvoering geweigerd. |
| 401 | API_KEY_EXPIRED | De API-sleutel is verlopen. |
| 401 | INVALID_API_KEY | Geef een geldige, niet-verlopen API-sleutel op. |
| 401 | INVALID_CREDENTIAL | De Authorization-header heeft een ongeldige indeling of is in strijd met x-api-key. |
| 401 | MISSING_CREDENTIAL | Er is geen bruikbaar authenticatiemiddel in de header opgegeven, of het overschreed 4096 tekens. |
| 401 | USER_NOT_FOUND | Het account dat bij de toegangsgegevens hoort, bestaat niet meer. |
| 403 | AMBIGUOUS_TEAM_API_KEY | De gebruiker van het authenticatiemiddel behoort tot meer dan één team, waardoor de factureringscontext onduidelijk is. |
| 403 | FORBIDDEN | De geauthenticeerde uitvoerende gebruiker heeft geen toegang tot dit project. |
| 403 | INSUFFICIENT_SCOPE | Verleen alle vereiste machtigingen of kies andere toegangsgegevens. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | De integratielimieten van het account konden niet worden geverifieerd. |
| 403 | SUBSCRIPTION_REQUIRED | Gebruik een actief betaald abonnement. |
| 403 | TEAM_OWNER_NOT_FOUND | Het effectieve account van de teameigenaar kon niet worden gevonden. |
| 404 | PROJECT_NOT_FOUND | Het project bestaat niet in het toegankelijke account. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Wacht tot de maandelijkse reset of wijzig je abonnement. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Wacht de tijd uit Retry-After af wanneer deze aanwezig is en vergroot de wachttijd tussen nieuwe pogingen. |
| 500 | INTERNAL_ERROR | Controleer de opgeslagen aanvraagstatus en de resourcegeschiedenis voordat je besluit een wijziging opnieuw te proberen. |
| 503 | SERVER_RESTARTING | De server wordt opnieuw gestart. Probeer het zo opnieuw en behoud bij een wijziging dezelfde aanvraagidentificatie. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["publishing:read"]
}
}
Was deze pagina nuttig?

