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

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

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

typeWebhook = incomingMessageReceived

messageData.typeMessage = contactMessage

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

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

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

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

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

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

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

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

Параметр	Тип	Описание
`phoneContact`	string	Номер контакта
`firstName`	string	Имя контакта
`lastName`	string	Фамилия контакта
`vcard`	string	Дополнительные данные
`chatId`	string	Идентификатор чата
`forwardingScore`	integer	Количество пересылок сообщения
`isForwarded`	boolean	Флаг пересланного соообщения `true`/`false`

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

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

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
      "idInstance": 4100000000,
      "wid": "79876543210@c.us",
      "typeInstance": "tgm"
  },
  "timestamp": 1763115112,
  "idMessage": "1763115112345",
  "senderData": {
      "chatId": "10000000",
      "sender": "10000000",
      "chatName": "Василиса Премудрая",
      "senderName": "Василиса Премудрая",
      "senderContactName": "Василиса Премудрая",
      "senderPhoneNumber": 79991112233
  },
  "messageData": {
    "typeMessage": "contactMessage",
    "contactMessageData": {
        "chatId": "10000001",
        "phoneNumber": "79876543210",
        "displayName": "Иван",
        "vcard": "",
        "forwardingScore": 0,
        "isForwarded": false
    }
  }
}

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

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
      "idInstance": 4100000000,
      "wid": "79876543210@c.us",
      "typeInstance": "tgm"
  },
  "timestamp": 1763115112,
  "idMessage": "1763468266381",
  "senderData": {
      "chatId": "-10000000000000",
      "sender": "10000000",
      "chatName": "Тридесятое царство",
      "senderName": "Василиса",
      "senderContactName": "",
      "senderPhoneNumber": 0
  },
  "messageData": {
    "typeMessage": "contactMessage",
    "contactMessageData": {
        "chatId": "10000001",
        "phoneNumber": "79876543210",
        "displayName": "Иван",
        "vcard": "",
        "forwardingScore": 0,
        "isForwarded": false
    }
  }
}