contact.unsubscribe.created

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

Триггеры

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

Синтаксис

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

{
  "id": "<ID>",
  "type": "contact.unsubscribe.created",
  "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.created`.
`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.created",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "unsubscriberChanged": {
    "phoneNumber": "+12025550124",
    "source": "Whatsapp",
    "updateTime": "2024-01-01T12:00:00.000Z"
  }
}

Пример Contact Unsubscribe Created

{
  "id": "evt_68f8886903683f3481f9707b",
  "type": "contact.unsubscribe.created",
  "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.created

Триггеры

Синтаксис

Параметры

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

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

unsubscriberChanged

Пример

​Триггеры

​Синтаксис

​Параметры

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

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

​unsubscriberChanged

​Пример

Триггеры

Синтаксис

Параметры

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

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

unsubscriberChanged

Пример