Webhooki
Webhooki pozwalają VoiceCheap powiadomić Twój serwer, gdy tylko coś się wydarzy, dzięki czemu możesz przestać odpytywaćGET /v1/translate/{projectId}/status.
Dostarczenie jest podejmowane tylko raz, bez ponawiania. W przypadku ważnych zdarzeń nadal sprawdzaj status.
Konfiguracja
- Otwórz stronie API na swoim koncie VoiceCheap.
- W sekcji Webhooki wybierz Wygeneruj klucz podpisujący. Klucz zaczynający się od
whsec_pojawi się tylko raz; skopiuj go i zapisz na serwerze. - W polu Adres URL wpisz adres
httpsi wybierz Zapisz.
Adresy URL webhooków muszą używać HTTPS na porcie 443 i wskazywać publiczny adres sieciowy. Odrzucane są adresy URL z danymi logowania lub
fragmentami, adresy prywatne lub zarezerwowane oraz przekierowania. Dotyczy to punktu końcowego konta i adresów ustawianych dla poszczególnych
projektów.
webhooks_get, webhooks_update i webhooks_delete przez API akcji lub MCP. Używaj webhooks_create_secret wyłącznie przez API akcji REST. Bezpiecznie zapisz otrzymany sekret podpisywania; MCP nie pozwala wykonać tej akcji ani odpytywać o jej wynik.
Zastępowanie punktu końcowego dla każdego żądania
POST /v1/translate i POST /v1/projects akceptują opcjonalne pole webhookUrl, które zastępuje
punkt końcowy konta tylko dla tego projektu. Jest to przydatne do wysyłania ruchu testowego gdzie indziej:
Możesz również ustawić webhookUrl w POST /v1/projects/{projectId}/dub, aby zmienić miejsce dostarczania zdarzeń dla istniejącego projektu.
Zdarzenia
Nie ma osobnego zdarzenia transkrypcji. Odpowiedź na utworzenie projektu przychodzi przed jej zakończeniem.
project.created jest wysyłane dopiero
po zapisaniu transkrypcji; można ją wtedy pobrać przez POST /v1/projects/{projectId}/transcript.Ładunek (Payload)
Każde dostarczenie toPOST z treścią JSON:
Ładunek jest celowo ograniczony. Wywołaj REST API, aby uzyskać samą treść.
Weryfikacja podpisu
Każde dostarczenie zawiera te nagłówki:
Podpis obejmuje
<timestamp>.<raw body>, więc jest inny przy każdym dostarczeniu i dowodzi zarówno
tego, że żądanie pochodzi od VoiceCheap, jak i tego, że treść nie została zmodyfikowana w trakcie przesyłania.
Odpowiadanie
Odpowiedz dowolnym statusem2xx, aby potwierdzić odbiór. Odpowiedz w ciągu 10 sekund — najpierw potwierdź, a potem
wykonaj pracę, zamiast przetwarzać przed wysłaniem odpowiedzi.
Odpowiedź inna niż 2xx lub przekroczenie czasu jest rejestrowane jako nieudane dostarczenie i na razie nie jest ponawiane.

