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

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

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

typeWebhook = incomingMessageReceived

messageData.typeMessage = contactsArrayMessage

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

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

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

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

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

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

Параметр	Тип	Описание
`typeMessage`	string	Тип принятого сообщения. Для сообщений данного типа поле принимает значение `contactsArrayMessage`
`contacts`	object	Объект массива данных о принятых контактах.
`quotedMessage`	object	Объект данных о цитируемом сообщении. Присутствует только, если само сообщение является цитатой
`isForwarded`	boolean	Является ли сообщение пересланным, принимает значения true/false
`forwardingScore`	integer	Количество пересылок сообщения

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

Параметр	Тип	Описание
`displayName`	string	Отображаемое имя контакта
`vcard`	string	Структура VCard (визитной карточки контакта)

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

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

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

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

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1234,
    "wid": "11001234567@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1683145380,
  "idMessage": "9AF4BAC8AA780DD588B0655C247F822D",
  "senderData": {
    "chatId": "79001234568@c.us",
    "chatName": "Иван",
    "sender": "79001234568@c.us",
    "senderName": "Иван",
    "senderContactName": "Иван Васильевич"
  },
  "messageData": {
    "typeMessage": "contactsArrayMessage",
    "messageData": {
      "contacts": [
        {
          "displayName": "Виктор Андреевич",
          "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Андреевич;Виктор;;;\nFN:Виктор Андреевич\nitem1.TEL;waid=79001234567:+7 900 123-45-67\nitem1.X-ABLabel:Мобильный\nEND:VCARD"
        },
        {
          "displayName": "Олег Едросович",
          "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Едросович;Олег;;;\nFN:Олег Едросович\nitem1.TEL;waid=79001234567:+7 900 123-45-67\nitem1.X-ABLabel:Мобильный\nEND:VCARD"
        }
      ],
      "forwardingScore": 0,
      "isForwarded": false
    }
  }
}

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

{
    "typeWebhook": "incomingMessageReceived",
    "instanceData": {
        "idInstance": 1234,
        "wid": "11001234567@c.us",
        "typeInstance": "whatsapp"
    },
    "timestamp": 1732268220,
    "idMessage": "2D9D6721A977D369246509EBE0CE44CA",
    "senderData": {
      "chatId": "120363369140947676@g.us",
        "chatName": "Группа",
        "sender": "79001234568@c.us",
        "senderName": "Иван",
        "senderContactName": "Иван Васильевич"
  },
  "messageData": {
    "typeMessage": "contactsArrayMessage",
    "messageData": {
      "contacts": [
        {
          "displayName": "Виктор Андреевич",
          "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Андреевич;Виктор;;;\nFN:Виктор Андреевич\nitem1.TEL;waid=79001234567:+7 900 123-45-67\nitem1.X-ABLabel:Мобильный\nEND:VCARD"
        },
        {
          "displayName": "Олег Едросович",
          "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Едросович;Олег;;;\nFN:Олег Едросович\nitem1.TEL;waid=79001234567:+7 900 123-45-67\nitem1.X-ABLabel:Мобильный\nEND:VCARD"
        }
      ],
      "forwardingScore": 0,
      "isForwarded": false
    }
  }
}

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

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1234,
    "wid": "11001234567@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1683145380,
  "idMessage": "9AF4BAC8AA780DD588B0655C247F822D",
  "senderData": {
    "chatId": "79001234568@c.us",
    "chatName": "Иван",
    "sender": "79001234568@c.us",
    "senderName": "Иван",
    "senderContactName": "Иван Васильевич"
  },
  "messageData": {
    "typeMessage": "contactsArrayMessage",
    "messageData": {
      "contacts": [
        {
          "displayName": "Виктор Андреевич",
          "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Андреевич;Виктор;;;\nFN:Виктор Андреевич\nitem1.TEL;waid=79001234567:+7 900 123-45-67\nitem1.X-ABLabel:Мобильный\nEND:VCARD"
        },
        {
          "displayName": "Олег Едросович",
          "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Едросович;Олег;;;\nFN:Олег Едросович\nitem1.TEL;waid=79001234567:+7 900 123-45-67\nitem1.X-ABLabel:Мобильный\nEND:VCARD"
        }
      ],
      "forwardingScore": 0,
      "isForwarded": false
    },
    "quotedMessage": {
      "stanzaId": "3AA3BE1C2DFB5BBCC315",
      "participant": "79001234567@c.us",
      "typeMessage": "textMessage",
      "textMessage": "Текст"
    }
  }
}

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

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1234,
    "wid": "11001234567@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1683145380,
  "idMessage": "9AF4BAC8AA780DD588B0655C247F822D",
  "senderData": {
    "chatId": "79001234568@c.us",
    "chatName": "Иван",
    "sender": "79001234568@c.us",
    "senderName": "Иван",
    "senderContactName": "Иван Васильевич"
  },
  "messageData": {
    "typeMessage": "contactsArrayMessage",
    "messageData": {
      "contacts": [
        {
          "displayName": "Виктор Андреевич",
          "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Андреевич;Виктор;;;\nFN:Виктор Андреевич\nitem1.TEL;waid=79001234567:+7 900 123-45-67\nitem1.X-ABLabel:Мобильный\nEND:VCARD"
        },
        {
          "displayName": "Олег Едросович",
          "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Едросович;Олег;;;\nFN:Олег Едросович\nitem1.TEL;waid=79001234567:+7 900 123-45-67\nitem1.X-ABLabel:Мобильный\nEND:VCARD"
        }
      ],
      "forwardingScore": 0,
      "isForwarded": false
    },
    "quotedMessage": {
      "stanzaId": "5E956DF0AC8ED6873FEF",
      "participant": "79001234567@c.us",
      "typeMessage": "imageMessage",
      "downloadUrl": "",
      "caption": "",
      "fileName": "",
      "jpegThumbnail": "/9j/4AAQSkZJRgA"
    }
  }
}

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

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1234,
    "wid": "11001234567@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1683145380,
  "idMessage": "9AF4BAC8AA780DD588B0655C247F822D",
  "senderData": {
    "chatId": "79001234568@c.us",
    "chatName": "Иван",
    "sender": "79001234568@c.us",
    "senderName": "Иван",
    "senderContactName": "Иван Васильевич"
  },
  "messageData": {
    "typeMessage": "contactsArrayMessage",
    "messageData": {
      "contacts": [
        {
          "displayName": "Виктор Андреевич",
          "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Андреевич;Виктор;;;\nFN:Виктор Андреевич\nitem1.TEL;waid=79001234567:+7 900 123-45-67\nitem1.X-ABLabel:Мобильный\nEND:VCARD"
        },
        {
          "displayName": "Олег Едросович",
          "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Едросович;Олег;;;\nFN:Олег Едросович\nitem1.TEL;waid=79001234567:+7 900 123-45-67\nitem1.X-ABLabel:Мобильный\nEND:VCARD"
        }
      ],
      "forwardingScore": 0,
      "isForwarded": false
    },
    "quotedMessage": {
      "stanzaId": "3AC28E97DA5CA6A31723",
      "participant": "79001234567@c.us",
      "typeMessage": "contactMessage",
      "contact": {
        "displayName": "Green-API",
        "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:;И;;;\nFN:Green-API\nX-WA-BIZ-NAME:\nX-WA-BIZ-DESCRIPTION:\nTEL;type=CELL;type=VOICE;waid=79580000000:+7 958 000-00-00\nEND:VCARD"
      }
    }
  }
}

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

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1234,
    "wid": "11001234567@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1683145380,
  "idMessage": "9AF4BAC8AA780DD588B0655C247F822D",
  "senderData": {
    "chatId": "79001234568@c.us",
    "chatName": "Иван",
    "sender": "79001234568@c.us",
    "senderName": "Иван",
    "senderContactName": "Иван Васильевич"
  },
  "messageData": {
    "typeMessage": "contactsArrayMessage",
    "messageData": {
      "contacts": [
        {
          "displayName": "Виктор Андреевич",
          "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Андреевич;Виктор;;;\nFN:Виктор Андреевич\nitem1.TEL;waid=79001234567:+7 900 123-45-67\nitem1.X-ABLabel:Мобильный\nEND:VCARD"
        },
        {
          "displayName": "Олег Едросович",
          "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Едросович;Олег;;;\nFN:Олег Едросович\nitem1.TEL;waid=79001234567:+7 900 123-45-67\nitem1.X-ABLabel:Мобильный\nEND:VCARD"
        }
      ],
      "forwardingScore": 0,
      "isForwarded": false
    },
    "quotedMessage": {
      "stanzaId": "3A5473EE888EEE52BC20",
      "participant": "79001234567@c.us",
      "typeMessage": "locationMessage",
      "location": {
        "nameLocation": "place",
        "address": "",
        "jpegThumbnail": "",
        "latitude": 52.58900290649414,
        "longitude": 39.659369010253906
      }
    }
  }
}