Skip to content

Incoming message with a location#

This section describes the format of the incoming notification messageData object for an incoming message with a location. For a description of the general format of incoming notifications, refer to the Incoming messages section.

To receive incoming notifications of this kind, two conditions must be met:

  • typeWebhook = incomingMessageReceived
  • messageData.typeMessage = locationMessage

Instance settings

To receive incoming notifications about messages with a location, you need to enable the settings in one of the ways presented:

  1. Through the console, enable the Receive notifications about incoming messages and files setting

  2. Through the SetSettings method, enable the incomingWebhook setting

Notification#

Notification format#

Fields of the messageData object

Parameter Type Description
typeMessage string Type of the received message. For messages of this type the field takes the value locationMessage
locationMessageData object Object with data about the received location

Fields of the locationMessageData object

Parameter Type Description
latitude double Latitude of the location
longitude double Longitude of the location
forwardingScore integer Number of times the message has been forwarded
isForwarded boolean Whether the message is forwarded, takes the values true/false

Notification body example#

Example of a notification body for a message with a location from a personal chat#

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 4100000000,
    "wid": "79876543210@c.us",
    "typeInstance": "telegram"
  },
  "timestamp": 1763115112,
  "idMessage": "1763115112345",
  "senderData": {
    "chatId": "10000000",
    "chatType": "user",
    "sender": "10000000",
    "chatName": "Vasilisa the Wise",
    "senderName": "Vasilisa the Wise",
    "senderType": "user",
    "senderContactName": "Vasilisa the Wise",
    "senderPhoneNumber": 79998887766
  },
  "messageData": {
    "typeMessage": "locationMessage",
    "locationMessageData": {
      "jpegThumbnail": "",
      "latitude": 51.1035035,
      "longitude": 71.3996933,
      "forwardingScore": 1,
      "isForwarded": true
    }
  }
}

Example of a notification body for a message with a location from a group chat#

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 4100000000,
    "wid": "79876543210@c.us",
    "typeInstance": "telegram"
  },
  "timestamp": 1763115112,
  "idMessage": "1763115112345",
  "senderData": {
    "chatId": "-10000000000000",
    "chatType": "channel",
    "sender": "10000000",
    "chatName": "Faraway Kingdom",
    "senderName": "Vasilisa",
    "senderType": "user",
    "senderContactName": "",
    "senderPhoneNumber": 0
  },
  "messageData": {
    "typeMessage": "locationMessage",
    "locationMessageData": {
      "jpegThumbnail": "",
      "latitude": 51.1035035,
      "longitude": 71.3996933,
      "forwardingScore": 0,
      "isForwarded": false
    }
  }
}