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

# Примеры Webhook при удалении контактов и заметок

> Обработка событий удаления контактов и независимого удаления заметок.

> [!NOTE]
>
> Полный каталог на основе схемы см. в разделе [все примеры](https://docs.ycloud.com/ru/api-reference/guides/examples/webhook-examples/webhook-payload-examples).

## Что это такое

Обработка событий `contact.deleted` и `contact.note.deleted`.

## Перед началом работы

* Создайте общедоступную конечную точку HTTPS в своем приложении.
* Настройте конечную точку Webhook в YCloud для необходимых типов событий.
* Надежно сохраните секрет подписи конечной точки.
* Обеспечьте идемпотентность обработки событий.

## Как это работает

YCloud отправляет HTTP-запрос `POST` при возникновении события. Проверьте подпись, надежно сохраните событие, верните ответ `2xx` и выполняйте длительные операции асинхронно.

## Запрос

Ниже приведены сценарии запросов, отправляемых на ваш URL-адрес Webhook. Используйте `id` события в качестве идентификатора доставки, а `type` — для маршрутизации полезной нагрузки.

## Ответ

Возвращайте статус `2xx` после успешного принятия события.

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

> [!NOTE]
>
> Информацию о настройке конечной точки, проверке подписи и механизме повторных попыток см. в разделе [Настройка Webhook](https://docs.ycloud.com/ru/api-reference/guides/api-fundamentals/configure-webhooks.md).

Предварительные требования

* URL-адрес конечной точки Webhook должен быть предоставлен вашим сервером, а не YCloud. **Обязательно замените URL-адрес на фактический URL-адрес вашей конечной точки Webhook.**
* **Убедитесь, что ваша конечная точка Webhook настроена на прослушивание соответствующих типов событий.** См. также [Настройка Webhook](https://docs.ycloud.com/ru/api-reference/guides/api-fundamentals/configure-webhooks.md), [API получения конечной точки Webhook](https://docs.ycloud.com/api-reference/webhook-endpoints/retrieve-a-webhook-endpoint.md).

Срабатывает при удалении контакта. Полезная нагрузка Webhook содержит минимальные сведения об удаленном контакте.

## Базовый пример удаления контакта

### Запрос

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "id": "evt_3456789012",
  "type": "contact.deleted",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "contactDeleted": {
    "id": "1824266594102064128",
    "nickName": "John Doe",
    "phoneNumber": "+16315551111",
    "updateTime": "2024-01-01T12:00:00.000Z"
  }
}
```

### Ответ

Подтвердите доставку после надежного сохранения события.

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

### Пояснение

* **Минимум информации**: объект `contactDeleted` содержит только основные сведения: `id`, `nickName`, `phoneNumber` и `updateTime`.
* **Значения Null**: поле `nickName` может иметь значение `null`, если у контакта не был задан псевдоним.
* **Время обновления**: поле `updateTime` указывает, когда контакт был изменен в последний раз перед удалением.
* **Идентификатор контакта**: поле `id` содержит уникальный идентификатор удаленного контакта для справки.
* **Номер телефона**: поле `phoneNumber` присутствует всегда и отформатировано в стандарте E.164.

## Удаление заметки контакта

Используйте `contact.note.deleted` при удалении заметки контакта.

### Запрос

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "id": "evt_3234567890abcdef12345678",
  "type": "contact.note.deleted",
  "apiVersion": "v2",
  "createTime": "2024-01-03T12:00:00.000Z",
  "contactNote": {
    "id": "6a3de646e18f344f743aaa4d",
    "contactId": "1824266594102064128",
    "username": "alice_01",
    "phoneNumber": "+16315551111",
    "content": "Customer now prefers afternoon follow-up.",
    "createTime": "2024-01-01T12:00:00.000Z",
    "updateTime": "2024-01-02T12:00:00.000Z"
  }
}
```

### Ответ

Подтвердите доставку после надежного сохранения события.

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

### Пояснение

Используйте `contactNote.id` для идентификации заметки и `contactId` для идентификации контакта, которому она принадлежит. Поля `username` и `phoneNumber` описывают контакт и могут иметь значение null. Полезная нагрузка содержит снимок заметки, видимый клиенту, включая `content`, без внутренних идентификаторов операторов. Это событие генерируется при независимом удалении заметки. При удалении контакта оно не генерируется для каждой каскадно удаляемой заметки.


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