Stickers & Games

This section covers the management of Telegram Stickers, Custom Emojis, and HTML5 Games.

Sticker Management

getStickerSet

Gets a sticker set by its name.

Parameter	Type	Required	Description
`name`	String	Yes	Name of the sticker set.

BLP Example

result = Bot.getStickerSet(name="Animals")

getCustomEmojiStickers

Gets information about custom emoji stickers by their identifiers.

Parameter	Type	Required	Description
`custom_emoji_ids`	Array of String	Yes	A JSON-serialized list of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.

createNewStickerSet

Creates a new sticker set owned by a user. The bot will be able to edit the sticker set thus created.

Parameter	Type	Required	Description
`user_id`	Integer	Yes	User identifier of created sticker set owner.
`name`	String	Yes	Short name of sticker set, to be used in `t.me/addstickers/` URLs (e.g., `animals_by_bot`).
`title`	String	Yes	Sticker set title, 1-64 characters.
`stickers`	Array of Object	Yes	A JSON-serialized list of 1-50 initial stickers to be added to the sticker set.
`sticker_type`	String	No	Type of stickers in the set, pass `"regular"`, `"mask"`, or `"custom_emoji"`.

addStickerToSet

Adds a new sticker to a set created by the bot.

Parameter	Type	Required	Description
`user_id`	Integer	Yes	User identifier of sticker set owner.
`name`	String	Yes	Sticker set name.
`sticker`	Object	Yes	A JSON-serialized object with information about the added sticker.

deleteStickerFromSet

Deletes a sticker from a set created by the bot.

Parameter	Type	Required	Description
`sticker`	String	Yes	File identifier of the sticker.

deleteStickerSet

Deletes a sticker set that was created by the bot.

Parameter	Type	Required	Description
`name`	String	Yes	Sticker set name.

Games

Bots can offer users HTML5 games to play solo or compete against each other in groups and one-on-one chats.

sendGame

Sends a game.

Parameter	Type	Required	Description
`chat_id`	Integer	Yes	Unique identifier for the target chat.
`game_short_name`	String	Yes	Short name of the game, serves as the unique identifier for the game. Set up your games via @BotFather.

BLP Example

Bot.sendGame(
    chat_id=u,
    game_short_name="my_awesome_game"
)

setGameScore

Sets the score of the specified user in a game.

Parameter	Type	Required	Description
`user_id`	Integer	Yes	User identifier.
`score`	Integer	Yes	New score, must be non-negative.
`force`	Boolean	No	Pass `True` if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters.
`chat_id`	Integer	No	Required if `inline_message_id` is not specified.
`message_id`	Integer	No	Required if `inline_message_id` is not specified.
`inline_message_id`	String	No	Required if `chat_id` and `message_id` are not specified.

BLP Example

Bot.setGameScore(
    user_id=u,
    score=1500,
    chat_id=u,
    message_id=message.message_id
)

getGameHighScores

Gets data for high score tables. Will return the score of the specified user and several of their neighbors in a game.

Parameter	Type	Required	Description
`user_id`	Integer	Yes	Target user id.
`chat_id`	Integer	No	Required if `inline_message_id` is not specified.
`message_id`	Integer	No	Required if `inline_message_id` is not specified.
`inline_message_id`	String	No	Required if `chat_id` and `message_id` are not specified.

getForumTopicIconStickers

Gets custom emoji stickers, which can be used as a forum topic icon by any user.

Parameter	Type	Required	Description
(none)	—	—	No parameters required.

replaceStickerInSet

Replaces an existing sticker in a sticker set with a new one.

Parameter	Type	Required	Description
`user_id`	Integer	Yes	User identifier of sticker set owner.
`name`	String	Yes	Sticker set name.
`old_sticker`	String	Yes	File identifier of the replaced sticker.
`sticker`	Object	Yes	A JSON-serialized object with information about the added sticker.

setCustomEmojiStickerSetThumbnail

Sets the thumbnail of a custom emoji sticker set.

Parameter	Type	Required	Description
`name`	String	Yes	Sticker set name.
`custom_emoji_id`	String	Yes	Custom emoji identifier of a sticker from the sticker set.

setStickerEmojiList

Changes the list of emoji assigned to a regular or custom emoji sticker.

Parameter	Type	Required	Description
`sticker`	String	Yes	File identifier of the sticker.
`emoji_list`	Array of String	Yes	A JSON-serialized list of 1-20 emoji associated with the sticker.

setStickerKeywords

Changes search keywords assigned to a regular or custom emoji sticker.

Parameter	Type	Required	Description
`sticker`	String	Yes	File identifier of the sticker.
`keywords`	Array of String	No	A JSON-serialized list of 0-20 search keywords for the sticker with total length of up to 64 characters.

setStickerMaskPosition

Changes the mask position of a mask sticker.

Parameter	Type	Required	Description
`sticker`	String	Yes	File identifier of the sticker.
`mask_position`	Object	No	A JSON-serialized object with the position where the mask should be placed on faces. Omit the parameter to remove the mask position.

setStickerPositionInSet

Moves a sticker in a set created by the bot to a specific position.

Parameter	Type	Required	Description
`sticker`	String	Yes	File identifier of the sticker.
`position`	Integer	Yes	New sticker position in the set, zero-based.

setStickerSetThumbnail

Sets the thumbnail of a regular or mask sticker set.

Parameter	Type	Required	Description
`name`	String	Yes	Sticker set name.
`user_id`	Integer	Yes	User identifier of the sticker set owner.
`thumbnail`	String	Yes	A file ID of the new thumbnail, or a URL.
`format`	String	Yes	Format of the thumbnail, must be one of `"static"` for a .WEBP or .PNG image, `"animated"` for a .TGS animation, or `"video"` for a .WEBM video.

setStickerSetTitle

Sets the title of a created sticker set.

Parameter	Type	Required	Description
`name`	String	Yes	Sticker set name.
`title`	String	Yes	Sticker set title, 1-64 characters.

uploadStickerFile

Uploads a file with a sticker for later use in the createNewStickerSet and addStickerToSet methods.

Parameter	Type	Required	Description
`user_id`	Integer	Yes	User identifier of sticker file owner.
`sticker`	String	Yes	A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format.
`sticker_format`	String	Yes	Format of the sticker, must be one of `"static"`, `"animated"`, `"video"`.

Getting Started

Language Reference

Telegram API Methods

Core Libraries (Libs)

Sticker Management

getStickerSet

getCustomEmojiStickers

createNewStickerSet

addStickerToSet

deleteStickerFromSet

deleteStickerSet

Games

sendGame

setGameScore

getGameHighScores

getForumTopicIconStickers

replaceStickerInSet

setCustomEmojiStickerSetThumbnail

setStickerEmojiList

setStickerKeywords

setStickerMaskPosition

setStickerPositionInSet

setStickerSetThumbnail

setStickerSetTitle

uploadStickerFile

​Sticker Management

​getStickerSet

​getCustomEmojiStickers

​createNewStickerSet

​addStickerToSet

​deleteStickerFromSet

​deleteStickerSet

​Games

​sendGame

​setGameScore

​getGameHighScores

​getForumTopicIconStickers

​replaceStickerInSet

​setCustomEmojiStickerSetThumbnail

​setStickerEmojiList

​setStickerKeywords

​setStickerMaskPosition

​setStickerPositionInSet

​setStickerSetThumbnail

​setStickerSetTitle

​uploadStickerFile

Sticker Management

getStickerSet

getCustomEmojiStickers

createNewStickerSet

addStickerToSet

deleteStickerFromSet

deleteStickerSet

Games

sendGame

setGameScore

getGameHighScores

getForumTopicIconStickers

replaceStickerInSet

setCustomEmojiStickerSetThumbnail

setStickerEmojiList

setStickerKeywords

setStickerMaskPosition

setStickerPositionInSet

setStickerSetThumbnail

setStickerSetTitle

uploadStickerFile