whatsapp.group.lifecycle_update

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

Триггеры

Происходит при создании или удалении группы WhatsApp, включая успешные результаты и ошибки. Подпишитесь на whatsapp.group.lifecycle_update, когда будете настраивать конечную точку Webhook.

Синтаксис

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

{
  "id": "<ID>",
  "type": "whatsapp.group.lifecycle_update",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "whatsappGroup": {
    "wabaId": "<WABA_ID>",
    "displayPhoneNumber": "<DISPLAY_PHONE_NUMBER>",
    "phoneNumberId": "<PHONE_NUMBER_ID>",
    "field": "<FIELD>",
    "type": "<TYPE>",
    "requestId": "<REQUEST_ID>",
    "status": "<STATUS>",
    "groupId": "<GROUP_ID>",
    "inviteLink": "<INVITE_LINK>",
    "subject": "<SUBJECT>",
    "description": "<DESCRIPTION>",
    "joinApprovalMode": "<JOIN_APPROVAL_MODE>",
    "webhookTime": "<WEBHOOK_TIME>",
    "dedupeKey": "<DEDUPE_KEY>"
  }
}

Параметры

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

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

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

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

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

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

whatsappGroup

Параметр	Тип	Обязательный	Описание
`wabaId`	string	Нет	Идентификатор WhatsApp Business Account.
`displayPhoneNumber`	string	Нет	Отображаемый номер телефона из метаданных Webhook WhatsApp.
`phoneNumberId`	string	Нет	Идентификатор номера телефона WhatsApp.
`field`	string	Нет	Поле Webhook WhatsApp, инициировавшее событие группы. Значения: `group_lifecycle_update`, `group_participants_update`, `group_settings_update`, `group_status_update`, `messages`.
`type`	string	Нет	Конкретный тип события группы WhatsApp. Значения: `group_create`, `group_delete`, `group_participants_add`, `group_participants_remove`, `group_join_request_created`, `group_join_request_revoked`, `group_settings_update`, `group_suspend`, `group_suspend_cleared`, `message_status`.
`requestId`	string	Нет	Идентификатор запроса, возвращенный асинхронной операцией API для групп.
`status`	string	Нет	Статус Webhook группы WhatsApp. Значения: `created`, `failed`, `deleted`, `added`, `removed`, `left`, `requested`, `revoked`, `updated`, `suspended`, `suspend_cleared`, `sent`, `delivered`, `read`, `expired`.
`groupId`	string	Нет	Идентификатор группы WhatsApp.
`messageId`	string	Нет	Идентификатор группового сообщения YCloud. Присутствует, только когда событие статуса связано с сохраненным исходящим групповым сообщением.
`inviteLink`	string	Нет	Ссылка-приглашение в группу.
`reason`	string	Нет	Причина события, связанного с участником, запросом на вступление или удалением.
`initiatedBy`	string	Нет	Указывает, кто инициировал событие удаления участника. Значения: `business`, `participant`.
`joinRequestId`	string	Нет	Идентификатор запроса на вступление.
`waId`	string	Нет	Идентификатор пользователя WhatsApp для одиночного события участника.
`recipientUserId`	string	Нет	Идентификатор пользователя в рамках компании (Business-scoped user ID) для одиночного события участника.
`parentRecipientUserId`	string	Нет	Идентификатор пользователя в рамках родительской компании (Parent business-scoped user ID) для одиночного события участника.
`customerProfile`	object	Нет	Данные профиля клиента в WhatsApp.
`subject`	string	Нет	Тема группы.
`description`	string	Нет	Описание группы.
`joinApprovalMode`	string	Нет	Режим одобрения вступления в группу WhatsApp. `approval_required`: новые участники должны быть одобрены перед вступлением. `auto_approve`: новые участники могут вступать без одобрения.
`addedParticipants`	object[]	Нет	Участники, добавленные в группу.
`removedParticipants`	object[]	Нет	Участники, удаленные из группы.
`failedParticipants`	object[]	Нет	Участники, которых не удалось добавить или удалить.
`settings`	object[]	Нет	Сведения об изменении настроек группы.
`errors`	object[]	Нет	Ошибки, возвращенные WhatsApp.
`contacts`	object[]	Нет	Контакты, включенные в вебхуки статуса групповых сообщений.
`statuses`	object[]	Нет	Сведения о статусе группового сообщения.
`webhookTime`	string (date-time)	Нет	Время, когда WhatsApp инициировал этот вебхук.
`dedupeKey`	string	Нет	Ключ идемпотентности для дедупликации событий вебхука группы.

whatsappGroup.customerProfile

Параметр	Тип	Обязательный	Описание
`name`	string	Нет	Имя профиля WhatsApp.
`username`	string	Нет	Имя пользователя WhatsApp.

whatsappGroup.addedParticipants[]

Параметр	Тип	Обязательный	Описание
`input`	string	Нет	Исходные введенные данные участника.
`waId`	string	Нет	Идентификатор пользователя WhatsApp.
`recipientUserId`	string	Нет	Идентификатор пользователя в рамках компании (Business-scoped user ID).
`parentRecipientUserId`	string	Нет	Идентификатор пользователя в рамках родительской компании (Parent business-scoped user ID).
`customerProfile`	object	Нет	Данные профиля клиента в WhatsApp.
`errors`	object[]	Нет	Ошибки, возвращенные WhatsApp для этого участника.

whatsappGroup.addedParticipants[].customerProfile

Параметр	Тип	Обязательный	Описание
`name`	string	Нет	Имя профиля WhatsApp.
`username`	string	Нет	Имя пользователя WhatsApp.

whatsappGroup.removedParticipants[]

Параметр	Тип	Обязательный	Описание
`input`	string	Нет	Исходные введенные данные участника.
`waId`	string	Нет	Идентификатор пользователя WhatsApp.
`recipientUserId`	string	Нет	Идентификатор пользователя в рамках компании (Business-scoped user ID).
`parentRecipientUserId`	string	Нет	Идентификатор пользователя в рамках родительской компании (Parent business-scoped user ID).
`customerProfile`	object	Нет	Сведения о профиле клиента WhatsApp.
`errors`	object[]	Нет	Ошибки, возвращенные WhatsApp для этого участника.

whatsappGroup.removedParticipants[].customerProfile

Параметр	Тип	Обязательный	Описание
`name`	string	Нет	Имя профиля WhatsApp.
`username`	string	Нет	Имя пользователя WhatsApp.

whatsappGroup.failedParticipants[]

Параметр	Тип	Обязательный	Описание
`input`	string	Нет	Исходные введенные данные участника.
`waId`	string	Нет	Идентификатор пользователя WhatsApp.
`recipientUserId`	string	Нет	Идентификатор пользователя в рамках компании (Business-scoped user ID).
`parentRecipientUserId`	string	Нет	Идентификатор пользователя в рамках родительской компании (Parent business-scoped user ID).
`customerProfile`	object	Нет	Сведения о профиле клиента WhatsApp.
`errors`	object[]	Нет	Ошибки, возвращенные WhatsApp для этого участника.

whatsappGroup.failedParticipants[].customerProfile

Параметр	Тип	Обязательный	Описание
`name`	string	Нет	Имя профиля WhatsApp.
`username`	string	Нет	Имя пользователя WhatsApp.

whatsappGroup.settings[]

Параметр	Тип	Обязательный	Описание
`name`	string	Нет	Имя настройки. Значения: `profile_picture`, `group_subject`, `group_description`.
`text`	string	Нет	Текстовое значение для обновления темы или описания.
`updateSuccessful`	boolean	Нет	Указывает, успешно ли обновлена настройка.
`mimeType`	string	Нет	MIME-тип для обновлений изображения профиля.
`sha256`	string	Нет	Хэш SHA-256 для обновлений изображения профиля.
`errors`	object[]	Нет	Ошибки, возвращенные WhatsApp для этой настройки.

whatsappGroup.contacts[]

Параметр	Тип	Обязательный	Описание
`customerProfile`	object	Нет	Сведения о профиле клиента WhatsApp.
`waId`	string	Нет	Идентификатор пользователя WhatsApp.
`recipientUserId`	string	Нет	Идентификатор пользователя в рамках компании (Business-scoped user ID).
`parentRecipientUserId`	string	Нет	Идентификатор пользователя в рамках родительской компании (Parent business-scoped user ID).

whatsappGroup.contacts[].customerProfile

Параметр	Тип	Обязательный	Описание
`name`	string	Нет	Имя профиля WhatsApp.
`username`	string	Нет	Имя пользователя WhatsApp.

whatsappGroup.statuses[]

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	ID сообщения WhatsApp.
`status`	string	Нет	Статус сообщения. Значения: `sent`, `delivered`, `read`, `failed`, `expired`.
`timestamp`	integer (int64)	Нет	Временная метка Unix, указывающая, когда был обновлен статус сообщения.
`recipientId`	string	Нет	ID группы-получателя.
`recipientType`	string	Нет	Тип получателя. Значения: `group`.
`recipientParticipantId`	string	Нет	WhatsApp user ID участника-получателя.
`recipientUserId`	string	Нет	Business-scoped user ID участника-получателя.
`parentRecipientUserId`	string	Нет	Parent business-scoped user ID участника-получателя.
`conversation`	object	Нет	Объект переписки WhatsApp, включенный в вебхуки статуса групповых сообщений.
`pricing`	object	Нет	Информация о тарификации, включенная в вебхуки статуса групповых сообщений.
`errors`	object[]	Нет	Ошибки, возвращенные WhatsApp.

whatsappGroup.statuses[].conversation

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	ID переписки.
`expirationTimestamp`	integer (int64)	Нет	Временная метка Unix, указывающая, когда истекает срок действия переписки.
`origin`	object	Нет	Поля объекта перечислены ниже.

whatsappGroup.statuses[].conversation.origin

Параметр	Тип	Обязательный	Описание
`type`	string	Нет	Тип источника переписки.

whatsappGroup.statuses[].pricing

Параметр	Тип	Обязательный	Описание
`billable`	boolean	Нет	Подлежит ли сообщение тарификации.
`pricingModel`	string	Нет	Модель ценообразования.
`type`	string	Нет	Тип тарификации.
`category`	string	Нет	Исходная категория тарификации группы, переданная Meta. YCloud не раскрывает внутреннее сопоставление MM Lite в этом поле вебхука. Значения: `group_marketing`, `group_utility`, `group_service`.

Пример

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

Событие обновления жизненного цикла группы WhatsApp

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

{
  "id": "evt_group_lifecycle_123",
  "type": "whatsapp.group.lifecycle_update",
  "apiVersion": "v2",
  "createTime": "2026-05-13T00:00:00.000Z",
  "whatsappGroup": {
    "wabaId": "123456789012345",
    "displayPhoneNumber": "16315551111",
    "phoneNumberId": "1234567890123456",
    "field": "group_lifecycle_update",
    "type": "group_create",
    "requestId": "REQ_1",
    "status": "created",
    "groupId": "120363345678901234@g.us",
    "inviteLink": "https://chat.whatsapp.com/AbCdEfGhIjK",
    "subject": "New Purchase Inquiry",
    "description": "Group for purchase inquiries.",
    "joinApprovalMode": "auto_approve",
    "webhookTime": "2026-05-13T00:00:00.000Z",
    "dedupeKey": "123456789012345|REQ_1|group_lifecycle_update|group_create|created"
  }
}

Группа создана

{
  "id": "evt_group_lifecycle_123",
  "type": "whatsapp.group.lifecycle_update",
  "apiVersion": "v2",
  "createTime": "2026-05-13T00:00:00.000Z",
  "whatsappGroup": {
    "wabaId": "123456789012345",
    "displayPhoneNumber": "16315551111",
    "phoneNumberId": "1234567890123456",
    "field": "group_lifecycle_update",
    "type": "group_create",
    "requestId": "REQ_1",
    "status": "created",
    "groupId": "Y2FwaV9ncm91cDpFWEFNUExFX0dST1VQX0lE",
    "inviteLink": "https://chat.whatsapp.com/AbCdEfGhIjK",
    "subject": "New Purchase Inquiry",
    "description": "Group for purchase inquiries.",
    "joinApprovalMode": "auto_approve",
    "webhookTime": "2026-05-13T00:00:00.000Z",
    "dedupeKey": "123456789012345|REQ_1|group_lifecycle_update|group_create|created"
  }
}

Группа удалена

{
  "id": "evt_group_lifecycle_124",
  "type": "whatsapp.group.lifecycle_update",
  "apiVersion": "v2",
  "createTime": "2026-05-13T00:00:00.000Z",
  "whatsappGroup": {
    "wabaId": "123456789012345",
    "field": "group_lifecycle_update",
    "type": "group_delete",
    "requestId": "REQ_DELETE",
    "status": "deleted",
    "groupId": "Y2FwaV9ncm91cDpFWEFNUExFX0dST1VQX0lE",
    "webhookTime": "2026-05-13T00:00:00.000Z"
  }
}

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

HTTP/1.1 200 OK

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

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

Руководства

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

Webhook reference

whatsapp.group.lifecycle_update

Триггеры

Синтаксис

Параметры

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

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

whatsappGroup

Пример

​Триггеры

​Синтаксис

​Параметры

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

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

​whatsappGroup

​Пример

Триггеры

Синтаксис

Параметры

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

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

whatsappGroup

Пример