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

> Происходит при обновлении статуса звонка WhatsApp.

Используйте `whatsapp.call.status.updated` для обработки этого события на вашей конечной точке Webhook.

## Триггеры

Происходит при обновлении статуса звонка WhatsApp.

Подпишитесь на `whatsapp.call.status.updated`, когда будете [настраивать конечную точку Webhook](https://docs.ycloud.com/ru/api-reference/guides/api-fundamentals/configure-webhooks.md).

## Синтаксис

YCloud отправляет HTTP-запрос `POST` на ваш настроенный URL Webhook. В приведенной структуре показан один из вариантов полезной нагрузки. Значения в угловых скобках являются заполнителями; их типы перечислены в разделе **Параметры**. Необязательные поля и другие варианты описаны ниже.

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

## Параметры

Проверьте HTTP-заголовок `YCloud-Signature` перед обработкой тела JSON. См. раздел [проверка подписи](https://docs.ycloud.com/ru/api-reference/guides/api-fundamentals/configure-webhooks.md).

### Оболочка события

| Параметр | Тип | Обязательный | Описание |
| - | - | - | - |
| `id` | string | Да | Уникальный идентификатор события. Минимальная длина: `6`. Максимальная длина: `128`. |
| `type` | string | Да | Всегда `whatsapp.call.status.updated`. |
| `apiVersion` | string | Да | Версия API, используемая для формирования этого события. |
| `createTime` | string (date-time) | Да | Время создания этого события, отформатированное в соответствии с [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). Например, `2022-06-01T12:00:00.000Z`. |

### Полезная нагрузка события

| Параметр | Тип | Обязательный | Описание |
| - | - | - | - |
| `callingStatusUpdated` | object | Нет | Специфичная для события полезная нагрузка `callingStatusUpdated`. |

Четыре общих поля оболочки являются обязательными. Поля полезной нагрузки зависят от варианта события. В каждой таблице объектов статус **Обязательный** применяется при наличии родительского объекта. Необязательные поля могут быть опущены; наличие поля в примере не делает его обязательным.

#### callingStatusUpdated

| Параметр | Тип | Обязательный | Описание |
| - | - | - | - |
| `id` | string | Нет | Уникальный идентификатор события звонка (необязательное поле, может отсутствовать). |
| `wabaId` | string | Нет | Идентификатор WhatsApp Business Account. |
| `wacid` | string | Да | Идентификатор звонка WhatsApp. Этот идентификатор однозначно определяет сеанс звонка. |
| `phoneId` | string | Нет | Идентификатор телефонного номера WhatsApp Business (необязательное поле, может отсутствовать). |
| `status` | string | Да | Текущий статус звонка.<ul><li>`RINGING`: звонок, инициированный компанией, поступает пользователю.</li><li>`ACCEPTED`: звонок, инициированный компанией, принят пользователем.</li><li>`REJECTED`: звонок, инициированный компанией, отклонен пользователем.</li></ul> |
| `recipientPhone` | string | Нет | Номер телефона получателя в формате [E.164](https://en.wikipedia.org/wiki/E.164). |
| `recipientUserId` | string | Нет | Идентификатор пользователя получателя в области WhatsApp Business (BSUID). |
| `parentRecipientUserId` | string | Нет | Родительский идентификатор пользователя получателя в области WhatsApp Business. |
| `customerProfile` | object | Нет | Информация профиля клиента, включая имя пользователя WhatsApp, если оно доступно. |

> [accordion] callingStatusUpdated.customerProfile
>
> | Параметр | Тип | Обязательный | Описание |
> | - | - | - | - |
> | `name` | string | Нет | Имя аккаунта WhatsApp. |
> | `username` | string | Нет | Имя пользователя WhatsApp. |

## Пример

Следующий JSON представляет собой тело, доставленное на ваш получатель. Идентификаторы, телефонные номера и другие значения аккаунта приведены для наглядности.

> [accordion] Событие обновления статуса звонка WhatsApp
>
> Пример полезной нагрузки при обновлении статуса звонка 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] Звонок, инициированный компанией, поступает пользователю
>
> ```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] Звонок, инициированный компанией, принят пользователем
>
> ```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] Звонок, инициированный компанией, отклонен пользователем
>
> ```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"
>   }
> }
> ```

После проверки подписи и надежного принятия события верните ответ `2xx`. Длительные операции обрабатывайте асинхронно.

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

Пошаговые сценарии см. в разделе [примеры с пояснениями](https://docs.ycloud.com/ru/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.