Skip to main content
POST
Opublikuj lub zaplanuj publikację oryginalnych multimediów projektu na własnych połączonych kanałach YouTube/TikTok, opcjonalnie z dynamicznymi napisami. Ta operacja publikuje treści na zewnątrz; jawnie wybierz ustawienie prywatności, jeśli zamierzasz udostępnić je publicznie.

Uwierzytelnianie i uprawnienia

string
wymagane
Wyślij klucz API VoiceCheap w tym nagłówku. Obsługiwany jest również nagłówek Authorization: Bearer z tym samym kluczem API. Tokeny dostępu OAuth są akceptowane tylko przez MCP, a nie przez ten endpoint REST.
Wymagane uprawnienia: publishing:write, projects:read. Wymagana jest aktywna płatna subskrypcja. Uprawnienia nie zmieniają ról w zespole, własności zasobów, kredytów na multimedia ani limitów planu.

Parametry

string
wymagane
Wartość tekstowa.Minimalna długość: 1. Maksymalna długość: 200. Wzorzec: ^[^/\\]+$.
string
wymagane
Wartość tekstowa.Minimalna długość: 1. Maksymalna długość: 200. Wzorzec: ^[^/\\]+$.
string
wymagane
Wartość tekstowa.Minimalna długość: 1. Maksymalna długość: 100.
string
Wartość tekstowa.Maksymalna długość: 5000.
array
Lista wartości. Strukturę elementów opisuje pełny schemat danych wejściowych.Maksymalna liczba elementów: 20.
array
Lista wartości. Strukturę elementów opisuje pełny schemat danych wejściowych.Maksymalna liczba elementów: 20.
string
Wartość tekstowa.Dozwolone wartości: “public”, “unlisted”, “private”. Wartość domyślna: “private”.
string
Wartość tekstowa.Dozwolone wartości: “PUBLIC_TO_EVERYONE”, “MUTUAL_FOLLOW_FRIENDS”, “FOLLOWER_OF_CREATOR”, “SELF_ONLY”. Wartość domyślna: “SELF_ONLY”.
boolean
Wartość logiczna.Wartość domyślna: false.
string
Wartość tekstowa.Format: “date-time”. Wzorzec: ^(?:(?:\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
Opcjonalne na poziomie transportu: jeśli identyfikator zostanie pominięty, serwer doda go przed walidacją. Podaj własny, stały UUID v4, aby bezpiecznie odzyskać wynik po utracie odpowiedzi.Format: “uuid”. Wzorzec: ^[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}$.
Poniższy JSON Schema zachowuje dokładne nazwy pól, typy zagnieżdżone, wartości domyślne, ograniczenia i akceptowane wartości udostępniane przez mechanizm wykrywania. Dodatkowe reguły zależności między polami znajdują się w uwagach do operacji.

Idempotencja

Dla każdej operacji zmieniającej dane użyj UUID v4 w requestId lub w nagłówku HTTP Idempotency-Key. Po awarii sieci użyj ponownie tego samego identyfikatora i identycznych argumentów. Jeśli podasz oba, muszą być zgodne. Ponowienie zapisanego żądania nie powtarza operacji ani nie zużywa kolejnego wywołania z miesięcznego limitu. Żądania zakończone błędem lub przerwane nie są automatycznie uruchamiane ponownie. Każda operacja zmieniająca dane może zwrócić HTTP 202, gdy ponowienie napotka to samo żądanie nadal w stanie running, nawet jeśli jej pierwsze wykonanie zwykle jest synchroniczne. Jeśli wykonanie się zakończyło, ale resultStored ma wartość false, ponowienie zwraca HTTP 200 z zapisanym stanem żądania zamiast pierwotnego wyniku. Pobierz wynik za pomocą akcji historii, wyniku lub pobierania właściwej dla danej domeny.

Przykłady żądań

Zastąp przykładowe identyfikatory zasobów i klucze multimediów wartościami zwróconymi dla Twojego konta. Przy ponawianiu tej samej operacji zmieniającej dane zachowaj identyfikator żądania.

Odpowiedź

Ta operacja zwraca HTTP 202 podczas przetwarzania. Zapisz requestId i odpytuj action_request_get, podając ten identyfikator oraz nazwę pierwotnej operacji. Stany odpytywania to running, completed, failed i interrupted. Zakończony wynik może wskazywać osobne zadanie przetwarzania multimediów; kontynuuj za pomocą akcji stanu lub wyniku właściwej dla tej operacji. Zwraca odświeżony publiczny stan publikacji oryginału po zażądaniu publikacji lub zaplanowaniu jej na wybranych kanałach.

Pola wyniku

Odzyskaj żądanie i sprawdź jego stan

Używaj tego samego identyfikatora także po utracie połączenia. Jeśli resultStored ma wartość false, pobierz wynik za pomocą odpowiedniej akcji historii, wyniku lub pobierania. Nigdy nie uruchamiaj drugiego generowania tylko po to, aby sprawdzić postęp.
HTTP 200

Uwagi do operacji

  • Ta akcja publikuje na zewnętrznych platformach i wymaga własności projektu. Co najmniej jedna z tablic youtubeChannelIds lub tiktokChannelIds musi zawierać kanał połączony z uwierzytelnionym użytkownikiem; każda tablica dopuszcza maksymalnie 20 wpisów.
  • workId musi należeć do tego projektu, mimo że wybrane multimedia to oryginalne wideo.
  • Integracja domyślnie ustawia youtubePrivacyStatus na private i tiktokPrivacyLevel na SELF_ONLY. Jawnie ustaw żądany poziom prywatności, jeśli zamierzasz zapewnić szerszy dostęp.
  • includeDynamicSubtitles ma domyślnie wartość false, a po włączeniu wymaga subtitles:write. Korzysta ze standardowych limitów napisów i kredytów na multimedia.
  • scheduledAt to opcjonalna data i godzina ISO z przesunięciem strefy czasowej. Tylko czas ściśle w przyszłości planuje przepływ publikacji oryginału; prawidłowy znacznik czasu z przeszłości go nie planuje i może spowodować natychmiastową publikację.
  • To długotrwała akcja. Sprawdzaj stan przez action_request_get, aby potwierdzić zakończenie procedury obsługi, a następnie przez publishing_list, aby sprawdzić postęp publikacji zasobu lub zaplanowane wyniki.
  • originalPublish może mieć wartość null, gdy stan nie jest dostępny, lub wskazywać stan in-progress, scheduled, completed albo failed. Wyniki poszczególnych kanałów znajdują się w channels, więc zwrócenie wyniku nie gwarantuje pomyślnej publikacji na każdym kanale.

Wykorzystanie

Każde pomyślne wywołanie zużywa jedno wywołanie z miesięcznego limitu API/MCP. Obowiązują również kredyty na multimedia oraz limity generowania danej operacji.

Błędy