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 token_types are supported:

  • 1 - APNS (device token for apple push)
  • 2 - FCM (firebase token for google firebase)
  • 3 - MPNS (channel URI for microsoft push)
  • 4 - Simple push (endpoint for firefox's deprecated simple push API): note that this push type can also be used by an open source push notification spec like UnifiedPush ยป.
    Simple push works by sending a simple PUT request with a version=number payload to the specified HTTPS endpoint every time a relevant message is received: upon receiving such a notification, clients should connect to the MTProto API and fetch updates.
    (Note that the number won't necessarily be incremental in Telegram's implementation, just treat each distinct request as a signal that a new message is waiting to be fetched via MTProto).
  • 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)
  • 13 - Huawei 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 base64url-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.

  • loc_key - Notification type: a string literal in the form /[A-Z_0-9]+/, which summarizes the notification. For example, CHAT_MESSAGE_TEXT.
  • loc_args - Notification placeholder arguments: a list or arguments which, when inserted into a template, produce a readable notification.
  • custom - Custom parameters to be passed into the application when a notification is opened. Possible fields:
    • attachb64 - For notifications about media, base64url-encoded TL-serialization of the corresponding Photo / Document object
    • updates - base64url-encoded TL-serialization of the Updates object, currently sent only for PHONE_CALL_REQUEST (with updatePhoneCall inside)
    • call_id - Call ID, used in PHONE_CALL_REQUEST
    • call_ah - Call access hash, used in PHONE_CALL_REQUEST
    • encryption_id - Secret chat id for ENCRYPTION_REQUEST, ENCRYPTION_ACCEPT, ENCRYPTED_MESSAGE
    • random_id - Random id for message in ENCRYPTED_MESSAGE
    • contact_id - Telegram user identifier of contact that joined Telegram in CONTACT_JOINED
    • msg_id - Message ID for new message event or reaction event
    • channel_id - Identifier of the channel/supergroup where the event occurred
    • chat_id - Identifier of the basic group where the event occurred
    • from_id - User ID where the event occurred
    • chat_from_broadcast_id - If the group message was sent as a channel, this field will contain the sender channel ID
    • chat_from_group_id - If the group message was sent as a supergroup, this field will contain the sender supergroup ID
    • chat_from_id - Groups only, message author identifier (ignore if any of chat_from_broadcast_id / chat_from_group_id was present)
    • mention - Whether the current user was mentioned/replied to in this new message
    • silent - Whether the message was posted silently (no sound should be played for this notification)
    • schedule - Whether the message is outgoing and was sent via scheduled messages
    • report_delivery_until_date - If set and the current unixtime is bigger than the specified unixtime, invoke messages.reportMessagesDelivery, setting the push flag and passing the ID and the peer of this message as soon as it is received by the client (optionally batching requests for the same peer), used for Telegram Gateway verification messages.
    • edit_date - When was the message last edited
    • top_msg_id - thread_id for new mentions/replies in threads
    • data_url - Full URL of the webpage trying to login using OAUTH_REQUEST
    • announcement - ID of an announcement, used by MESSAGE_ANNOUNCEMENT
  • sound - The name of an audio file to be played.
  • user_id - ID of the account to which the PUSH notification should be delivered, in case of clients with multiple accounts active and running.
  • message - Optional notification text, currently used by MESSAGE_ANNOUNCEMENT

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 are handled specially by clients to update local app state or synthesize lightweight local events, instead of displaying an ordinary message notification.

DC_UPDATE

Extra custom arguments

data.custom.dc - number of the data-center
data.custom.addr - server address with port number in the format 111.112.113.114:443

Description

Add the received server address to the list of possible addresses for the specified DC.

If the address of the first DC was passed (dc=1), it is recommended to call help.getConfig immediately to refresh the DC configuration.

Template example

Open this notification to update app settings

Arguments

This notification does not use placeholder arguments.

MESSAGE_DELETED

Extra custom arguments

data.custom.channel_id: For channels and supergroups, Channel/supergroup identifier
data.custom.chat_id: For chats, Chat identifier
data.custom.from_id: For PMs, Author identifier
data.custom.messages: Comma-separated IDs of messages that were deleted

Description

Messages were deleted in the specified dialog: remove local notifications for the listed messages.

data.custom.messages contains a comma-separated list of server-side message IDs.

READ_REACTION

Extra custom arguments

data.custom.channel_id: For channels and supergroups, Channel/supergroup identifier
data.custom.chat_id: For chats, Chat identifier
data.custom.from_id: For PMs, Author identifier
data.custom.topic_id: Optional forum topic identifier
data.custom.messages: Comma-separated IDs of messages whose reactions were read

Description

Reactions were read on the specified messages: remove local reaction-related notifications for those messages.

READ_HISTORY

Extra custom arguments

data.custom.channel_id: For channels and supergroups, Channel/supergroup identifier
data.custom.chat_id: For chats, Chat identifier
data.custom.from_id: For PMs, Author identifier
data.custom.max_id: Maximum ID of read messages

Description

Message history was read in the specified non-secret dialog: mark incoming history up to data.custom.max_id as read and remove the corresponding notifications.

READ_STORIES

Extra custom arguments

data.custom.channel_id: For channels and supergroups, Channel/supergroup identifier
data.custom.from_id: For user-sent stories, Author identifier
data.custom.max_id: Maximum ID of read story

Description

Story notifications were read for the specified user or channel: mark stories up to data.custom.max_id as read and remove the corresponding story-related notifications.

STORY_DELETED

Extra custom arguments

data.custom.channel_id: For channels and supergroups, Channel/supergroup identifier
data.custom.from_id: For user-sent stories, Author identifier
data.custom.story_id: Comma-separated list of IDs of deleted stories

Description

A story was deleted: remove local notifications for that story.

STORY_NOTEXT

Extra custom arguments

data.custom.channel_id: For channels and supergroups, Channel/supergroup identifier
data.custom.from_id: For user-sent stories, Author identifier
data.custom.story_id: ID of the story

Description

A new story without text was posted.

Template example

posted a story

Arguments

This notification does not use placeholder arguments.

STORY_LIVE

Extra custom arguments

data.custom.channel_id: For channels and supergroups, Channel/supergroup identifier
data.custom.from_id: For user-sent stories, Author identifier
data.custom.story_id: ID of the story

Description

A story live stream was started.

Template example

started a live stream!

Arguments

This notification does not use placeholder arguments.

STORY_HIDDEN_AUTHOR

Extra custom arguments

data.custom.channel_id: For channels and supergroups, Channel/supergroup identifier
data.custom.from_id: For user-sent stories, Author identifier
data.custom.story_id: ID of the story

Description

A new story was posted, but the client should not expose the author in the visible notification text.

Template example

A new story was posted

Arguments

This notification does not use placeholder arguments.

GEO_LIVE_PENDING

Description

Refresh any live locations currently being watched or shared.

This push is a wake-up hint and does not need placeholder arguments or a user-visible notification.

SESSION_REVOKE

Description

Logout and remove DB for specified session by data.user_id, only apply if coming from an MTProto-encrypted payload

MESSAGE_MUTED

Description

Sent rarely for muted chats, roughly every 10th muted chat message or about once every 15 seconds in PMs, to refresh badge state or trigger fetching updates from the server.

This push is not meant to be shown to the user as a visible notification.

MESSAGE_ANNOUNCEMENT

Extra custom arguments

data.custom.announcement: Announcement ID (integer)

Extra top-level arguments

data.message: Non-empty announcement text

Description

Roughly equivalent to a message received from the service notifications (updateServiceNotification with type="announcement"), but is delivered via push notifications, without contacting the API.

The push text is taken from data.message.

Clients may deduplicate repeated announcements using the announcement ID in data.custom.announcement: for example, by storing received IDs for 7 days, persisting the cache across restarts.

Possible Notifications

AUTH_REGION

Template example

New login from unrecognized device {1}, location: {2}

Arguments

  1. Device name
  2. Location

AUTH_UNKNOWN

Template example

New login from unrecognized device {1}

Arguments

  1. Device name

CHANNEL_MESSAGES

Template example

{1} posted an album

Arguments

  1. Message author

CHANNEL_MESSAGE_AUDIO

Template example

{1} posted a voice message

Arguments

  1. Message author

CHANNEL_MESSAGE_CONTACT

Template example

{1} posted a contact {2}

Arguments

  1. Message author
  2. Contact name

CHANNEL_MESSAGE_DOC

Template example

{1} posted a file

Arguments

  1. Message author

CHANNEL_MESSAGE_DOCS

Template example

{1} posted {2} files

Arguments

  1. Channel name
  2. Number of documents that were posted

CHANNEL_MESSAGE_FWDS

Template example

{1} posted {2} forwarded messages

Arguments

  1. Message author
  2. Number of forwarded messages

CHANNEL_MESSAGE_GAME

Template example

{1} invited you to play {2}

Arguments

  1. Message author
  2. Game name

CHANNEL_MESSAGE_GAME_SCORE

Template example

{1} scored {3} in game {2}

Arguments

  1. User
  2. Game name
  3. Score

CHANNEL_MESSAGE_GEO

Template example

{1} posted a location

Arguments

  1. Channel name

CHANNEL_MESSAGE_GEOLIVE

Template example

{1} posted a live location

Arguments

  1. Channel name

CHANNEL_MESSAGE_GIF

Template example

{1} posted a GIF

Arguments

  1. Channel name

CHANNEL_MESSAGE_GIVEAWAY

Template example

{1} posted a giveaway of {2}x {3}m Premium subscriptions

Arguments

  1. Channel name
  2. Number of Telegram Premium subscriptions in the giveaway
  3. Duration in months of each Telegram Premium subscription in the giveaway

CHANNEL_MESSAGE_GIVEAWAY_STARS

Template example

{1} posted a giveaway of {3} stars {2}

Arguments

  1. Channel name
  2. Number of winners in the giveaway
  3. Number of Telegram Stars being given away

CHANNEL_MESSAGE_NOTEXT

Template example

{1} posted a message

Arguments

  1. Channel name

CHANNEL_MESSAGE_PAID_MEDIA

Template example

{1} posted a paid post for {2} star

Arguments

  1. Channel name
  2. Stars

CHANNEL_MESSAGE_PHOTO

Template example

{1} posted a photo

Arguments

  1. Channel name

CHANNEL_MESSAGE_PHOTOS

Template example

{1} posted {2} photos

Arguments

  1. Channel name
  2. Number of photos that was sent

CHANNEL_MESSAGE_PLAYLIST

Template example

{1} posted {2} music files

Arguments

  1. Channel name
  2. Number of audio files that were posted

CHANNEL_MESSAGE_POLL

Template example

{1} posted a poll {2}

Arguments

  1. Channel name
  2. Poll name

CHANNEL_MESSAGE_QUIZ

Template example

{1} posted a quiz {2}

Arguments

  1. Channel name
  2. Quiz name

CHANNEL_MESSAGE_ROUND

Template example

{1} posted a video message

Arguments

  1. Channel name

CHANNEL_MESSAGE_STICKER

Template example

{1} posted a {2} sticker

Arguments

  1. Channel name
  2. Sticker emoji

CHANNEL_MESSAGE_STORY

Template example

{1} shared a story

Arguments

  1. Channel name

CHANNEL_MESSAGE_TEXT

Template example

{1}: {2}

Arguments

  1. Channel name
  2. Message body

CHANNEL_MESSAGE_TODO

Template example

{1} posted a checklist {2}

Arguments

  1. Channel name
  2. Checklist title

CHANNEL_MESSAGE_TODO_APPEND

Template example

{1} added {2} tasks

Arguments

  1. Channel name
  2. Number of added tasks

CHANNEL_MESSAGE_TODO_DONE

Template example

{1} toggled {2} tasks

Arguments

  1. Channel name
  2. Number of toggled tasks

CHANNEL_MESSAGE_VIDEO

Template example

{1} posted a video

Arguments

  1. Channel name

CHANNEL_MESSAGE_VIDEOS

Template example

{1} posted {2} videos

Arguments

  1. Channel name
  2. Number of videos that were posted

CHAT_ADD_MEMBER

Template example

{1} invited {3} to the group {2}

Arguments

  1. Message author
  2. Chat name
  3. New participant name

CHAT_ADD_YOU

Template example

{1} invited you to the group {2}

Arguments

  1. User name
  2. Group name

CHAT_CREATED

Template example

{1} invited you to the group {2}

Arguments

  1. Message author
  2. Chat name

CHAT_DELETE_MEMBER

Template example

{1} removed {3} from the group {2}

Arguments

  1. Message author
  2. Chat name
  3. Dropped participant name

CHAT_DELETE_YOU

Template example

{1} removed you from the group {2}

Arguments

  1. Message author
  2. Chat name

CHAT_JOINED

Template example

{1} joined the group {2}

Arguments

  1. User name
  2. Group name

CHAT_LEFT

Template example

{1} left the group {2}

Arguments

  1. Message author
  2. Chat name

CHAT_MESSAGES

Template example

{1} sent an album to the group {2}

Arguments

  1. User name
  2. Group name

CHAT_MESSAGE_AUDIO

Template example

{1} sent a voice message to the group {2}

Arguments

  1. Message author
  2. Chat name

CHAT_MESSAGE_CONTACT

Template example

{1} shared a contact {3} in the group {2}

Arguments

  1. User name
  2. Group name
  3. Contact name

CHAT_MESSAGE_DOC

Template example

{1} sent a file to the group {2}

Arguments

  1. User name
  2. Group name

CHAT_MESSAGE_DOCS

Template example

{1} sent {3} files to the group {2}

Arguments

  1. User name
  2. Group name
  3. Number of documents that were sent

CHAT_MESSAGE_FWDS

Template example

{1} forwarded {3} messages to the group {2}

Arguments

  1. User name
  2. Group name
  3. Number of messages that were forwarded

CHAT_MESSAGE_GAME

Template example

{1} invited the group {2} to play {3}

Arguments

  1. User name
  2. Group name
  3. Game name

CHAT_MESSAGE_GAME_SCORE

Template example

{1} scored {4} in game {3} in the group {2}

Arguments

  1. User name
  2. Group name
  3. Game name
  4. Score

CHAT_MESSAGE_GEO

Template example

{1} sent a location to the group {2}

Arguments

  1. Message author
  2. Chat name

CHAT_MESSAGE_GEOLIVE

Template example

{1} shared a live location with the group {2}

Arguments

  1. User name
  2. Group name

CHAT_MESSAGE_GIF

Template example

{1} sent a GIF to the group {2}

Arguments

  1. User name
  2. Group name

CHAT_MESSAGE_GIVEAWAY

Template example

{1} sent a giveaway of {3}x {4}m Premium subscriptions to the group {2}

Arguments

  1. User name
  2. Group name
  3. Number of Telegram Premium subscriptions in the giveaway
  4. Duration in months of each Telegram Premium subscription in the giveaway

CHAT_MESSAGE_GIVEAWAY_STARS

Template example

{1} sent a giveaway of {4} stars {3} to the group {2}

Arguments

  1. User name
  2. Group name
  3. Number of winners in the giveaway
  4. Number of Telegram Stars being given away

CHAT_MESSAGE_INVOICE

Template example

{1} sent an invoice to the group {2} for {3}

Arguments

  1. User name
  2. Group name
  3. Product name

CHAT_MESSAGE_NOTEXT

Template example

{1} sent a message to the group {2}

Arguments

  1. Message author
  2. Chat name

CHAT_MESSAGE_PAID_MEDIA

Template example

{1} posted a paid post in {2} group for {3} star

Arguments

  1. Message author
  2. Chat name
  3. Stars

CHAT_MESSAGE_PHOTO

Template example

{1} sent a photo to the group {2}

Arguments

  1. Message author
  2. Chat name

CHAT_MESSAGE_PHOTOS

Template example

{1} sent {3} photos to the group {2}

Arguments

  1. User name
  2. Group name
  3. Number of photos that were sent

CHAT_MESSAGE_PLAYLIST

Template example

{1} sent {3} music files to the group {2}

Arguments

  1. User name
  2. Group name
  3. Number of audio files that were sent

CHAT_MESSAGE_POLL

Template example

{1} sent a poll {3} to the group {2}

Arguments

  1. User name
  2. Group name
  3. Poll name

CHAT_MESSAGE_QUIZ

Template example

{1} sent a quiz {3} to the group {2}

Arguments

  1. User name
  2. Group name
  3. Quiz name

CHAT_MESSAGE_ROUND

Template example

{1} sent a video message to the group {2}

Arguments

  1. User name
  2. Group name

CHAT_MESSAGE_STICKER

Template example

{1} sent a {3} sticker to the group {2}

Arguments

  1. User name
  2. Group name
  3. Sticker emoji

CHAT_MESSAGE_STORY

Template example

{1} shared a story to the group

Arguments

  1. Group name

CHAT_MESSAGE_TEXT

Template example

{1} @ {2}: {3}

Arguments

  1. Message author
  2. Chat name
  3. Message body

CHAT_MESSAGE_TODO

Template example

{1} sent a checklist {3} to the group {2}

Arguments

  1. User
  2. Group name
  3. Checklist title

CHAT_MESSAGE_TODO_APPEND

Template example

{1} added {3} tasks in the group {2}

Arguments

  1. User
  2. Group name
  3. Number of added tasks

CHAT_MESSAGE_TODO_DONE

Template example

{1} toggled {3} tasks in the group {2}

Arguments

  1. User name
  2. Group name
  3. Number of toggled tasks

CHAT_MESSAGE_VIDEO

Template example

{1} sent a video to the group {2}

Arguments

  1. Message author
  2. Chat name

CHAT_MESSAGE_VIDEOS

Template example

{1} sent {3} videos to the group {2}

Arguments

  1. User name
  2. Group name
  3. Number of videos that were sent

CHAT_PHOTO_EDITED

Template example

{1} changed the group photo for {2}

Arguments

  1. Message author
  2. Chat name

CHAT_REACT_AUDIO

Template example

{1}: {3} to your voice message in {2}

Arguments

  1. User name
  2. Group name
  3. Reaction

CHAT_REACT_CONTACT

Template example

{1}: {3} to your contact {4} in {2}

Arguments

  1. User name
  2. Group name
  3. Reaction
  4. Contact name

CHAT_REACT_DOC

Template example

{1}: {3} to your file in {2}

Arguments

  1. User name
  2. Group name
  3. Reaction

CHAT_REACT_GAME

Template example

{1}: {3} to your game in {2}

Arguments

  1. User name
  2. Group name
  3. Reaction

CHAT_REACT_GEO

Template example

{1}: {3} to your map in {2}

Arguments

  1. User name
  2. Group name
  3. Reaction

CHAT_REACT_GEOLIVE

Template example

{1}: {3} to your live location in {2}

Arguments

  1. User name
  2. Group name
  3. Reaction

CHAT_REACT_GIF

Template example

{1}: {3} to your GIF in {2}

Arguments

  1. User name
  2. Group name
  3. Reaction

CHAT_REACT_GIVEAWAY

Template example

{1} reacted {3} in group {2} to your giveaway

Arguments

  1. User name
  2. Group name
  3. Reaction

CHAT_REACT_INVOICE

Template example

{1}: {3} to your invoice in {2}

Arguments

  1. User name
  2. Group name
  3. Reaction

CHAT_REACT_NOTEXT

Template example

{1}: {3} to your message in {2}

Arguments

  1. User name
  2. Group name
  3. Reaction

CHAT_REACT_PAID_MEDIA

Template example

{1} reacted {3} in group {2} to your paid post for {4} star

Arguments

  1. User name
  2. Group name
  3. Reaction
  4. Stars

CHAT_REACT_PHOTO

Template example

{1}: {3} to your photo in {2}

Arguments

  1. User name
  2. Group name
  3. Reaction

CHAT_REACT_POLL

Template example

{1}: {3} to your poll {4} in {2}

Arguments

  1. User name
  2. Group name
  3. Reaction
  4. Poll name

CHAT_REACT_QUIZ

Template example

{1}: {3} to your quiz {4} in {2}

Arguments

  1. User name
  2. Group name
  3. Reaction
  4. Quiz name

CHAT_REACT_ROUND

Template example

{1}: {3} to your video message in {2}

Arguments

  1. User name
  2. Group name
  3. Reaction

CHAT_REACT_STICKER

Template example

{1}: {3} to your {4} sticker in {2}

Arguments

  1. User name
  2. Group name
  3. Reaction
  4. Sticker emoji

CHAT_REACT_TEXT

Template example

{1}: {3} in {2} to your "{4}"

Arguments

  1. User name
  2. Group name
  3. Reaction
  4. Message body

CHAT_REACT_TODO

Template example

{1}: {3} to your checklist {4} in {2}

Arguments

  1. User name
  2. Group name
  3. Reaction
  4. Checklist title

CHAT_REACT_VIDEO

Template example

{1}: {3} to your video in {2}

Arguments

  1. User name
  2. Group name
  3. Reaction

CHAT_REQ_JOINED

Template example

{2}|{1} was accepted into the group

Arguments

  1. User name
  2. Chat name

CHAT_RETURNED

Template example

{1} returned to the group {2}

Arguments

  1. Message author
  2. Chat name

CHAT_TITLE_EDITED

Template example

{1} renamed the group {2}

Arguments

  1. User name
  2. Group name

CHAT_VOICECHAT_END

Template example

{1} ended a voice chat in the group {2}

Arguments

  1. User name
  2. Chat name

CHAT_VOICECHAT_INVITE

Template example

{1} invited {3} to a voice chat in the group {2}

Arguments

  1. User name
  2. Chat name
  3. Invited users

CHAT_VOICECHAT_INVITE_YOU

Template example

{1} invited you to a voice chat in the group {2}

Arguments

  1. User name
  2. Chat name

CHAT_VOICECHAT_START

Template example

{1} started a voice chat in the group {2}

Arguments

  1. User name
  2. Chat name

CONF_CALL_MISSED

Template example

You missed a call from {1}

Arguments

  1. User name

CONTACT_JOINED

Template example

{1} joined Telegram!

Arguments

  1. Contact name

ENCRYPTED_MESSAGE

Template example

You have a new message

Arguments

This notification does not use placeholder arguments.

ENCRYPTION_ACCEPT

Template example

You have a new message

Arguments

This notification does not use placeholder arguments.

ENCRYPTION_REQUEST

Template example

You have a new message

Arguments

This notification does not use placeholder arguments.

LOCKED_MESSAGE

Template example

You have a new message

Arguments

This notification does not use placeholder arguments.

MESSAGES

Template example

{1} sent you an album

Arguments

  1. User name

MESSAGE_AUDIO

Template example

{1} sent you a voice message

Arguments

  1. Message author

MESSAGE_CONTACT

Template example

{1} shared a contact {2} with you

Arguments

  1. User name
  2. Contact name

MESSAGE_DOC

Template example

{1} sent you a file

Arguments

  1. User name

MESSAGE_DOCS

Template example

{1} sent you {2} files

Arguments

  1. User name
  2. Number of documents that were sent

MESSAGE_FWDS

Template example

{1} forwarded you {2} messages

Arguments

  1. User name
  2. Number of messages that were forwarded

MESSAGE_GAME

Template example

{1} invited you to play {2}

Arguments

  1. User name
  2. Game name

MESSAGE_GAME_SCORE

Template example

{1} scored {3} in game {2}

Arguments

  1. User name
  2. Game name
  3. Score

MESSAGE_GEO

Template example

{1} sent you a location

Arguments

  1. Message author

MESSAGE_GEOLIVE

Template example

{1} sent you a live location

Arguments

  1. User name

MESSAGE_GIF

Template example

{1} sent you a GIF

Arguments

  1. User name

MESSAGE_GIFTCODE

Template example

{1} sent you a Gift Code for {2} of Telegram Premium

Arguments

  1. User name
  2. Duration of Telegram Premium subscription

MESSAGE_GIVEAWAY

Template example

{1} sent you a giveaway of {2}x {3}m Premium subscriptions

Arguments

  1. User name
  2. Number of Telegram Premium subscriptions in the giveaway
  3. Duration in months of each Telegram Premium subscription in the giveaway

MESSAGE_GIVEAWAY_STARS

Template example

{1} sent you a giveaway of {3} stars {2}

Arguments

  1. User name
  2. Number of winners in the giveaway
  3. Number of Telegram Stars being given away

MESSAGE_INVOICE

Template example

{1} sent you an invoice for {2}

Arguments

  1. User name
  2. Product

MESSAGE_NOTEXT

Template example

{1} sent you a message

Arguments

  1. Message author

MESSAGE_PAID_MEDIA

Template example

{1} sent you a paid post for {2} star

Arguments

  1. Message author
  2. Stars

MESSAGE_PHOTO

Template example

{1} sent you a photo

Arguments

  1. Message author

MESSAGE_PHOTOS

Template example

{1} sent you {2} photos

Arguments

  1. User name
  2. Number of photos that were sent

MESSAGE_PHOTO_SECRET

Template example

{1} sent you a self-destructing photo

Arguments

  1. User name

MESSAGE_PLAYLIST

Template example

{1} sent you {2} music files

Arguments

  1. User name
  2. Number of audio files that were sent

MESSAGE_POLL

Template example

{1} sent you a poll {2}

Arguments

  1. User name
  2. Poll name

MESSAGE_QUIZ

Template example

{1} sent you a quiz {2}

Arguments

  1. User name
  2. Quiz name

MESSAGE_RECURRING_PAY

Template example

You were charged {2} by {1}

Arguments

  1. The entity to which money was sent for a recurring subscription
  2. The amount of money charged for a recurring subscription

MESSAGE_ROUND

Template example

{1} sent you a video message

Arguments

  1. User name

MESSAGE_SAME_WALLPAPER

Template example

{1} set a same wallpaper for this chat

Arguments

  1. User name

MESSAGE_SCREENSHOT

Template example

{1} took a screenshot

Arguments

  1. User name

MESSAGE_STARGIFT

Template example

{1} sent you a Gift worth {2} Stars

Arguments

  1. User name
  2. Number of Telegram Stars

MESSAGE_STARGIFT_UNPACK_UPGRADE

Template example

{1} unpacked the Gift that you helped upgrade

Arguments

  1. User name

MESSAGE_STARGIFT_UPGRADE

Template example

{1} upgraded your Gift

Arguments

  1. User name

MESSAGE_STICKER

Template example

{1} sent you a {2} sticker

Arguments

  1. User name
  2. Sticker emoji

MESSAGE_STORY

Template example

{1} shared a story with you

Arguments

  1. User name

MESSAGE_STORY_MENTION

Template example

{1} mentioned you in a story

Arguments

  1. User name

MESSAGE_SUGGEST_BIRTHDAY

Template example

{1} suggested you your birthday

Arguments

  1. User name

MESSAGE_TEXT

Template example

{1}: {2}

Arguments

  1. Message author
  2. Message body

MESSAGE_TODO

Template example

{1} sent you a checklist {2}

Arguments

  1. User name
  2. Checklist title

MESSAGE_UNIQUE_STARGIFT

Template example

{1} transferred you a Gift!

Arguments

  1. User name

MESSAGE_VIDEO

Template example

{1} sent you a video

Arguments

  1. Message author

MESSAGE_VIDEOS

Template example

{1} sent you {2} videos

Arguments

  1. User name
  2. Number of videos that were sent

MESSAGE_VIDEO_SECRET

Template example

{1} sent you a self-destructing video

Arguments

  1. User name

MESSAGE_WALLPAPER

Template example

{1} set a new wallpaper for this chat

Arguments

  1. User name

OAUTH_REQUEST

Template example

Login request for {1} from {2}

Arguments

  1. Domain of the URL where the user is trying to log in, the full URL is passed in the data_url field of the custom arguments
  2. Human-readable description of a country and a region from which the authorization is performed, based on the IP address of the user

PHONE_CALL_MISSED

Template example

You missed a call from {1}

Arguments

  1. User name

PHONE_CALL_REQUEST

Template example

{1} is calling you!

Arguments

  1. User name

PINNED_AUDIO

Template example 1

{1} pinned a voice message

Arguments

  1. User name

Template example 2

{1} pinned a voice message in the group {2}

Arguments

  1. User name
  2. Group name

PINNED_CONTACT

Template example 1

{1} pinned a contact {2}

Arguments

  1. User name
  2. Contact name

Template example 2

{1} pinned a contact {3} in the group {2}

Arguments

  1. User name
  2. Group name
  3. Contact name

PINNED_DOC

Template example 1

{1} pinned a file

Arguments

  1. User name

Template example 2

{1} pinned a file in the group {2}

Arguments

  1. User name
  2. Group name

PINNED_GAME

Template example 1

{1} pinned a game

Arguments

  1. User name

Template example 2

{1} pinned a game in the group {2}

Arguments

  1. User name
  2. Group name

PINNED_GAME_SCORE

Template example 1

{1} pinned a game score

Arguments

  1. User name

Template example 2

{1} pinned a game score in the group {2}

Arguments

  1. User name
  2. Group name

PINNED_GEO

Template example 1

{1} pinned a map

Arguments

  1. User name

Template example 2

{1} pinned a map in the group {2}

Arguments

  1. User name
  2. Group name

PINNED_GEOLIVE

Template example 1

{1} pinned a live location

Arguments

  1. User name

Template example 2

{1} pinned a live location in the group {2}

Arguments

  1. User name
  2. Group name

PINNED_GIF

Template example 1

{1} pinned a GIF

Arguments

  1. User name

Template example 2

{1} pinned a GIF in the group {2}

Arguments

  1. User name
  2. Group name

PINNED_GIVEAWAY

Template example 1

{1} pinned a giveaway

Arguments

  1. User name

Template example 2

{1} pinned a giveaway in the group {2}

Arguments

  1. User name
  2. Group name

PINNED_INVOICE

Template example 1

{1} pinned an invoice

Arguments

  1. User name

Template example 2

{1} pinned an invoice in the group {2}

Arguments

  1. User name
  2. Group name

PINNED_NOTEXT

Template example 1

{1} pinned a message

Arguments

  1. User name

Template example 2

{1} pinned a message in the group {2}

Arguments

  1. User name
  2. Group name

PINNED_PAID_MEDIA

Template example 1

{1} pinned a paid post for {2} star

Arguments

  1. User name
  2. Stars

Template example 2

{1} pinned a paid post for {3} star in the group {2}

Arguments

  1. User name
  2. Group name
  3. Stars

PINNED_PHOTO

Template example 1

{1} pinned a photo

Arguments

  1. User name

Template example 2

{1} pinned a photo in the group {2}

Arguments

  1. User name
  2. Group name

PINNED_POLL

Template example 1

{1} pinned a poll {2}

Arguments

  1. User name
  2. Poll name

Template example 2

{1} pinned a poll {3} in the group {2}

Arguments

  1. User name
  2. Group name
  3. Poll name

PINNED_QUIZ

Template example 1

{1} pinned a quiz {2}

Arguments

  1. User name
  2. Quiz name

Template example 2

{1} pinned a quiz {3} in the group {2}

Arguments

  1. User name
  2. Group name
  3. Quiz name

PINNED_ROUND

Template example 1

{1} pinned a video message

Arguments

  1. User name

Template example 2

{1} pinned a video message in the group {2}

Arguments

  1. User name
  2. Group name

PINNED_STICKER

Template example 1

{1} pinned a {2} sticker

Arguments

  1. User name
  2. Sticker emoji

Template example 2

{1} pinned a {3} sticker in the group {2}

Arguments

  1. User name
  2. Group name
  3. Sticker emoji

PINNED_TEXT

Template example 1

{1} pinned "{2}"

Arguments

  1. User name
  2. Message body

Template example 2

{1} pinned "{3}" in the group {2}

Arguments

  1. User name
  2. Group name
  3. Message body

PINNED_TODO

Template example 1

{1} pinned a checklist {2}

Arguments

  1. User name
  2. Checklist title

Template example 2

{1} pinned a checklist {3} in the group {2}

Arguments

  1. User name
  2. Group name
  3. Checklist title

PINNED_VIDEO

Template example 1

{1} pinned a video

Arguments

  1. User name

Template example 2

{1} pinned a video in the group {2}

Arguments

  1. User name
  2. Group name

REACT_AUDIO

Template example

{1}: {2} to your voice message

Arguments

  1. User name
  2. Reaction

REACT_CONTACT

Template example

{1}: {2} to your contact {3}

Arguments

  1. User name
  2. Reaction
  3. Contact name

REACT_DOC

Template example

{1}: {2} to your file

Arguments

  1. User name
  2. Reaction

REACT_GAME

Template example

{1}: {2} to your game

Arguments

  1. User name
  2. Reaction

REACT_GEO

Template example

{1}: {2} to your map

Arguments

  1. User name
  2. Reaction

REACT_GEOLIVE

Template example

{1}: {2} to your live location

Arguments

  1. User name
  2. Reaction

REACT_GIF

Template example

{1}: {2} to your GIF

Arguments

  1. User name
  2. Reaction

REACT_GIVEAWAY

Template example

{1} reacted {2} to your giveaway

Arguments

  1. User name
  2. Reaction

REACT_HIDDEN

Template example

New reaction to your message

Arguments

This notification does not use placeholder arguments.

REACT_INVOICE

Template example

{1}: {2} to your invoice

Arguments

  1. User name
  2. Reaction

REACT_NOTEXT

Template example

{1}: {2} to your message

Arguments

  1. User name
  2. Reaction

REACT_PHOTO

Template example

{1}: {2} to your photo

Arguments

  1. User name
  2. Reaction

REACT_POLL

Template example

{1}: {2} to your poll {3}

Arguments

  1. User name
  2. Reaction
  3. Poll name

REACT_QUIZ

Template example

{1}: {2} to your quiz {3}

Arguments

  1. User name
  2. Reaction
  3. Quiz name

REACT_ROUND

Template example

{1}: {2} to your video message

Arguments

  1. User name
  2. Reaction

REACT_STICKER

Template example

{1}: {2} to your {3} sticker

Arguments

  1. User name
  2. Reaction
  3. Sticker emoji

REACT_STORY

Template example

{1}: {2} to your story

Arguments

  1. Peer where the story was posted
  2. Reaction

REACT_STORY_HIDDEN

Template example

New reaction to your story

Arguments

This notification does not use placeholder arguments.

REACT_TEXT

Template example

{1}: {2} to your "{3}"

Arguments

  1. User name
  2. Reaction
  3. Message body

REACT_TODO

Template example

{1}: {2} to your checklist {3}

Arguments

  1. User name
  2. Reaction
  3. Checklist title

REACT_VIDEO

Template example

{1}: {2} to your video

Arguments

  1. User name
  2. Reaction
Telegram
Telegram is a cloud-based mobile and desktop messaging app with a focus on security and speed.
About
Mobile Apps
Desktop Apps
Platform
About
Blog
Press
Safety