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

Входящее сообщение с геолокацией#

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

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

  • typeWebhook = incomingMessageReceived
  • messageData.typeMessage = locationMessage

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

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

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

  2. Через метод SetSettings включить настройку incomingWebhook

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

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

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

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

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

Параметр Тип Описание
latitude double Широта локации
longitude double Долгота локации
forwardingScore integer Количество пересылок сообщения
isForwarded boolean Является ли сообщение пересланным, принимает значения true/false

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

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

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 4100000000,
    "wid": "79876543210@c.us",
    "typeInstance": "telegram"
  },
  "timestamp": 1763115112,
  "idMessage": "1763115112345",
  "senderData": {
    "chatId": "10000000",
    "chatType": "user",
    "sender": "10000000",
    "chatName": "Василиса Премудрая",
    "senderName": "Василиса Премудрая",
    "senderType": "user",
    "senderContactName": "Василиса Премудрая",
    "senderPhoneNumber": 79998887766
  },
  "messageData": {
    "typeMessage": "locationMessage",
    "locationMessageData": {
      "jpegThumbnail": "",
      "latitude": 51.1035035,
      "longitude": 71.3996933,
      "forwardingScore": 1,
      "isForwarded": true
    }
  }
}

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

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 4100000000,
    "wid": "79876543210@c.us",
    "typeInstance": "telegram"
  },
  "timestamp": 1763115112,
  "idMessage": "1763115112345",
  "senderData": {
    "chatId": "-10000000000000",
    "chatType": "channel",
    "sender": "10000000",
    "chatName": "Тридесятое царство",
    "senderName": "Василиса",
    "senderType": "user",
    "senderContactName": "",
    "senderPhoneNumber": 0
  },
  "messageData": {
    "typeMessage": "locationMessage",
    "locationMessageData": {
      "jpegThumbnail": "",
      "latitude": 51.1035035,
      "longitude": 71.3996933,
      "forwardingScore": 0,
      "isForwarded": false
    }
  }
}