> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ycloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# whatsapp.call.status.updated

> Ocorre quando o status de uma chamada do WhatsApp é atualizado.

Use `whatsapp.call.status.updated` para manipular este evento em seu endpoint de webhook.

## Gatilhos

Ocorre quando o status de uma chamada do WhatsApp é atualizado.

Assine `whatsapp.call.status.updated` quando [configurar seu endpoint de webhook](https://docs.ycloud.com/pt/api-reference/guides/api-fundamentals/configure-webhooks.md).

## Sintaxe

A YCloud envia uma requisiçã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.

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "id": "<ID>",
  "type": "whatsapp.call.status.updated",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "callingStatusUpdated": {
    "wabaId": "<WABA_ID>",
    "wacid": "<WACID>",
    "phoneId": "<PHONE_ID>",
    "status": "<STATUS>",
    "recipientPhone": "<RECIPIENT_PHONE>"
  }
}
```

## Parâmetros

Valide o cabeçalho HTTP `YCloud-Signature` antes de processar o corpo JSON. Consulte a [validação de assinatura](https://docs.ycloud.com/pt/api-reference/guides/api-fundamentals/configure-webhooks.md).

### Envelope do evento

| Parâmetro | Tipo | Obrigatório | Descrição |
| - | - | - | - |
| `id` | string | Sim | ID exclusivo para o evento. Comprimento mínimo: `6`. Comprimento máximo: `128`. |
| `type` | string | Sim | Sempre `whatsapp.call.status.updated`. |
| `apiVersion` | string | Sim | A versão da API usada para renderizar este evento. |
| `createTime` | string (date-time) | Sim | A hora em que este evento foi criado, formatada em [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). Ex.: `2022-06-01T12:00:00.000Z`. |

### Payload do evento

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

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.

#### callingStatusUpdated

| Parâmetro | Tipo | Obrigatório | Descrição |
| - | - | - | - |
| `id` | string | Não | ID exclusivo do evento de chamada (campo opcional, pode não estar presente). |
| `wabaId` | string | Não | ID da conta do WhatsApp Business. |
| `wacid` | string | Sim | O ID da chamada do WhatsApp. Este ID identifica exclusivamente a sessão de chamada. |
| `phoneId` | string | Não | O ID do número de telefone do WhatsApp Business (campo opcional, pode não estar presente). |
| `status` | string | Sim | O status atual da chamada.<ul><li>`RINGING`: A chamada iniciada pela empresa está chamando o usuário.</li><li>`ACCEPTED`: A chamada iniciada pela empresa foi aceita pelo usuário.</li><li>`REJECTED`: A chamada iniciada pela empresa foi rejeitada pelo usuário.</li></ul> |
| `recipientPhone` | string | Não | O número de telefone do destinatário no formato [E.164](https://en.wikipedia.org/wiki/E.164). |
| `recipientUserId` | string | Não | O ID de usuário com escopo de negócios do WhatsApp (BSUID) do destinatário. |
| `parentRecipientUserId` | string | Não | O ID de usuário principal com escopo de negócios do WhatsApp do destinatário. |
| `customerProfile` | object | Não | As informações de perfil do cliente, incluindo o nome de usuário do WhatsApp quando disponível. |

> [accordion] callingStatusUpdated.customerProfile
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `name` | string | Não | Nome da conta do WhatsApp. |
> | `username` | string | Não | Nome de usuário do WhatsApp. |

## Exemplo

O seguinte JSON é o corpo entregue ao seu receptor. IDs, números de telefone e outros valores de conta são ilustrativos.

> [accordion] Evento de status de chamada do WhatsApp atualizado
>
> Exemplo de payload quando o status de uma chamada do WhatsApp é atualizado
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_676e5ab57a9cb742d02d7646",
>   "type": "whatsapp.call.status.updated",
>   "apiVersion": "v2",
>   "createTime": "2024-12-27T07:41:28.422Z",
>   "callingStatusUpdated": {
>     "wabaId": "188234691048809",
>     "wacid": "wacid.HBgNNjI4MTM2MTkwNTEzMxUCABE",
>     "phoneId": "461269257068832",
>     "status": "RINGING",
>     "recipientPhone": "+6281361905133"
>   }
> }
> ```

> [accordion] A chamada iniciada pela empresa está chamando o usuário
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_676e5ab57a9cb742d02d7646",
>   "type": "whatsapp.call.status.updated",
>   "apiVersion": "v2",
>   "createTime": "2024-12-27T07:41:28.422Z",
>   "callingStatusUpdated": {
>     "wabaId": "188234691048809",
>     "wacid": "wacid.HBgNNjI4MTM2MTkwNTEzMxUCABE",
>     "status": "RINGING",
>     "recipientPhone": "+6281361905133",
>     "recipientUserId": "ID.13491208655302741918",
>     "parentRecipientUserId": "ID.11815799212886844830"
>   }
> }
> ```

> [accordion] A chamada iniciada pela empresa foi aceita pelo usuário
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_67724ad42b4b206adc55f099",
>   "type": "whatsapp.call.status.updated",
>   "apiVersion": "v2",
>   "createTime": "2024-12-27T07:42:00.577Z",
>   "callingStatusUpdated": {
>     "wabaId": "188234691048809",
>     "wacid": "wacid.HBgNNjI4MTM2MTkwNTEzMxUCABE",
>     "status": "ACCEPTED",
>     "recipientPhone": "+6281361905133",
>     "recipientUserId": "ID.13491208655302741918",
>     "parentRecipientUserId": "ID.11815799212886844830"
>   }
> }
> ```

> [accordion] A chamada iniciada pela empresa foi rejeitada pelo usuário
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_677258526a15af2a8c7184a3",
>   "type": "whatsapp.call.status.updated",
>   "apiVersion": "v2",
>   "createTime": "2024-12-27T07:41:32.093Z",
>   "callingStatusUpdated": {
>     "wabaId": "188234691048809",
>     "wacid": "wacid.HBgNNjI4MTM2MTkwNTEzMxUCAB",
>     "status": "REJECTED",
>     "recipientPhone": "+6281361905133",
>     "recipientUserId": "ID.13491208655302741918",
>     "parentRecipientUserId": "ID.11815799212886844830"
>   }
> }
> ```

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

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```

Para orientações detalhadas de cenários, consulte os [exemplos comentados](https://docs.ycloud.com/pt/api-reference/guides/examples/webhook-examples/whatsapp-calling-status-update-webhook-examples).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.