Webhooks
Webhooks permitem que VoiceCheap notifique seu servidor assim que algo acontece, para que você possa parar de sondarGET /v1/translate/{projectId}/status.
As entregas são tentadas uma vez. Ainda não há novas tentativas, portanto, continue sondando como uma rede de segurança para
qualquer coisa que você não possa perder. Novas tentativas com espera exponencial estão planejadas.
Configuração
- Abra a página da API em sua conta VoiceCheap.
- Em Webhooks, selecione Gerar segredo de assinatura. O segredo começa com
whsec_e é mostrado uma vez — copie-o e armazene-o em seu servidor. - Insira sua URL de endpoint e salve-a. Ela deve usar
https.
Substituindo o endpoint por solicitação
POST /v1/translate e POST /v1/projects aceitam um campo opcional webhookUrl que substitui o
endpoint da conta apenas para aquele projeto. É útil para enviar tráfego de teste para outro lugar:
Eventos
Não existe um evento de transcrição separado. A transcrição é executada durante a criação do projeto, e um projeto
só existe quando sua transcrição é armazenada — portanto,
project.created já significa que a transcrição está
pronta para ser buscada com POST /v1/projects/{projectId}/transcript.Payload
Cada entrega é umPOST com um corpo JSON:
O payload é intencionalmente leve. Chame a API REST para obter o conteúdo em si.
Verificando a assinatura
Cada entrega carrega estes cabeçalhos:
A assinatura cobre
<timestamp>.<raw body>, portanto, é diferente em cada entrega e prova tanto
que a solicitação veio do VoiceCheap quanto que o corpo não foi modificado em trânsito.
Respondendo
Responda com qualquer status2xx para confirmar o recebimento. Responda dentro de 10 segundos — confirme primeiro e faça
o trabalho depois, em vez de processar antes de responder.
Uma resposta que não seja 2xx ou um tempo limite é registrada como uma entrega falha e, por enquanto, não é tentada novamente.

