contact.deleted

Используйте contact.deleted для обработки этого события на вашей конечной точке Webhook.

Триггеры

Происходит при удалении контакта. Подпишитесь на contact.deleted, когда будете настраивать конечную точку Webhook.

Синтаксис

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

{
  "id": "<ID>",
  "type": "contact.deleted",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "contactDeleted": {
    "id": "<ID>",
    "remarkName": "<REMARK_NAME>",
    "nickName": "<NICK_NAME>",
    "phoneNumber": "<PHONE_NUMBER>",
    "updateTime": "<UPDATE_TIME>"
  }
}

Параметры

Проверяйте HTTP-заголовок YCloud-Signature перед обработкой тела JSON. См. проверку подписи.

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

Параметр	Тип	Обязательный	Описание
`id`	string	Да	Уникальный идентификатор события. Минимальная длина: `6`. Максимальная длина: `128`.
`type`	string	Да	Всегда `contact.deleted`.
`apiVersion`	string	Да	Версия API, использованная для формирования этого события.
`createTime`	string (date-time)	Да	Время создания этого события в формате RFC 3339. Например, `2022-06-01T12:00:00.000Z`.

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

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

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

contactDeleted

Параметр	Тип	Обязательный	Описание
`id`	string	Да	Идентификатор контакта
`remarkName`	string	Нет	Управляемое компанией имя-примечание из снимка удаленного контакта.
`nickName`	string	Нет	Псевдоним контакта.
`phoneNumber`	string	Нет	Уникальный номер телефона в формате E.164.
`updateTime`	string (date-time)	Нет	Время последнего обновления контакта в формате RFC 3339. Например, `2022-06-01T12:00:00.000Z`.

Пример

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

Событие удаления контакта

Пример полезной нагрузки при удалении контакта

{
  "id": "evt_3456789012",
  "type": "contact.deleted",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "contactDeleted": {
    "id": "1824266594102064128",
    "remarkName": "Former customer",
    "nickName": "John Doe",
    "phoneNumber": "+12025550124",
    "updateTime": "2024-01-01T12:00:00.000Z"
  }
}

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

{
  "id": "evt_3456789012",
  "type": "contact.deleted",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "contactDeleted": {
    "id": "1824266594102064128",
    "nickName": "John Doe",
    "phoneNumber": "+12025550124",
    "updateTime": "2024-01-01T12:00:00.000Z"
  }
}

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

HTTP/1.1 200 OK

Пошаговые сценарии см. в примерах с пояснениями.

Начало работы

Руководства

Конечные точки

Webhook reference

Триггеры

Синтаксис

Параметры

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

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

contactDeleted

Пример

​Триггеры

​Синтаксис

​Параметры

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

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

​contactDeleted

​Пример

Триггеры

Синтаксис

Параметры

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

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

contactDeleted

Пример