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

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

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

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

typeWebhook = outgoingMessageReceived || outgoingAPIMessageReceived

messageData.typeMessage = locationMessage

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

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

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

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

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

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

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

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

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

Параметр Тип Описание
nameLocation string Название локации
address string Адрес локации
jpegThumbnail string Превью изображения в base64 кодировке
latitude double Широта локации
longitude double Долгота локации
forwardingScore integer Количество пересылок сообщения
isForwarded boolean Является ли сообщение пересланным, принимает значения true/false

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

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

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

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

{
  "typeWebhook": "outgoingAPIMessageReceived",
  "instanceData": {
    "idInstance": 1101111111,
    "wid": "79876543210@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1588091580,
  "idMessage": "BAE5A1CB9061D053",
  "senderData": {
    "chatId": "79001234567@c.us",
    "sender": "79876543210@c.us",
    "chatName": "Василиса",
    "senderName": "Иван",
    "senderContactName": "Иван Царевич"
  },
  "messageData": {
    "typeMessage": "locationMessage",
    "locationMessageData": {  
      "nameLocation": "Эмпайр-стейт-билдинг",  
      "address": "20 W 34th St., New York, NY 10001, США",
      "jpegThumbnail": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFx=",
      "latitude": 12.345678910111213,
      "longitude": 14.151617181920212,
      "forwardingScore": 0,  
      "isForwarded": false
    }
  }
}

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

{
    "typeWebhook": "outgoingMessageReceived",
    "instanceData": {
        "idInstance": 1101111111,
        "wid": "79876543210@c.us",
        "typeInstance": "whatsapp"
    },
    "timestamp": 1732268220,
    "idMessage": "BAE5C8FEE16ED20E",
    "senderData": {
      "chatId": "120363369140947676@g.us",
        "chatName": "Группа",
        "sender": "79876543210@c.us",
        "senderName": "Иван",
        "senderContactName": "Иван Царевич"
  },
  "messageData": {
    "typeMessage": "locationMessage",
    "locationMessageData": {  
      "nameLocation": "Эмпайр-стейт-билдинг",  
      "address": "20 W 34th St., New York, NY 10001, США",
      "jpegThumbnail": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFx=",
      "latitude": 12.345678910111213,
      "longitude": 14.151617181920212,
      "forwardingScore": 0,  
      "isForwarded": false
    }
  }
}

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

{
  "typeWebhook": "outgoingAPIMessageReceived",
  "instanceData": {
    "idInstance": 1101111111,
    "wid": "79876543210@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1588091580,
  "idMessage": "BAE5A1CB9061D053",
  "senderData": {
    "chatId": "79001234567@c.us",
    "sender": "79876543210@c.us",
    "chatName": "Василиса",
    "senderName": "Иван",
    "senderContactName": "Иван Царевич"
  },
  "messageData": {
    "typeMessage": "locationMessage",
    "locationMessageData": {
      "nameLocation": "Эмпайр-стейт-билдинг",
      "address": "20 W 34th St., New York, NY 10001, США",
      "jpegThumbnail": "217",
      "latitude": 74.5922641,
      "longitude": 59.6645355,
      "forwardingScore": 4,
      "isForwarded": true  
    },
    "quotedMessage": {
      "stanzaId": "46618B98B3B9DF50F123456789123456",
      "participant": "79001234567@c.us",
      "typeMessage": "textMessage",
      "textMessage": "Привет"
    }
  }
}