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

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

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

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

typeWebhook = outgoingMessageReceived || outgoingAPIMessageReceived

messageData.typeMessage = contactMessage

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

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

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

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

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

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

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

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

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

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

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

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

{
  "typeWebhook": "outgoingMessageReceived",
  "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": "10000000",
      "phoneNumber": 79991112233,
      "displayName": "Василиса Премудрая",
      "vcard": "",
      "forwardingScore": 0,
      "isForwarded": false
    }
  }
}

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

{
  "typeWebhook": "outgoingMessageReceived",
  "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": "10000000",
      "urlAvatar": "https://i.oneme.ru/i?r=BTE2sh_eZW7g8kugOdIm2NotBPGJiDHPpKQP3fE_vh2BE1holGE_adbUwUqCIPQgiOI",
      "phoneNumber": 79991112233,
      "displayName": "Василиса Премудрая",
      "vcard": "",
      "forwardingScore": 0,
      "isForwarded": false
    }
  }
}