whatsapp.group.settings_update

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

Триггеры

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

Синтаксис

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

{
  "id": "<ID>",
  "type": "whatsapp.group.settings_update",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "whatsappGroup": {
    "wabaId": "<WABA_ID>",
    "field": "<FIELD>",
    "type": "<TYPE>",
    "requestId": "<REQUEST_ID>",
    "status": "<STATUS>",
    "groupId": "<GROUP_ID>",
    "subject": "<SUBJECT>",
    "description": "<DESCRIPTION>",
    "settings": [
      {
        "name": "<NAME>",
        "text": "<TEXT>",
        "updateSuccessful": "<UPDATE_SUCCESSFUL_VALUE>"
      }
    ],
    "webhookTime": "<WEBHOOK_TIME>"
  }
}

Параметры

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

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

Параметр	Тип	Обязательный	Описание
`id`	string	Да	Уникальный идентификатор события. Минимальная длина: `6`. Максимальная длина: `128`.
`type`	string	Да	Всегда `whatsapp.group.settings_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[]	Нет	Контакты, включенные в webhook статуса групповых сообщений.
`statuses`	object[]	Нет	Сведения о статусе группового сообщения.
`webhookTime`	string (date-time)	Нет	Время, когда WhatsApp инициировал этот Webhook.
`dedupeKey`	string	Нет	Ключ идемпотентности для дедупликации событий Webhook группы.

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	Нет	Родительский business-scoped user ID участника-получателя.
`conversation`	object	Нет	Объект переписки WhatsApp, включенный в webhook-события статуса групповых сообщений.
`pricing`	object	Нет	Тарификационная информация, включенная в webhook-события статуса групповых сообщений.
`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 в этом поле webhook. Значения: `group_marketing`, `group_utility`, `group_service`.

Пример

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

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

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

{
  "id": "evt_group_settings_123",
  "type": "whatsapp.group.settings_update",
  "apiVersion": "v2",
  "createTime": "2026-05-13T00:00:00.000Z",
  "whatsappGroup": {
    "wabaId": "123456789012345",
    "field": "group_settings_update",
    "type": "group_settings_update",
    "requestId": "REQ_2",
    "status": "updated",
    "groupId": "120363345678901234@g.us",
    "subject": "Updated Purchase Inquiry",
    "description": "Updated group description.",
    "settings": [
      {
        "name": "group_subject",
        "text": "Updated Purchase Inquiry",
        "updateSuccessful": true
      },
      {
        "name": "group_description",
        "text": "Updated group description.",
        "updateSuccessful": true
      }
    ],
    "webhookTime": "2026-05-13T00:00:00.000Z"
  }
}

Настройки обновлены

{
  "id": "evt_group_settings_123",
  "type": "whatsapp.group.settings_update",
  "apiVersion": "v2",
  "createTime": "2026-05-13T00:00:00.000Z",
  "whatsappGroup": {
    "wabaId": "123456789012345",
    "field": "group_settings_update",
    "type": "group_settings_update",
    "requestId": "REQ_2",
    "status": "updated",
    "groupId": "Y2FwaV9ncm91cDpFWEFNUExFX0dST1VQX0lE",
    "subject": "Updated Purchase Inquiry",
    "description": "Updated group description.",
    "settings": [
      {
        "name": "group_subject",
        "text": "Updated Purchase Inquiry",
        "updateSuccessful": true
      },
      {
        "name": "group_description",
        "text": "Updated group description.",
        "updateSuccessful": true
      }
    ],
    "webhookTime": "2026-05-13T00:00:00.000Z"
  }
}

Не удалось обновить настройки

{
  "id": "evt_group_settings_124",
  "type": "whatsapp.group.settings_update",
  "apiVersion": "v2",
  "createTime": "2026-05-13T00:00:00.000Z",
  "whatsappGroup": {
    "wabaId": "123456789012345",
    "field": "group_settings_update",
    "type": "group_settings_update",
    "requestId": "REQ_SETTINGS",
    "status": "failed",
    "groupId": "Y2FwaV9ncm91cDpFWEFNUExFX0dST1VQX0lE",
    "subject": "New subject",
    "settings": [
      {
        "name": "group_subject",
        "text": "New subject",
        "updateSuccessful": false,
        "errors": [
          {
            "code": 131201,
            "title": "Invalid group subject"
          }
        ]
      }
    ],
    "webhookTime": "2026-05-13T00:00:00.000Z"
  }
}

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

HTTP/1.1 200 OK

Разбор сценариев см. в примерах с пояснениями.

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

Руководства

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

Webhook reference

whatsapp.group.settings_update

Триггеры

Синтаксис

Параметры

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

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

whatsappGroup

Пример

​Триггеры

​Синтаксис

​Параметры

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

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

​whatsappGroup

​Пример

Триггеры

Синтаксис

Параметры

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

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

whatsappGroup

Пример