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

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

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

typeWebhook = outgoingMessageReceived || outgoingAPIMessageReceived

messageData.typeMessage = locationMessage

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

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

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

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

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

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

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

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

Параметр	Тип	Описание
`latitude`	double	Широта локации
`longitude`	double	Долгота локации
`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": "locationMessage",
    "locationMessageData": {
          "latitude": 51.1035035,
          "longitude": 71.3996933,
          "forwardingScore": 1,
          "isForwarded": true
      }
  }
}