Входящее сообщение с контактом#

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

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

typeWebhook = incomingMessageReceived

messageData.typeMessage = contactMessage

Настройка инстанса

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

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

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

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

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

Параметр	Тип	Описание
`typeMessage`	string	Тип принятого сообщения. Для сообщений данного типа поле принимает значение `contactMessage`
`contactMessageData`	object	Объект данных о принятом контакте.
`quotedMessage`	object	Объект данных о цитируемом сообщении. Присутствует только, если само сообщение является цитатой

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

Параметр	Тип	Описание
`displayName`	string	Отображаемое имя контакта
`vcard`	string	Структура VCard (визитной карточки контакта)
`isForwarded`	boolean	Является ли сообщение пересланным, принимает значения `true`/`false`
`forwardingScore`	integer	Количество пересылок сообщения

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

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

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

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

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1101111111,
    "wid": "79876543210@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1588091580,
  "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
  "senderData": {
    "chatId": "79001234567@c.us",
    "sender": "79001234567@c.us",
      "chatName": "Иван",
    "senderName": "Иван",
    "senderContactName": "Иван Царевич"
  },
  "messageData": {
    "typeMessage": "contactMessage",
    "contactMessageData": {
      "displayName": "Кощей бессмертный",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Андреевич;Виктор;;;\nFN:Кощей бессмертный\nORG:Image\nTITLE:\nitem1.TEL;waid=79001234567:+7 900 123-45-69\nitem1.X-ABLabel:Мобильный\nEND:VCARD",
        "forwardingScore": 4,
      "isForwarded": true
    }
  }
}

Пример тела сообщения с контактом из группового чата#

{
    "typeWebhook": "incomingMessageReceived",
    "instanceData": {
        "idInstance": 1101111111,
        "wid": "79876543210@c.us",
        "typeInstance": "whatsapp"
    },
    "timestamp": 1732268220,
    "idMessage": "2D9D6721A977D369246509EBE0CE44CA",
    "senderData": {
      "chatId": "120363369140947676@g.us",
        "chatName": "Группа",
        "sender": "79001234567@c.us",
        "senderName": "Иван",
        "senderContactName": "Иван Царевич"
  },
  "messageData": {
    "typeMessage": "contactMessage",
    "contactMessageData": {
      "displayName": "Кощей бессмертный",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Андреевич;Виктор;;;\nFN:Кощей бессмертный\nORG:Image\nTITLE:\nitem1.TEL;waid=79001234567:+7 900 123-45-69\nitem1.X-ABLabel:Мобильный\nEND:VCARD",
        "forwardingScore": 4,
      "isForwarded": true
    }
  }
}

Пример тела уведомления входящего сообщения с контактом и цитатой текстового сообщения#

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1101111111,
    "wid": "79876543210@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1588091580,
  "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
  "senderData": {
    "chatId": "79001234567@c.us",
    "sender": "79001234567@c.us",
      "chatName": "Иван",
    "senderName": "Иван",
    "senderContactName": "Иван Царевич"
  },
  "messageData": {
    "typeMessage": "contactMessage",
    "contactMessageData": {
      "displayName": "Антиспам",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:;Антиспам;;;\nFN:Антиспам\nitem1.TEL:*9035936232#\nitem1.X-ABLabel:Мобильный\nEND:VCARD",
      "forwardingScore": 4,
      "isForwarded": true
    },
    "quotedMessage": {
      "stanzaId": "46618B98B3B9DF50F123456789123456",
      "participant": "79001234567@c.us",
      "typeMessage": "textMessage",
      "textMessage": "Привет"
    }
  }
}

Пример тела уведомления входящего сообщения с контактом и цитатой аудио/видео/документ#

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1101111111,
    "wid": "79876543210@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1588091580,
  "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
  "senderData": {
    "chatId": "79001234567@c.us",
    "sender": "79001234567@c.us",
      "chatName": "Иван",
    "senderName": "Иван",
    "senderContactName": "Иван Царевич"
  },
  "messageData": {
    "typeMessage": "contactMessage",
    "contactMessageData": {
          "displayName": "Антиспам",
          "vcard": "BEGIN:VCARD\nVERSION:3.0\nFN:2 Лена\nitem1.TEL;waid=79001230000\nitem1.X-ABLabel:Мобильный\nEND:VCARD",
              "forwardingScore": 4,
          "isForwarded": true
    }
    },
    "quotedMessage": {
         "stanzaId": "46618B98B3B9DF50F123456789123456",
         "participant": "79876543210@c.us",
         "typeMessage": "imageMessage",
         "downloadUrl": "",
         "caption": "",
         "jpegThumbnail": ""
    }
  }

Пример тела уведомления входящего сообщения с контактом и цитатой контакта#

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1101111111,
    "wid": "79876543210@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1588091580,
  "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
  "senderData": {
    "chatId": "79001234567@c.us",
    "sender": "79001234567@c.us",
      "chatName": "Иван",
    "senderName": "Иван",
    "senderContactName": "Иван Царевич"
  },
  "messageData": {
    "typeMessage": "contactMessage",
    "contactMessageData": {
      "displayName": "",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Фонд;\nitem1.TEL;waid=79001203030:/em1.X-ABLabel:Новый тип\nEND:VCARD",
        "forwardingScore": 4,
      "isForwarded": true
    },
    "quotedMessage": {
      "stanzaId": "46618B98B3B9DF50F123456789123456",
      "participant": "79876543210@c.us",
      "typeMessage": "contactMessage",
      "contact": {
        "displayName": "Green-Api",
        "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Green-Api\nitem1.TEL;waid=79001230000\nitem1.X-ABLabel:Мобильный\nEND:VCARD"
      }
    }
  }
}

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

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1101111111,
    "wid": "79876543210@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1588091580,
  "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
  "senderData": {
    "chatId": "79001234567@c.us",
    "sender": "79001234567@c.us",
      "chatName": "Иван",
    "senderName": "Иван",
    "senderContactName": "Иван Царевич"
  },
  "messageData": {
    "typeMessage": "contactMessage",
    "contactMessageData": {
      "displayName": "Фонд",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nFN:2 Сердца\nitem1.TEL;waid=79200000102\nitem1.X-ABLabel:Новый тип\nEND:VCARD",
        "forwardingScore": 4,
      "isForwarded": true
    },
    "quotedMessage": {
      "stanzaId": "46618B98B3B9DF50F123456789123456",
      "participant": "79001234567@c.us",
      "typeMessage": "locationMessage",
      "location": {
        "nameLocation": "",
        "address": "",
        "jpegThumbnail": "",
        "latitude": 72.5922702,
        "longitude": 45.6645388
      }
    }
  }
}