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

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

Postman Apidog

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

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

typeWebhook = outgoingMessageReceived || outgoingAPIMessageReceived

messageData.typeMessage = contactMessage

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

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

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

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

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

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

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

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

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

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

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

{
  "typeWebhook": "outgoingMessageReceived",
  "instanceData": {
    "idInstance": 3100000000,
    "wid": "79991234567@c.us",
    "typeInstance": "v3"
  },
  "timestamp": 1588091580,
  "idMessage": "2755232962562",
  "senderData": {
    "chatId": "10000000",
    "sender": "10000000",
    "chatName": "Ходабрыш Пробешёлов",
    "senderName": "Ходабрыш Пробешёлов",
    "senderContactName": "Ходабрыш Пробешёлов",
    "senderPhoneNumber": 79991112233
  },
  "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
    }
  }
}