whatsapp.call.recording.updated

Use whatsapp.call.recording.updated para processar este evento em seu endpoint de webhook.

Gatilhos

Ocorre quando a gravação de uma chamada do WhatsApp originada por API fica disponível ou falha permanentemente. Inscreva-se em whatsapp.call.recording.updated quando você configurar seu endpoint de webhook. Este evento relata um estado terminal para um recurso de mídia de chamada originada por API. Use mediaAssetId com a API de download de mídia de chamada quando status for AVAILABLE. Inspecione error quando status for FAILED.

Sintaxe

A YCloud envia uma solicitação HTTP POST para a URL de webhook configurada. O formato a seguir mostra uma variante de payload. Valores entre colchetes angulares são marcadores de posição; seus tipos estão listados em Parâmetros. Campos opcionais e outras variantes são descritos abaixo.

{
  "id": "<ID>",
  "type": "whatsapp.call.recording.updated",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "callingRecording": {
    "wacid": "<WACID>",
    "phoneId": "<PHONE_ID>",
    "mediaAssetId": "<MEDIA_ASSET_ID>",
    "status": "<STATUS>"
  }
}

Parâmetros

Valide o cabeçalho HTTP YCloud-Signature antes de processar o corpo JSON. Consulte a validação de assinatura.

Envelope do evento

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID exclusivo do evento. Tamanho mínimo: `6`. Tamanho máximo: `128`.
`type`	string	Sim	Sempre `whatsapp.call.recording.updated`.
`apiVersion`	string	Sim	A versão da API usada para renderizar este evento.
`createTime`	string (date-time)	Sim	O momento em que este evento foi criado, formatado em RFC 3339. Ex.: `2022-06-01T12:00:00.000Z`.

Payload do evento

Parâmetro	Tipo	Obrigatório	Descrição
`callingRecording`	object	Não	Payload específico do evento `callingRecording`.

Os quatro campos comuns do envelope são obrigatórios. Os campos do payload dependem da variante do evento. Em cada tabela de objeto, Obrigatório se aplica quando o objeto pai estiver presente. Campos opcionais podem ser omitidos; um exemplo não torna um campo obrigatório.

callingRecording

Parâmetro	Tipo	Obrigatório	Descrição
`wacid`	string	Sim	ID da chamada do WhatsApp.
`phoneId`	string	Sim	ID do número de telefone comercial do WhatsApp usado para a entrega do recurso autorizado.
`mediaAssetId`	string	Sim	ID do recurso de mídia da YCloud usado com a API de download de mídia de chamada.
`status`	string	Sim	Valores: `AVAILABLE`, `FAILED`.
`error`	object	Não	Presente apenas quando `status` for `FAILED`.

callingRecording.error

Parâmetro	Tipo	Obrigatório	Descrição
`code`	string	Sim	Código estável de falha.
`retryable`	boolean	Sim	Indica se tentar novamente a operação de mídia upstream pode ter sucesso.

Exemplo

O JSON a seguir é o corpo entregue ao seu receptor. IDs, números de telefone e outros valores de conta são ilustrativos. Exemplo de payload quando uma gravação de chamada originada por API fica disponível

{
  "id": "evt_call_recording_01JZ8K4V7H3P6Q9R2T5W8X1Y4Z",
  "type": "whatsapp.call.recording.updated",
  "apiVersion": "v2",
  "createTime": "2026-08-04T08:00:00.000Z",
  "callingRecording": {
    "wacid": "wacid.HBgNNjI4MTM2MTkwNTEzMxUCABE",
    "phoneId": "461269257068832",
    "mediaAssetId": "66b1f0c2e4b05c2d8f1a3b47",
    "status": "AVAILABLE"
  }
}

Após verificar a assinatura e aceitar o evento de forma duradoura, retorne uma resposta 2xx. Processe tarefas lentas de forma assíncrona.

HTTP/1.1 200 OK

Para conferir explicações passo a passo de cenários, consulte os exemplos anotados.

Primeiros passos

Guias

Endpoints

Webhook reference

whatsapp.call.recording.updated

Gatilhos

Sintaxe

Parâmetros

Envelope do evento

Payload do evento

callingRecording

Exemplo

​Gatilhos

​Sintaxe

​Parâmetros

​Envelope do evento

​Payload do evento

​callingRecording

​Exemplo

Gatilhos

Sintaxe

Parâmetros

Envelope do evento

Payload do evento

callingRecording

Exemplo