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

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

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

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

typeWebhook = outgoingMessageReceived || outgoingAPIMessageReceived

messageData.typeMessage = locationMessage

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

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

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

  2. Через метод 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": 4100000000,
    "wid": "79876543210@c.us",
    "typeInstance": "tgm"
  },
  "timestamp": 1763115112,
  "idMessage": "1763115112345",
  "senderData": {
    "chatId": "10000000",
    "sender": "10000000",
    "chatName": "Василиса Премудрая",
    "senderName": "Василиса Премудрая",
    "senderContactName": "Василиса Премудрая",
    "senderPhoneNumber": 79991112233
  },
  "messageData": {
    "typeMessage": "locationMessage",
    "locationMessageData": {
          "latitude": 51.1035035,
          "longitude": 71.3996933,
          "forwardingScore": 1,
          "isForwarded": true
      }
  }
}

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

{
  "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": "locationMessage",
    "locationMessageData": {
          "latitude": 51.1035035,
          "longitude": 71.3996933,
          "forwardingScore": 1,
          "isForwarded": true
      }
  }
}