Skip to main content

Webhooks

Los webhooks permiten que VoiceCheap notifique a su servidor tan pronto como ocurra algo, para que pueda dejar de realizar sondeos GET /v1/translate/{projectId}/status.
Las entregas se intentan una vez. Aún no hay reintentos, así que mantenga el sondeo como una red de seguridad para cualquier cosa que no pueda permitirse perder. Se planean reintentos con retroceso exponencial.

Configuración

  1. Abra la página de API en su cuenta de VoiceCheap.
  2. En Webhooks, seleccione Generar secreto de firma. El secreto comienza con whsec_ y se muestra una vez: cópielo y guárdelo en su servidor.
  3. Ingrese su URL de punto final y guárdela. Debe usar https.
Eso es todo. Cada proyecto que inicie a partir de entonces enviará eventos a ese punto final.

Anulación del punto final por solicitud

POST /v1/translate y POST /v1/projects aceptan un campo opcional webhookUrl que anula el punto final de la cuenta solo para ese proyecto. Es útil para enviar tráfico de prueba a otro lugar:
El secreto de firma es siempre el secreto de la cuenta; solo cambia el destino.

Eventos

No existe un evento de transcripción independiente. La transcripción se ejecuta durante la creación del proyecto, y un proyecto solo existe una vez que su transcripción se almacena; por lo tanto, project.created ya significa que la transcripción está lista para obtenerse con POST /v1/projects/{projectId}/transcript.

Carga útil

Cada entrega es un POST con un cuerpo JSON:
La carga útil es intencionalmente ligera. Llame a la API REST para obtener el contenido en sí.

Verificación de la firma

Cada entrega incluye estos encabezados: La firma cubre <timestamp>.<raw body>, por lo que es diferente en cada entrega y demuestra tanto que la solicitud provino de VoiceCheap como que el cuerpo no fue modificado durante el tránsito.
Verifique la firma antes de confiar en una entrega. Su punto de conexión es una URL pública, y la firma es lo que distingue un evento real de VoiceCheap de cualquier otra cosa que llegue a él.

Respuesta

Responda con cualquier estado 2xx para confirmar la recepción. Responda en un plazo de 10 segundos: confirme primero y realice el trabajo después, en lugar de procesar antes de responder. Una respuesta que no sea 2xx o un tiempo de espera se registra como una entrega fallida y, por ahora, no se vuelve a intentar.

Rotación del secreto

Seleccione Rotar en la página de la API para generar un nuevo secreto. El anterior deja de funcionar inmediatamente, así que implemente el nuevo secreto en su servidor tan pronto como lo rote. Eliminar el webhook elimina tanto el punto de conexión como el secreto, y las entregas se detienen.