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.
Dostarczenia są podejmowane raz. Nie ma jeszcze ponownych prób, więc zachowaj odpytywanie jako zabezpieczenie dla
wszystkiego, czego nie możesz przegapić. Planowane są ponowne próby z wykładniczym wycofaniem.
Konfiguracja
- Otwórz stronie API na swoim koncie VoiceCheap.
- W sekcji Webhooki wybierz Generuj klucz podpisu. Klucz zaczyna się od
whsec_i jest wyświetlany raz — skopiuj go i zapisz na swoim serwerze. - Wprowadź swój adres URL punktu końcowego i zapisz go. Musi on używać
https.
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:
Zdarzenia
Nie ma oddzielnego zdarzenia transkrypcji. Transkrypcja uruchamia się podczas tworzenia projektu, a projekt
istnieje dopiero wtedy, gdy jego transkrypcja jest zapisana — więc
project.created oznacza już, że transkrypcja jest
gotowa do pobrania za pomocą 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.

