Webhook
I webhook consentono a VoiceCheap di notificare il tuo server non appena accade qualcosa, così puoi interrompere il pollingGET /v1/translate/{projectId}/status.
I tentativi di consegna vengono effettuati una volta. Non ci sono ancora tentativi di riprova, quindi mantieni il polling come rete di sicurezza per
tutto ciò che non puoi permetterti di perdere. Sono previsti tentativi di riprova con backoff esponenziale.
Configurazione
- Apri la pagina API nel tuo account VoiceCheap.
- In Webhook, seleziona Genera segreto di firma. Il segreto inizia con
whsec_e viene mostrato una volta — copialo e salvalo sul tuo server. - Inserisci il tuo URL dell’endpoint e salvalo. Deve utilizzare
https.
Sovrascrittura dell’endpoint per richiesta
POST /v1/translate e POST /v1/projects accettano un campo opzionale webhookUrl che sovrascrive
l’endpoint dell’account solo per quel progetto. È utile per inviare il traffico di staging altrove:
Eventi
Non esiste un evento di trascrizione separato. La trascrizione viene eseguita durante la creazione del progetto e un progetto
esiste solo una volta che la sua trascrizione è archiviata — quindi
project.created significa già che la trascrizione è
pronta per essere recuperata con POST /v1/projects/{projectId}/transcript.Payload
Ogni consegna è unPOST con un corpo JSON:
Il payload è intenzionalmente leggero. Chiama l’API REST per il contenuto stesso.
Verifica della firma
Ogni consegna trasporta queste intestazioni:
La firma copre
<timestamp>.<raw body>, quindi è diversa a ogni consegna e dimostra sia
che la richiesta proviene da VoiceCheap sia che il corpo non è stato modificato durante il transito.
Risposta
Rispondi con qualsiasi stato2xx per confermare la ricezione. Rispondi entro 10 secondi — conferma prima e svolgi
il lavoro in seguito, invece di elaborare prima di rispondere.
Una risposta non 2xx o un timeout viene registrato come consegna non riuscita e, per ora, non viene riprovato.

