Handling PUSH-notifications

Configuring the application

To be able to send APNS notifications to Apple servers or GCM notifications to Google servers, application certificates (APNS) or an application key (GCM) must be specified in the application settings.

Subscribing to notifications

To subscribe to notifications, the client must invoke the account.registerDevice query, passing in token_type and token as parameters that identify the current device. It is useful to repeat this query at least once every 24 hours or when restarting the application. Use account.unregisterDevice to unsubscribe.

The following modes are supported:

  • 1 - APNS (device token for apple push)
  • 2 - FCM (firebase token for google firebase)
  • 3 - MPNS (channel URI for microsoft push)
  • 4 - Deprecated: Simple push (endpoint for firefox's simple push API)
  • 5 - Ubuntu phone (token for ubuntu push)
  • 6 - Blackberry (token for blackberry push)
  • 7 - MTProto separate session
  • 8 - WNS (windows push)
  • 9 - APNS VoIP (token for apple push VoIP)
  • 10 - Web push (web push, see below)
  • 11 - MPNS VoIP (token for microsoft push VoIP)
  • 12 - Tizen (token for tizen push)

For 10 web push, the token must be a JSON-encoded object with the following keys:

  • endpoint: Absolute URL exposed by the push service where the application server can send push messages
  • keys: P-256 elliptic curve Diffie-Hellman parameters in the following object
    • p256dh: Base64url-encoded P-256 elliptic curve Diffie-Hellman public key
    • auth: Base64url-encoded authentication secret

Notification encryption

For FCM and APNS VoIP, an optional encryption key used to encrypt push notifications can be passed to account.registerDevice (secret). This key (auth_key) is used to encrypt the payloads using MTProto v2.

The FCM payload will be a JSON payload, containing a p field with the base64-encoded encrypted MTProto payload. After decryption, the result will be a JSON object, prefixed by a 32-bit little-endian integer with the length of the JSON payload. As usual, make sure to follow all security checks as described in the MTProto docs.

Example implementation.

As mentioned above, payloads can also be encrypted using P-256 Elliptic Curve Diffie-Hellman when using web push.

Notification structure

An (optionally encrypted) notification is provided as a JSON object in the following format:

{
  "data": {
    "loc_key": "CHAT_MESSAGE_CONTACT",
    "loc_args": ["John Doe", "My magical group", "Contact Exchange"],
    "user_id": 14124122,
    "custom": {
      "chat_id": 241233,
      "msg_id": 123
    },
    "sound": "sound1.mp3",
  }
}

Each notification has several parameters that describe it.

Notification type

data.loc_key - A string literal in the form /[A-Z_0-9]+/, which summarizes the notification. For example, CHAT_MESSAGE_TEXT.

Notification text arguments

data.loc_args - A list or arguments which, when inserted into a template, produce a readable notification.

Custom parameters

data.custom - Parameters which are be passed into the application when a notification is opened.

Sound

data.sound - The name of an audio file to be played.

User id

data.user_id - ID of the account to which the PUSH notification should be delivered, in case of clients with multiple accounts active and running.

Processing notifications

In principle, data.loc_key, data.custom, and an Internet connection are sufficient to generate a notification. Obviously, if possible, when generating a visual notification you need not use all of the transmitted data and may rely on the information already stored on the client. But if a user or a chat is not cached locally, the values passed in loc_args may also be used. data.user_id is the ID of the account to which the PUSH notification should be delivered, in case of clients with multiple accounts active and running.

Service notifications

The following notifications can be used to update app settings.

Type Extra custom arguments Description
DC_UPDATE dc - number of the data-center
addr - server address with port number in the format 111.112.113.114:443
In case the client gets this notification, it is necessary to add the received server address to the list of possible addresses. In case the address of the first DC was passed (dc=1), it is recommended to call it immediately using help.getConfig to update dc-configuration.
MESSAGE_DELETED channel_id: For channels and supergroups, Channel/supergroup identifier
chat_id: For chats, Chat identifier
from_id: For PMs, Author identifier
messages: Comma-separated IDs of messages that were deleted
Messages were deleted, remove multiple notifications for this chat
READ_HISTORY channel_id: For channels and supergroups, Channel/supergroup identifier
chat_id: For chats, Chat identifier
from_id: For PMs, Author identifier
max_id: Maximum ID of read messages
Message history was read, remove multiple notifications for this chat
GEO_LIVE_PENDING   Any of the live locations currently being shared should be updated
SESSION_REVOKE   Logout and remove DB for specified session by data.user_id, only apply if coming from an MTProto-encrypted payload
MESSAGE_MUTED   Sent rarely, every 10th message in chats or once per 15 sec in PM, to update badge or download messages

Possible Notifications

Type Template example Arguments Extra custom arguments
MESSAGE_TEXT {1}: {2} 1. Message author
2. Message body
attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
from_id: Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
MESSAGE_NOTEXT {1} sent you a message 1. Message author attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
from_id: Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
MESSAGE_PHOTO {1} sent you a photo 1. Message author attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
from_id: Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
MESSAGE_PHOTO_SECRET {1} sent you a self-destructing photo 1. User name attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
from_id: Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
MESSAGE_VIDEO {1} sent you a video 1. Message author attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
from_id: Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
MESSAGE_VIDEO_SECRET {1} sent you a self-destructing video 1. User name attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
from_id: Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
MESSAGE_SCREENSHOT {1} took a screenshot 1. User name attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
from_id: Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
MESSAGE_ROUND {1} sent you a video message 1. User name attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
from_id: Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
MESSAGE_DOC {1} sent you a file 1. User name attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
from_id: Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
MESSAGE_STICKER {1} sent you a {2}sticker 1. User name
2. Sticker type
attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
from_id: Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
MESSAGE_AUDIO {1} sent you a voice message 1. Message author attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
from_id: Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
MESSAGE_CONTACT {1} shared a contact {2} with you 1. User name
2. Contact name
attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
from_id: Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
MESSAGE_GEO {1} sent you a map 1. Message author attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
from_id: Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
MESSAGE_GEOLIVE {1} started sharing their live location 1. User name attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
from_id: Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
MESSAGE_POLL {1} sent you a poll {2} 1. User name
2. Poll name
attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
from_id: Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
MESSAGE_GIF {1} sent you a GIF 1. User name attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
from_id: Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
MESSAGE_GAME {1} invited you to play {2} 1. User name
2. Game name
attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
from_id: Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
MESSAGE_GAME_SCORE {1} scored {3} in game {2} 1. User name
2. Game name
3. Score
attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
from_id: Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
MESSAGE_INVOICE {1} sent you an invoice for {2} 1. User name
2. Product
attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
from_id: Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
MESSAGE_FWDS {1} forwarded you {2} messages 1. User name
2. Number of messages that were forwarded
attachb64: Base64-encoded version of the attached media (related to the first message)
chat_from_id: Groups only, message author identifier (related to the first message)
edit_date: When was the message last edited (related to the first message)
from_id: Author identifier (related to the first message)
mention: Whether the user was mentioned in the message (related to the first message)
msg_id: ID of the message (related to the first message)
silent: Whether the message was posted silently (no notification should be issued) (related to the first message)
MESSAGE_PHOTOS {1} sent you {2} photos 1. User name
2. Number of photos that were sent
attachb64: Base64-encoded version of the attached media (related to the first message)
chat_from_id: Groups only, message author identifier (related to the first message)
edit_date: When was the message last edited (related to the first message)
from_id: Author identifier (related to the first message)
mention: Whether the user was mentioned in the message (related to the first message)
msg_id: ID of the message (related to the first message)
silent: Whether the message was posted silently (no notification should be issued) (related to the first message)
MESSAGE_VIDEOS {1} sent you {2} videos 1. User name
2. Number of videos that were sent
attachb64: Base64-encoded version of the attached media (related to the first message)
chat_from_id: Groups only, message author identifier (related to the first message)
edit_date: When was the message last edited (related to the first message)
from_id: Author identifier (related to the first message)
mention: Whether the user was mentioned in the message (related to the first message)
msg_id: ID of the message (related to the first message)
silent: Whether the message was posted silently (no notification should be issued) (related to the first message)
MESSAGES {1} sent you an album 1. User name from_id: author identifier
CHANNEL_MESSAGE_TEXT {1}: {2} 1. Channel name
2. Message body
attachb64: Base64-encoded version of the attached media
channel_id: Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHANNEL_MESSAGE_NOTEXT {1} posted a message 1. Channel name attachb64: Base64-encoded version of the attached media
channel_id: Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHANNEL_MESSAGE_PHOTO {1} posted a photo 1. Channel name attachb64: Base64-encoded version of the attached media
channel_id: Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHANNEL_MESSAGE_VIDEO {1} posted a video 1. Channel name attachb64: Base64-encoded version of the attached media
channel_id: Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHANNEL_MESSAGE_ROUND {1} posted a video message 1. Channel name attachb64: Base64-encoded version of the attached media
channel_id: Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHANNEL_MESSAGE_DOC {1} posted a file 1. Message author attachb64: Base64-encoded version of the attached media
channel_id: Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHANNEL_MESSAGE_STICKER {1} posted a {2}sticker 1. Channel name
2. Channel name
attachb64: Base64-encoded version of the attached media
channel_id: Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHANNEL_MESSAGE_AUDIO {1} posted a voice message 1. Message author attachb64: Base64-encoded version of the attached media
channel_id: Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHANNEL_MESSAGE_CONTACT {1} posted a contact {2} 1. Message author
2. Contact name
attachb64: Base64-encoded version of the attached media
channel_id: Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHANNEL_MESSAGE_GEO {1} posted a map 1. Channel name attachb64: Base64-encoded version of the attached media
channel_id: Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHANNEL_MESSAGE_GEOLIVE {1} posted a live location 1. Channel name attachb64: Base64-encoded version of the attached media
channel_id: Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHANNEL_MESSAGE_POLL {1} posted a poll {2} 1. Channel name
2. Channel name
attachb64: Base64-encoded version of the attached media
channel_id: Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHANNEL_MESSAGE_GIF {1} posted a GIF 1. Channel name attachb64: Base64-encoded version of the attached media
channel_id: Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHANNEL_MESSAGE_GAME {1} invited you to play {2} 1. Message author
2. Game name
attachb64: Base64-encoded version of the attached media
channel_id: Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHANNEL_MESSAGE_GAME_SCORE {1} scored {3} in game {2} 1. User
2. Game name
3. Score
attachb64: Base64-encoded version of the attached media
channel_id: Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHANNEL_MESSAGE_FWDS {1} posted {2} forwarded messages 1. Message author
2. Number of forwarded messages
attachb64: Base64-encoded version of the attached media (related to the first message)
channel_id: Channel/supergroup identifier (related to the first message)
chat_from_id: Groups only, message author identifier (related to the first message)
edit_date: When was the message last edited (related to the first message)
mention: Whether the user was mentioned in the message (related to the first message)
msg_id: ID of the message (related to the first message)
silent: Whether the message was posted silently (no notification should be issued) (related to the first message)
CHANNEL_MESSAGE_PHOTOS {1} posted {2} photos 1. Channel name
2. Channel name
attachb64: Base64-encoded version of the attached media (related to the first message)
channel_id: Channel/supergroup identifier (related to the first message)
chat_from_id: Groups only, message author identifier (related to the first message)
edit_date: When was the message last edited (related to the first message)
mention: Whether the user was mentioned in the message (related to the first message)
msg_id: ID of the message (related to the first message)
silent: Whether the message was posted silently (no notification should be issued) (related to the first message)
CHANNEL_MESSAGE_VIDEOS {1} posted {2} videos 1. Channel name
2. Number of vidoes that were posted
attachb64: Base64-encoded version of the attached media (related to the first message)
channel_id: Channel/supergroup identifier (related to the first message)
chat_from_id: Groups only, message author identifier (related to the first message)
edit_date: When was the message last edited (related to the first message)
mention: Whether the user was mentioned in the message (related to the first message)
msg_id: ID of the message (related to the first message)
silent: Whether the message was posted silently (no notification should be issued) (related to the first message)
CHANNEL_MESSAGES {1} posted an album 1. Message author attachb64: Base64-encoded version of the attached media (related to the first message)
channel_id: Channel/supergroup identifier (related to the first message)
chat_from_id: Groups only, message author identifier (related to the first message)
edit_date: When was the message last edited (related to the first message)
mention: Whether the user was mentioned in the message (related to the first message)
msg_id: ID of the message (related to the first message)
silent: Whether the message was posted silently (no notification should be issued) (related to the first message)
CHAT_MESSAGE_TEXT {1}@{2}: {3} 1. Message author
2. Chat name
3. Message body
attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
chat_id: Chat identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHAT_MESSAGE_NOTEXT {1} sent a message to the group {2} 1. Message author
2. Chat name
attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
chat_id: Chat identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHAT_MESSAGE_PHOTO {1} sent a photo to the group {2} 1. Message author
2. Chat name
attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
chat_id: Chat identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHAT_MESSAGE_VIDEO {1} sent a video to the group {2} 1. Message author
2. Chat name
attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
chat_id: Chat identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHAT_MESSAGE_ROUND {1} sent a video message to the group {2} 1. User name
2. Group name
attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
chat_id: Chat identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHAT_MESSAGE_DOC {1} sent a file to the group {2} 1. User name
2. Group name
attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
chat_id: Chat identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHAT_MESSAGE_STICKER {1} sent a {3}sticker to the group {2} 1. User name
2. Group name
3. Sticker type
attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
chat_id: Chat identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHAT_MESSAGE_AUDIO {1} sent a voice message to the group {2} 1. Message author
2. Chat name
attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
chat_id: Chat identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHAT_MESSAGE_CONTACT {1} shared a contact {3} in the group {2} 1. User name
2. Group name
3. Contact name
attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
chat_id: Chat identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHAT_MESSAGE_GEO {1} sent a map to the group {2} 1. Message author
2. Chat name
attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
chat_id: Chat identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHAT_MESSAGE_GEOLIVE {1} started sharing their live location with {2} 1. User name
2. Group name
attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
chat_id: Chat identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHAT_MESSAGE_POLL {1} sent a poll {3} to the group {2} 1. User name
2. Group name
3. Poll name
attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
chat_id: Chat identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHAT_MESSAGE_GIF {1} sent a GIF to the group {2} 1. User name
2. Group name
attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
chat_id: Chat identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHAT_MESSAGE_GAME {1} invited the group {2} to play {3}. 1. User name
2. Group name
3. Game name
attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
chat_id: Chat identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHAT_MESSAGE_GAME_SCORE {1} scored {4} in game {3} in the group {2} 1. User name
2. Group name
3. Game name
4. Score
attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
chat_id: Chat identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHAT_MESSAGE_INVOICE {1} sent an invoice to the group {2} for {3} 1. User name
2. Group name
3. Product name
attachb64: Base64-encoded version of the attached media
chat_from_id: Groups only, message author identifier
chat_id: Chat identifier
edit_date: When was the message last edited
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CHAT_CREATED {1} invited you to the group {2} 1. Message author
2. Chat name
chat_id: chat identifier
CHAT_TITLE_EDITED {1} edited the group's {2} name 1. User name
2. Group name
chat_id: chat identifier
CHAT_PHOTO_EDITED {1} edited the group's {2} photo 1. Message author
2. Chat name
chat_from_id: Message author identifier
chat_id: chat identifier
msg_id: ID of the message
CHAT_ADD_MEMBER {1} invited {3} to the group {2} 1. Message author
2. Chat name
3. New participant name
chat_id: chat identifier
CHAT_ADD_YOU {1} invited you to the group {2} 1. User name
2. Group name
chat_id: chat identifier
CHAT_DELETE_MEMBER {1} kicked {3} from the group {2} 1. Message author
2. Chat name
3. Dropped participant name
chat_id: chat identifier
CHAT_DELETE_YOU {1} kicked you from the group {2} 1. Message author
2. Chat name
chat_id: chat identifier
CHAT_LEFT {1} has left the group {2} 1. Message author
2. Chat name
chat_id: chat identifier
CHAT_RETURNED {1} has returned to the group {2} 1. Message author
2. Chat name
chat_id: chat identifier
CHAT_JOINED {1} has joined the group {2} 1. User name
2. Group name
chat_id: chat identifier
CHAT_MESSAGE_FWDS {1} forwarded {3} messages to the group {2} 1. User name
2. Group name
3. Number of messages that were forwarded
attachb64: Base64-encoded version of the attached media (related to the first message)
chat_from_id: Groups only, message author identifier (related to the first message)
chat_id: Chat identifier (related to the first message)
edit_date: When was the message last edited (related to the first message)
mention: Whether the user was mentioned in the message (related to the first message)
msg_id: ID of the message (related to the first message)
silent: Whether the message was posted silently (no notification should be issued) (related to the first message)
CHAT_MESSAGE_PHOTOS {1} sent {3} photos to the group {2} 1. User name
2. Group name
3. Number of photos that were sent
attachb64: Base64-encoded version of the attached media (related to the first message)
chat_from_id: Groups only, message author identifier (related to the first message)
chat_id: Chat identifier (related to the first message)
edit_date: When was the message last edited (related to the first message)
mention: Whether the user was mentioned in the message (related to the first message)
msg_id: ID of the message (related to the first message)
silent: Whether the message was posted silently (no notification should be issued) (related to the first message)
CHAT_MESSAGE_VIDEOS {1} sent {3} videos to the group {2} 1. User name
2. Group name
3. Number of videos that were sent
attachb64: Base64-encoded version of the attached media (related to the first message)
chat_from_id: Groups only, message author identifier (related to the first message)
chat_id: Chat identifier (related to the first message)
edit_date: When was the message last edited (related to the first message)
mention: Whether the user was mentioned in the message (related to the first message)
msg_id: ID of the message (related to the first message)
silent: Whether the message was posted silently (no notification should be issued) (related to the first message)
CHAT_MESSAGES {1} sent an album to the group {2} 1. User name
2. Group name
chat_from_id: Message author identifier
chat_id: chat identifier
mention: Whether the user was mentioned in the message
PINNED_TEXT {1} pinned "{2}" 1. User name
2. Message body
attachb64: Base64-encoded version of the attached media
channel_id: For channels and supergroups, Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
chat_id: For chats, Chat identifier
edit_date: When was the message last edited
from_id: For PMs, Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
PINNED_NOTEXT {1} pinned a message 1. User name attachb64: Base64-encoded version of the attached media
channel_id: For channels and supergroups, Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
chat_id: For chats, Chat identifier
edit_date: When was the message last edited
from_id: For PMs, Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
PINNED_PHOTO {1} pinned a photo 1. User name attachb64: Base64-encoded version of the attached media
channel_id: For channels and supergroups, Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
chat_id: For chats, Chat identifier
edit_date: When was the message last edited
from_id: For PMs, Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
PINNED_VIDEO {1} pinned a video 1. User name attachb64: Base64-encoded version of the attached media
channel_id: For channels and supergroups, Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
chat_id: For chats, Chat identifier
edit_date: When was the message last edited
from_id: For PMs, Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
PINNED_ROUND {1} pinned a video message 1. User name attachb64: Base64-encoded version of the attached media
channel_id: For channels and supergroups, Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
chat_id: For chats, Chat identifier
edit_date: When was the message last edited
from_id: For PMs, Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
PINNED_DOC {1} pinned a file 1. User name attachb64: Base64-encoded version of the attached media
channel_id: For channels and supergroups, Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
chat_id: For chats, Chat identifier
edit_date: When was the message last edited
from_id: For PMs, Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
PINNED_STICKER {1} pinned a {2}sticker 1. User name
2. Sticker type
attachb64: Base64-encoded version of the attached media
channel_id: For channels and supergroups, Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
chat_id: For chats, Chat identifier
edit_date: When was the message last edited
from_id: For PMs, Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
PINNED_AUDIO {1} pinned a voice message 1. User name attachb64: Base64-encoded version of the attached media
channel_id: For channels and supergroups, Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
chat_id: For chats, Chat identifier
edit_date: When was the message last edited
from_id: For PMs, Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
PINNED_CONTACT {1} pinned a contact {2} 1. User name
2. User name
attachb64: Base64-encoded version of the attached media
channel_id: For channels and supergroups, Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
chat_id: For chats, Chat identifier
edit_date: When was the message last edited
from_id: For PMs, Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
PINNED_GEO {1} pinned a map 1. User name attachb64: Base64-encoded version of the attached media
channel_id: For channels and supergroups, Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
chat_id: For chats, Chat identifier
edit_date: When was the message last edited
from_id: For PMs, Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
PINNED_GEOLIVE {1} pinned a live location 1. User name attachb64: Base64-encoded version of the attached media
channel_id: For channels and supergroups, Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
chat_id: For chats, Chat identifier
edit_date: When was the message last edited
from_id: For PMs, Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
PINNED_POLL {1} pinned a poll {2} 1. User name
2. Poll name
attachb64: Base64-encoded version of the attached media
channel_id: For channels and supergroups, Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
chat_id: For chats, Chat identifier
edit_date: When was the message last edited
from_id: For PMs, Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
PINNED_GAME {1} pinned a game 1. User name attachb64: Base64-encoded version of the attached media
channel_id: For channels and supergroups, Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
chat_id: For chats, Chat identifier
edit_date: When was the message last edited
from_id: For PMs, Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
PINNED_GAME_SCORE {1} pinned a game score 1. User name attachb64: Base64-encoded version of the attached media
channel_id: For channels and supergroups, Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
chat_id: For chats, Chat identifier
edit_date: When was the message last edited
from_id: For PMs, Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
PINNED_INVOICE {1} pinned an invoice 1. User name attachb64: Base64-encoded version of the attached media
channel_id: For channels and supergroups, Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
chat_id: For chats, Chat identifier
edit_date: When was the message last edited
from_id: For PMs, Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
PINNED_GIF {1} pinned a GIF 1. User name attachb64: Base64-encoded version of the attached media
channel_id: For channels and supergroups, Channel/supergroup identifier
chat_from_id: Groups only, message author identifier
chat_id: For chats, Chat identifier
edit_date: When was the message last edited
from_id: For PMs, Author identifier
mention: Whether the user was mentioned in the message
msg_id: ID of the message
silent: Whether the message was posted silently (no notification should be issued)
CONTACT_JOINED {1} joined Telegram! 1. Contact name contact_id: contact identifier
AUTH_UNKNOWN New login from unrecognized device {1} 1. Device name  
AUTH_REGION New login from unrecognized device {1}, location: {2} 1. Device name
2. Location
 
ENCRYPTION_REQUEST You have a new message   encryption_id: secret chat identifier
ENCRYPTION_ACCEPT You have a new message   encryption_id: secret chat identifier
ENCRYPTED_MESSAGE You have a new message   encryption_id: secret chat identifier
random_id: message identifier
LOCKED_MESSAGE You have a new message    
PHONE_CALL_REQUEST {1} is calling you! 1. User name call_ah: Call access hash
call_id: Call ID
PHONE_CALL_MISSED You missed a call from {1} 1. User name  
MESSAGE_ANNOUNCEMENT {1} 1. Announcement announcement: Announcement: roughly equivalent to a message received from the service notifications (Telegram Notifications, id 777000) user, but must be delivered via push notifications, without contacting the API.