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

> Ocorre quando uma chamada recebida fornece uma oferta SDP ou uma chamada iniciada pela empresa fornece uma resposta SDP.

Use `whatsapp.call.connect` para processar este evento no seu endpoint de webhook.

## Gatilhos

Ocorre quando uma chamada recebida fornece uma oferta SDP ou uma chamada iniciada pela empresa fornece uma resposta SDP.

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

Use `sdpType` para distinguir uma oferta de uma resposta. Para uma oferta recebida, crie uma resposta SDP antes de aceitar a chamada.

## Sintaxe

A YCloud envia uma solicitação HTTP `POST` para a URL de webhook configurada. A estrutura a seguir mostra uma variante de payload. Os valores entre colchetes angulares são marcadores; seus tipos estão listados em **Parâmetros**. Os campos opcionais e outras variantes são descritos abaixo.

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

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 do evento. Tamanho mínimo: `6`. Tamanho máximo: `128`. |
| `type` | string | Sim | Sempre `whatsapp.call.connect`. |
| `apiVersion` | string | Sim | A versão da API usada para renderizar este evento. |
| `createTime` | string (data e hora) | Sim | A data e hora em que este evento foi criado, formatada em [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). Por exemplo, `2022-06-01T12:00:00.000Z`. |

### Payload do evento

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

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

#### callingConnect

| Parâmetro | Tipo | Obrigatório | Descrição |
| - | - | - | - |
| `id` | string | Sim | ID exclusivo do evento de chamada. |
| `wacid` | string | Sim | O ID da chamada do WhatsApp. Este ID identifica exclusivamente a sessão da chamada. |
| `phoneId` | string | Não | O ID do número de telefone do WhatsApp Business. |
| `from` | string | Não | O número de telefone de quem realizou a chamada no formato [E.164](https://en.wikipedia.org/wiki/E.164). |
| `fromUserId` | string | Não | O ID de usuário no escopo do WhatsApp Business (BSUID) de quem realizou a chamada para chamadas iniciadas pelo cliente. |
| `fromParentUserId` | string | Não | O ID de usuário pai no escopo do WhatsApp Business de quem realizou a chamada para chamadas iniciadas pelo cliente. |
| `to` | string | Não | O número de telefone de quem recebeu a chamada no formato [E.164](https://en.wikipedia.org/wiki/E.164). |
| `toUserId` | string | Não | O ID de usuário no escopo do WhatsApp Business (BSUID) de quem recebeu a chamada para chamadas iniciadas pela empresa. |
| `toParentUserId` | string | Não | O ID de usuário pai no escopo do WhatsApp Business de quem recebeu a chamada para chamadas iniciadas pela empresa. |
| `customerProfile` | object | Não | As informações de perfil do cliente, incluindo o nome de usuário do WhatsApp quando disponível. |
| `direction` | string | Não | A direção da chamada.<ul><li>`USER_INITIATED`: Chamada iniciada pelo cliente para a empresa.</li><li>`BUSINESS_INITIATED`: Chamada iniciada pela empresa para o cliente.</li></ul> |
| `sdpType` | string | Não | O tipo de SDP para a conexão WebRTC.Valores: `offer`, `answer`. |
| `sdp` | string | Não | As informações do Session Description Protocol (SDP) em conformidade com o [RFC 8866](https://datatracker.ietf.org/doc/html/rfc8866). Contém parâmetros de sessão de mídia para a conexão WebRTC. |
| `dialTime` | integer (int64) | Não | O horário em que a chamada foi discada, em milissegundos de timestamp Unix. |

> [accordion] callingConnect.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 conexão de chamada do WhatsApp
>
> Exemplo de payload quando uma chamada do WhatsApp é conectada
>
> ```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 pelo usuário
>
> ```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 pela 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
>   }
> }
> ```

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 sobre cenários, consulte os [exemplos comentados](https://docs.ycloud.com/pt/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.