Skip to main content
POST
Pobierz nazwę folderu, instrukcje tłumaczenia, identyfikatory projektów i opcjonalne metryki projektów w aktywnym obszarze roboczym.

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: folders: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: ^[^/]+$.
boolean
Wartość logiczna.Wartość domyślna: false.
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.

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ź

Pierwsze pomyślne wykonanie zwraca HTTP 200 z wynikiem operacji w data. Ponowienie może zamiast tego zwrócić zapisany stan żądania. Przykład przedstawia jedną obsługiwaną odpowiedź, bez wszystkich opcjonalnych pól. Zwraca szczegóły folderu, wraz z aktualnymi wskaźnikami projektów, jeśli o nie poproszono.

Pola wyniku

Uwagi do operacji

  • includeProjectMetrics ma domyślną wartość false. Metryki są pomijane, chyba że o nie poproszono.
  • Dla gości zespołu projectIds i żądane statystyki obejmują tylko projekty, które utworzyli przez API w aktywnym zespole. Zapisane wyniki i ponowienia stosują te same kontrole dostępu do projektów.

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