> ## 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

> Se produce cuando se actualiza el estado de una llamada de WhatsApp.

Usa `whatsapp.call.status.updated` para gestionar este evento en tu endpoint de webhook.

## Desencadenadores

Se produce cuando se actualiza el estado de una llamada de WhatsApp.

Suscríbete a `whatsapp.call.status.updated` cuando [configures tu endpoint de webhook](https://docs.ycloud.com/es/api-reference/guides/api-fundamentals/configure-webhooks.md).

## Sintaxis

YCloud envía una solicitud HTTP `POST` a la URL de webhook que hayas configurado. La siguiente estructura muestra una variante del payload. Los valores entre corchetes angulares son marcadores de posición; sus tipos se indican en **Parámetros**. Los campos opcionales y otras variantes se describen a continuación.

```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

Valida el encabezado HTTP `YCloud-Signature` antes de procesar el cuerpo JSON. Consulta la [validación de firma](https://docs.ycloud.com/es/api-reference/guides/api-fundamentals/configure-webhooks.md).

### Envoltorio del evento

| Parámetro | Tipo | Obligatorio | Descripción |
| - | - | - | - |
| `id` | string | Sí | ID único del evento. Longitud mínima: `6`. Longitud máxima: `128`. |
| `type` | string | Sí | Siempre `whatsapp.call.status.updated`. |
| `apiVersion` | string | Sí | La versión de la API utilizada para procesar este evento. |
| `createTime` | string (date-time) | Sí | Fecha y hora en la que se creó este evento, en formato [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). Por ejemplo: `2022-06-01T12:00:00.000Z`. |

### Payload del evento

| Parámetro | Tipo | Obligatorio | Descripción |
| - | - | - | - |
| `callingStatusUpdated` | object | No | Payload `callingStatusUpdated` específico del evento. |

Los cuatro campos comunes del envoltorio son obligatorios. Los campos del payload dependen de la variante del evento. En cada tabla de objetos, **Obligatorio** se aplica cuando su objeto superior está presente. Los campos opcionales se pueden omitir; un ejemplo no convierte un campo en obligatorio.

#### callingStatusUpdated

| Parámetro | Tipo | Obligatorio | Descripción |
| - | - | - | - |
| `id` | string | No | ID único para el evento de la llamada (campo opcional, puede no estar presente). |
| `wabaId` | string | No | ID de la cuenta de WhatsApp Business. |
| `wacid` | string | Sí | El ID de la llamada de WhatsApp. Este ID identifica de forma única la sesión de llamada. |
| `phoneId` | string | No | El ID del número de teléfono de WhatsApp Business (campo opcional, puede no estar presente). |
| `status` | string | Sí | El estado actual de la llamada.<ul><li>`RINGING`: la llamada iniciada por la empresa está sonando en el teléfono del usuario.</li><li>`ACCEPTED`: el usuario acepta la llamada iniciada por la empresa.</li><li>`REJECTED`: el usuario rechaza la llamada iniciada por la empresa.</li></ul> |
| `recipientPhone` | string | No | El número de teléfono del destinatario en formato [E.164](https://en.wikipedia.org/wiki/E.164). |
| `recipientUserId` | string | No | El ID de usuario exclusivo para WhatsApp Business del destinatario (BSUID). |
| `parentRecipientUserId` | string | No | El ID de usuario principal exclusivo para WhatsApp Business del destinatario. |
| `customerProfile` | object | No | Información del perfil del cliente, incluido el nombre de usuario de WhatsApp cuando esté disponible. |

> [accordion] callingStatusUpdated.customerProfile
>
> | Parámetro | Tipo | Obligatorio | Descripción |
> | - | - | - | - |
> | `name` | string | No | Nombre de la cuenta de WhatsApp. |
> | `username` | string | No | Nombre de usuario de WhatsApp. |

## Ejemplo

El siguiente JSON es el cuerpo entregado a tu receptor. Los ID, números de teléfono y otros valores de cuenta son ilustrativos.

> [accordion] Evento de estado de llamada de WhatsApp actualizado
>
> Ejemplo de payload cuando se actualiza el estado de una llamada de WhatsApp
>
> ```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] La llamada iniciada por la empresa está sonando en el teléfono del usuario
>
> ```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] El usuario acepta la llamada iniciada por la empresa
>
> ```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] El usuario rechaza la llamada iniciada por la empresa
>
> ```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"
>   }
> }
> ```

Después de verificar la firma y aceptar el evento de forma duradera, devuelve una respuesta `2xx`. Procesa las tareas lentas de forma asíncrona.

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

Para ver ejemplos guiados de diferentes situaciones, consulta [ejemplos comentados](https://docs.ycloud.com/es/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.