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

Отправленное сообщение с контактом#

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

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

typeWebhook = outgoingMessageReceived || outgoingAPIMessageReceived

messageData.typeMessage = contactMessage

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

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

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

  2. Через метод SetSettings включить настройки outgoingMessageWebhook и outgoingAPIMessageWebhook
    (дополнительно outgoingWebhook для получения уведомлений о статусах отправленного сообщения)

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

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

Поля объекта 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": "outgoingMessageReceived",
  "instanceData": {
    "idInstance": 1101111111,
    "wid": "79876543210@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1742187319,
  "idMessage": "BAE5A9813CF792DB",
  "senderData": {
    "chatId": "79001234567@c.us",
    "chatName": "Игорь",
    "sender": "79876543210@c.us",
    "senderName": "Иван",
    "senderContactName": "Иван Царевич"
  },
  "messageData": {
    "typeMessage": "contactMessage",
    "contactMessageData": {
      "displayName": "Кощей",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Бессмертный;Кощей;\nFN:Кощей Бессмертный\nTEL;type=CELL;type=VOICE;waid=79876543210:+79876543210\nEND:VCARD",
      "forwardingScore": 0,
      "isForwarded": false
    }
  }
}

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

{
    "typeWebhook": "outgoingAPIMessageReceived",
    "instanceData": {
        "idInstance": 1101111111,
        "wid": "79876543210@c.us",
        "typeInstance": "whatsapp"
    },
    "timestamp": 1732268220,
    "idMessage": "2D9D6721A977D369246509EBE0CE44CA",
    "senderData": {
      "chatId": "120363369140947676@g.us",
        "chatName": "Группа",
        "sender": "79876543210@c.us",
        "senderName": "Иван",
        "senderContactName": "Иван Царевич"
  },
  "messageData": {
    "typeMessage": "contactMessage",
    "contactMessageData": {
      "displayName": "Кощей",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Бессмертный;Кощей;\nFN:Кощей Бессмертный\nTEL;type=CELL;type=VOICE;waid=79876543210:+79876543210\nEND:VCARD",
        "forwardingScore": 0,
      "isForwarded": false
    }
  }
}

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

{
  "typeWebhook": "outgoingAPIMessageReceived",
  "instanceData": {
    "idInstance": 1101111111,
    "wid": "79876543210@c.us",
    "typeInstance": "whatsapp"
  },
    "timestamp": 1732268220,
    "idMessage": "2D9D6721A977D369246509EBE0CE44CA",
    "senderData": {
      "chatId": "120363369140947676@g.us",
        "chatName": "Группа",
        "sender": "79876543210@c.us",
        "senderName": "Иван",
        "senderContactName": "Иван Царевич"
  },
  "messageData": {
    "typeMessage": "contactMessage",
    "contactMessageData": {
      "displayName": "Кощей",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Бессмертный;Кощей;\nFN:Кощей Бессмертный\nTEL;type=CELL;type=VOICE;waid=79876543210:+79876543210\nEND:VCARD",
      "forwardingScore": 0,
      "isForwarded": false
    },
    "quotedMessage": {
      "stanzaId": "BAE5E1EA79D67CF7",
      "participant": "79876543210@c.us",
      "typeMessage": "extendedTextMessage",
      "textMessage": "текст",
      "extendedTextMessage": {
        "text": "текст",
        "description": "",
        "title": "",
        "previewType": "None",
        "jpegThumbnail": "",
        "forwardingScore": 0,
        "isForwarded": false
      }
    }
  }
}

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

{
  "typeWebhook": "outgoingAPIMessageReceived",
  "instanceData": {
    "idInstance": 1101111111,
    "wid": "79876543210@c.us",
    "typeInstance": "whatsapp"
  },
    "timestamp": 1732268220,
    "idMessage": "2D9D6721A977D369246509EBE0CE44CA",
    "senderData": {
      "chatId": "120363369140947676@g.us",
        "chatName": "Группа",
        "sender": "79876543210@c.us",
        "senderName": "Иван",
        "senderContactName": "Иван Царевич"
  },
  "messageData": {
    "typeMessage": "contactMessage",
    "contactMessageData": {
      "displayName": "Кощей",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Бессмертный;Кощей;\nFN:Кощей Бессмертный\nTEL;type=CELL;type=VOICE;waid=79876543210:+79876543210\nEND:VCARD",
      "forwardingScore": 0,
      "isForwarded": false
    },
  },
    "quotedMessage": {
         "stanzaId": "46618B98B3B9DF50F123456789123456",
         "participant": "79876543210@c.us",
         "typeMessage": "imageMessage",
         "downloadUrl": "",
         "caption": "",
         "jpegThumbnail": ""
    }
  }

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

{
  "typeWebhook": "outgoingAPIMessageReceived",
  "instanceData": {
    "idInstance": 1101111111,
    "wid": "79876543210@c.us",
    "typeInstance": "whatsapp"
  },
    "timestamp": 1732268220,
    "idMessage": "2D9D6721A977D369246509EBE0CE44CA",
    "senderData": {
      "chatId": "120363369140947676@g.us",
        "chatName": "Группа",
        "sender": "79876543210@c.us",
        "senderName": "Иван",
        "senderContactName": "Иван Царевич"
  },
  "messageData": {
    "typeMessage": "contactMessage",
    "contactMessageData": {
      "displayName": "Кощей",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Бессмертный;Кощей;\nFN:Кощей Бессмертный\nTEL;type=CELL;type=VOICE;waid=79876543210:+79876543210\nEND:VCARD",
      "forwardingScore": 0,
      "isForwarded": false
    },
  },
    "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": "outgoingAPIMessageReceived",
  "instanceData": {
    "idInstance": 1101111111,
    "wid": "79876543210@c.us",
    "typeInstance": "whatsapp"
  },
    "timestamp": 1732268220,
    "idMessage": "2D9D6721A977D369246509EBE0CE44CA",
    "senderData": {
      "chatId": "120363369140947676@g.us",
        "chatName": "Группа",
        "sender": "79876543210@c.us",
        "senderName": "Иван",
        "senderContactName": "Иван Царевич"
  },
  "messageData": {
    "typeMessage": "contactMessage",
    "contactMessageData": {
      "displayName": "Кощей",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Бессмертный;Кощей;\nFN:Кощей Бессмертный\nTEL;type=CELL;type=VOICE;waid=79876543210:+79876543210\nEND:VCARD",
      "forwardingScore": 0,
      "isForwarded": false
    },
  },
    "quotedMessage": {
      "stanzaId": "46618B98B3B9DF50F123456789123456",
      "participant": "79001234567@c.us",
      "typeMessage": "locationMessage",
      "location": {
        "nameLocation": "",
        "address": "",
        "jpegThumbnail": "",
        "latitude": 72.5922702,
        "longitude": 45.6645388
      }
    }
  }