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

> Se produce cuando una llamada entrante proporciona una oferta SDP o una llamada iniciada por la empresa proporciona una respuesta SDP.

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

## Desencadenadores

Se produce cuando una llamada entrante proporciona una oferta SDP o una llamada iniciada por la empresa proporciona una respuesta SDP.

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

Usa `sdpType` para distinguir una oferta de una respuesta. Para una oferta entrante, crea una respuesta SDP antes de aceptar la llamada.

## 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.connect",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "callingConnect": {
    "id": "<ID>",
    "wacid": "<WACID>",
    "phoneId": "<PHONE_ID>",
    "from": "<FROM>",
    "to": "<TO>",
    "direction": "<DIRECTION>",
    "dialTime": "<DIAL_TIME_VALUE>",
    "sdpType": "<SDP_TYPE>",
    "sdp": "<SDP>"
  }
}
```

## Parámetros

Valida la cabecera HTTP `YCloud-Signature` antes de procesar el cuerpo JSON. Consulta la [validación de firmas](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í | Identificador único del evento. Longitud mínima: `6`. Longitud máxima: `128`. |
| `type` | string | Sí | Siempre `whatsapp.call.connect`. |
| `apiVersion` | string | Sí | La versión de la API utilizada para generar este evento. |
| `createTime` | string (date-time) | Sí | La fecha y hora en la que se creó este evento, con 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 |
| - | - | - | - |
| `callingConnect` | object | No | Payload de `callingConnect` 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** aplica cuando su objeto superior está presente. Los campos opcionales pueden omitirse; un ejemplo no convierte un campo en obligatorio.

#### callingConnect

| Parámetro | Tipo | Obligatorio | Descripción |
| - | - | - | - |
| `id` | string | Sí | Identificador único del evento de llamada. |
| `wacid` | string | Sí | El ID de llamada de WhatsApp. Este ID identifica de forma exclusiva la sesión de llamada. |
| `phoneId` | string | No | El ID del número de teléfono de WhatsApp Business. |
| `from` | string | No | El número de teléfono del llamante en formato [E.164](https://en.wikipedia.org/wiki/E.164). |
| `fromUserId` | string | No | El ID de usuario con ámbito de WhatsApp Business (BSUID) del autor de la llamada para llamadas iniciadas por clientes. |
| `fromParentUserId` | string | No | El ID principal de usuario con ámbito de WhatsApp Business del autor de la llamada para llamadas iniciadas por clientes. |
| `to` | string | No | El número de teléfono del destinatario de la llamada en formato [E.164](https://en.wikipedia.org/wiki/E.164). |
| `toUserId` | string | No | El ID de usuario con ámbito de WhatsApp Business (BSUID) del destinatario para llamadas iniciadas por empresas. |
| `toParentUserId` | string | No | El ID principal de usuario con ámbito de WhatsApp Business del destinatario para llamadas iniciadas por empresas. |
| `customerProfile` | object | No | La información de perfil del cliente, incluido el nombre de usuario de WhatsApp cuando esté disponible. |
| `direction` | string | No | La dirección de la llamada.<ul><li>`USER_INITIATED`: Llamada iniciada por el cliente hacia la empresa.</li><li>`BUSINESS_INITIATED`: Llamada iniciada por la empresa hacia el cliente.</li></ul> |
| `sdpType` | string | No | El tipo de SDP para la conexión WebRTC.Valores: `offer`, `answer`. |
| `sdp` | string | No | La información del protocolo de descripción de sesión (SDP) conforme con [RFC 8866](https://datatracker.ietf.org/doc/html/rfc8866). Contiene los parámetros de la sesión multimedia para la conexión WebRTC. |
| `dialTime` | integer (int64) | No | La hora en que se marcó la llamada, en milisegundos de marca de tiempo Unix. |

> [accordion] callingConnect.customerProfile
>
> | Parámetro | Tipo | Requerido | 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 identificadores, números de teléfono y otros valores de la cuenta son ilustrativos.

> [accordion] Evento de conexión de llamada de WhatsApp
>
> Carga útil de ejemplo cuando se conecta una llamada de WhatsApp
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_call_connect_123",
>   "type": "whatsapp.call.connect",
>   "apiVersion": "v2",
>   "createTime": "2024-01-01T12:00:00.000Z",
>   "callingConnect": {
>     "id": "6757b723960b25543b9ecc66",
>     "wacid": "wacid.HBgNNjI4MTM2MTkwNTEzMxUCABIYIEF",
>     "phoneId": "461269257068832",
>     "from": "+12025550124",
>     "to": "+12025550123",
>     "direction": "USER_INITIATED",
>     "dialTime": 1733826430000,
>     "sdpType": "offer",
>     "sdp": "v=0\r\no=- 1732169627243 2 IN IP4 127.0.0.1\r\ns=-\r\nt=0 0\r\na=group:BUNDLE audio\r\na=msid-semantic: WMS af3b01e3-eb42-4244-812e-db903c062ae7\r\na=ice-lite\r\nm=audio 3480 UDP/TLS/RTP/SAVPF 111 126\r\nc=IN IP4 31.13.87.130\r\na=rtcp:9 IN IP4 0.0.0.0\r\na=candidate:785588535 1 udp 2122260223 31.13.87.130 3480 typ host generation 0 network-cost 50\r\na=candidate:1906600321 1 udp 2122262783 2a03:2880:f217:d0:face:b00c:0:699c 3480 typ host generation 0 network-cost 50\r\na=ice-ufrag:CvRXRnInnWhQzLIE\r\na=ice-pwd:HGXUGAFI8wK6seuVknBT2Q==\r\na=fingerprint:sha-256 FB:56:A1:C5:37:35:6C:5C:1B:05:23:B0:DD:BB:2E:C9:5F:E4:70:61:7B:D9:1D:09:84:76:46:23:12:38:B7:01\r\na=setup:actpass\r\na=mid:audio\r\na=sendrecv\r\na=msid:af3b01e3-eb42-4244-812e-db903c062ae7 WhatsAppTrack1\r\na=rtcp-mux\r\na=rtpmap:111 opus/48000/2\r\na=rtcp-fb:111 transport-cc\r\na=fmtp:111 maxaveragebitrate=20000;maxplaybackrate=16000;minptime=20;sprop-maxcapturerate=16000;useinbandfec=1\r\na=rtpmap:126 telephone-event/8000\r\na=maxptime:20\r\na=ptime:20\r\na=ssrc:659928310 cname:WhatsAppAudioStream1\r\n"
>   }
> }
> ```

> [accordion] Calling Connect iniciado por el usuario
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_6757b723a5a42d369ef48480",
>   "type": "whatsapp.call.connect",
>   "apiVersion": "v2",
>   "createTime": "2024-12-10T03:36:03.749Z",
>   "callingConnect": {
>     "id": "6757b723960b25543b9ecc66",
>     "wacid": "wacid.HBgNNjI4MTM2MTkwNTEzMxrtLopSdPMwd",
>     "phoneId": "461269257068832",
>     "from": "+12025550124",
>     "fromUserId": "ID.13491208655302741918",
>     "fromParentUserId": "ID.11815799212886844830",
>     "to": "+12025550123",
>     "direction": "USER_INITIATED",
>     "sdpType": "offer",
>     "sdp": "<<RFC 4566 SDP>>"
>   }
> }
> ```

> [accordion] Calling Connect iniciado por la empresa
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_676e5a0d7a9cb742d02d7645",
>   "type": "whatsapp.call.connect",
>   "apiVersion": "v2",
>   "createTime": "2024-12-27T07:41:01.554Z",
>   "callingConnect": {
>     "id": "676e5a0d94c533526d3c5ad5",
>     "wacid": "wacid.HBgNNjI4MTM2MTkwNTEzMxUCABE",
>     "phoneId": "461269257068832",
>     "from": "+12025550124",
>     "to": "+12025550123",
>     "toUserId": "ID.13491208655302741918",
>     "toParentUserId": "ID.11815799212886844830",
>     "direction": "BUSINESS_INITIATED",
>     "sdpType": "answer",
>     "sdp": "<<RFC 4566 SDP>>",
>     "dialTime": 1735283452000
>   }
> }
> ```

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

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

Para ver guías prácticas de escenarios, consulta los [ejemplos anotados](https://docs.ycloud.com/es/api-reference/guides/examples/webhook-examples/whatsapp-calling-connect-webhook-examples).


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