contact.unsubscribe.deleted

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

Триггеры

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

Синтаксис

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

{
  "id": "<ID>",
  "type": "contact.unsubscribe.deleted",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "unsubscriberChanged": {
    "phoneNumber": "<PHONE_NUMBER>",
    "source": "<SOURCE>",
    "updateTime": "<UPDATE_TIME>"
  }
}

Параметры

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

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

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

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

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

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

unsubscriberChanged

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Идентификатор, переданный вместе с изменением подписки, если доступен.
`phoneNumber`	string	Нет	Номер телефона клиента в формате E.164.
`source`	string	Нет	Источник изменения подписки. Известные значения включают `Whatsapp`, `Inbox`, `Chatbot`, `API`, `Manual` и `Unknown`. Сохраняйте нераспознанные значения.
`updateTime`	string (date-time)	Нет	Время изменения подписки, отформатированное в соответствии с RFC 3339.

Пример

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

Клиент возобновляет подписку

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

{
  "id": "evt_3456789012",
  "type": "contact.unsubscribe.deleted",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "unsubscriberChanged": {
    "phoneNumber": "+12025550124",
    "source": "Whatsapp",
    "updateTime": "2024-01-01T12:00:00.000Z"
  }
}

Пример Contact Unsubscribe deleted

{
  "id": "evt_68f8886903683f3481f9707b",
  "type": "contact.unsubscribe.deleted",
  "apiVersion": "v2",
  "createTime": "2025-10-22T07:31:53.872Z",
  "unsubscriberChanged": {
    "id": "68f888692abba5779b565928",
    "phoneNumber": "+12025550124",
    "source": "API",
    "updateTime": "2025-10-22T07:31:53.864Z"
  }
}

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

HTTP/1.1 200 OK

Пошаговый разбор сценариев см. в разделе примеры с пояснениями.

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

Руководства

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

Webhook reference

contact.unsubscribe.deleted

Триггеры

Синтаксис

Параметры

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

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

unsubscriberChanged

Пример

​Триггеры

​Синтаксис

​Параметры

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

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

​unsubscriberChanged

​Пример

Триггеры

Синтаксис

Параметры

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

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

unsubscriberChanged

Пример