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.
Se intenta cada entrega una sola vez. No hay reintentos; siga consultando el estado como respaldo para los eventos importantes.

Configuración

  1. Abra la página de API en su cuenta de VoiceCheap.
  2. En Webhooks, seleccione Generar clave de firma. La clave que empieza por whsec_ solo aparece una vez; cópiela y guárdela en su servidor.
  3. Introduzca una URL https en URL de destino y seleccione Guardar.
Eso es todo. Cada proyecto que inicie a partir de entonces enviará eventos a ese punto final.
Las URL de webhook deben usar HTTPS en el puerto 443 y resolver a una dirección de red pública. Se rechazan las URL con credenciales o fragmentos, las direcciones privadas o reservadas y las redirecciones. Esto se aplica al endpoint de la cuenta y a las URL específicas de cada proyecto.
Usa webhooks_get, webhooks_update y webhooks_delete mediante la API de acciones o MCP. Usa webhooks_create_secret solo mediante la API de acciones REST. Guarda de forma segura el secreto de firma cuando se devuelva; MCP no permite ejecutar ni consultar esta acción.

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: También puede establecer webhookUrl en POST /v1/projects/{projectId}/dub para actualizar el destino de un proyecto existente.
El secreto de firma es siempre el secreto de la cuenta; solo cambia el destino.

Eventos

No hay un evento de transcripción independiente. La creación del proyecto responde antes de que termine la transcripción. project.created se envía solo después de guardar la transcripción; entonces puede obtenerla 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.