Перейти к содержанию

Входящее сообщение с приглашением в группу#

В данном разделе описывается формат входящего уведомления объекта messageData для входящего сообщения приглашения в группу. Для получения описания общего формата входящих уведомлений обратитесь к разделу Входящие сообщения.

Для получения входящих уведомлений данного вида требуется выполнение двух условий:

typeWebhook = incomingMessageReceived

messageData.typeMessage = groupInviteMessage

Условия получения уведомления типа groupInviteMessage

Чтобы получать входящие уведомления о приглашении в группу, необходимо включить настройки одним из представленных вариантов:

  1. Через личный кабинет включить настройки Получать уведомления о входящих сообщениях и файлах

  2. Через метод SetSettings включить настройки incomingWebhook

Условия получения уведомления типа groupInviteMessage:
- номер телефона отправителя сохранён у получателя в контактах;
- номер телефона получателя не сохранён у отправителя в контактах;
- у получателя в настройках конфиденциальности возможность отправлять приглашения в группу настроена только для контактов.

Для отправки приглашения в новую группу необходимо:

  1. Создать группу WhatsApp с номером получателя
  2. Вы получаете уведомление "Не удалось добавить номер <...>. Вы можете пригласить контакт в группу лично"
  3. Выбрать "Пригласить в группу" в данном уведомлении.

Для отправки приглашения в существующую группу:

  1. Зайти в существующую группу, открыть "данные группы", выбрать "добавить участников", выбрать получателя уведомления
  2. Вы получаете уведомление "Не удалось добавить номер <...>. Вы можете пригласить контакт в группу лично"
  3. Выбрать "Пригласить в группу" в данном уведомлении.

Таким образом получателю придёт приглашение в группу и уведомление groupInviteMessage на связанный инстанс.

Ссылки на приглашение в группу не являются сообщениями с типом groupInviteMessage.

Получение данного типа уведомления возможно, только при отправке приглашения через устройство. Отправка данного приглашения через API невозможна.

Уведомление#

Формат уведомления#

Поля объекта messageData

Параметр Тип Описание
typeMessage string Тип принятого сообщения. Для сообщений данного типа поле принимает значение: groupInviteMessage
groupInviteMessageData object Объект данных о принятом сообщении приглашении в группу
quotedMessage object Объект данных о цитируемом сообщении.

Поля объекта groupInviteMessageData

Параметр Тип Описание
groupJid string chatId Группы
inviteCode string Код приглашения
inviteExpiration string Срок действия приглашения
groupName string Название группы
caption string Описание сообщения
name string Поле устарело, оставлено для обратной совместимости
jpegThumbnail string Предпросмотр изображения в base64

Поля объекта quotedMessage

Параметр Тип Описание
stanzaId string id цитируемого сообщения
participant string id отправителя цитируемого сообщения
typeMessage string Тип цитируемого сообщения

Остальные поля заполняются в зависимости от типа цитируемого сообщения и идентичны полям входящих сообщений описанных в разделе Входящие сообщения

Пример тела уведомления#

  {
      "typeWebhook": "incomingMessageReceived",
      "instanceData": {
        "idInstance": 1101300213,
        "wid": "70000000012@c.us",
        "typeInstance": "whatsapp"
      },
      "timestamp": 1771411296,
      "idMessage": "3AAF7CA72BE1515FCCAF",
      "senderData": {
        "chatId": "70000000012@c.us",
        "chatName": "Иван",
        "sender": "70000000012@c.us",
        "senderName": "Иван",
        "senderContactName": ""
      },
      "messageData": {
        "typeMessage": "groupInviteMessage",
        "groupInviteMessageData": {
          "groupJid": "1234567806447435313@g.us",
          "inviteCode": "AAAAAAAAaaaaaaaa",
          "inviteExpiration": "1771670453",
          "groupName": "Тридесятое царство",
          "caption": "Приглашение в мою группу WhatsApp",
          "jpegThumbnail": "/9j... AAAAgABQESAAMAAAA"
        }
      }
    }