View Source API Reference ex_gram v0.52.2

ExGram main supervisor that starts the bot's registry.

Behaviour for HTTP adapters

HTTP Adapter that uses Tesla

HTTP Adapter for testing, it allows you to setup request responses and errors

Bot creation helper.

Bot supervisor that starts the dispatcher and updates processes and tie them together

Context module for ExGram!

This module handles fetching values from the config with some additional niceties

Named process that receive the updates, apply the middlewares for the bot and call the bot's handler

Mini DSL to build answers based on the context easily.

Keyboard DSL to create inline keyboards easily

Helper module to encode/decode json

By default we will return nil, which will cause to use the default engine

This will reload the ExGram.Encoder.Engine module with the engine selected.

Helpers when dealing with telegram files

Handle behaviour for ExGram.Bot implementation

model/2 and method/4 macros to build the API

Type checker for the method executer.

Executer for the method macro, it takes care of checking the parameters, fetching the token, building the path and body, and calling the adapter.

Helpers for the ExGram.Macros module

Helper to make it easier to create middlewares

Macros for building bot settings like middlewares, commands and regex

Middleware that ignore the username in the command parameter.

Telegram API Model structures

This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).

This object represents an audio file to be treated as music by the Telegram clients.

No description available.

This object represents a bot command.

BotCommandScope model. Valid subtypes: BotCommandScopeDefault, BotCommandScopeAllPrivateChats, BotCommandScopeAllGroupChats, BotCommandScopeAllChatAdministrators, BotCommandScopeChat, BotCommandScopeChatAdministrators, BotCommandScopeChatMember

Represents the scope of bot commands, covering all group and supergroup chat administrators.

Represents the scope of bot commands, covering all group and supergroup chats.

Represents the scope of bot commands, covering all private chats.

Represents the scope of bot commands, covering a specific chat.

Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat.

Represents the scope of bot commands, covering a specific member of a group or supergroup chat.

Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are specified for the user.

This object represents the bot's description.

This object represents the bot's name.

This object represents the bot's short description.

Describes the connection of the bot with a business account.

No description available.

No description available.

This object is received when messages are deleted from a connected business account.

No description available.

No description available.

A placeholder, currently holds no information. Use BotFather to set up your game.

This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.

This object represents a chat.

Represents the rights of an administrator in a chat.

This object contains information about a chat boost.

This object represents a service message about a user boosting a chat.

This object represents a boost removed from a chat.

ChatBoostSource model. Valid subtypes: ChatBoostSourcePremium, ChatBoostSourceGiftCode, ChatBoostSourceGiveaway

The boost was obtained by the creation of Telegram Premium gift codes to boost a chat. Each such code boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.

The boost was obtained by the creation of a Telegram Premium giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.

The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user.

This object represents a boost added to a chat or changed.

Represents an invite link for a chat.

Represents a join request sent to a chat.

Represents a location to which a chat is connected.

ChatMember model. Valid subtypes: ChatMemberOwner, ChatMemberAdministrator, ChatMemberMember, ChatMemberRestricted, ChatMemberLeft, ChatMemberBanned

Represents a chat member that has some additional privileges.

Represents a chat member that was banned in the chat and can't return to the chat or view chat messages.

Represents a chat member that isn't currently a member of the chat, but may join it themselves.

Represents a chat member that has no additional privileges or restrictions.

Represents a chat member that owns the chat and has all administrator privileges.

Represents a chat member that is under certain restrictions in the chat. Supergroups only.

This object represents changes in the status of a chat member.

Describes actions that a non-administrator user is allowed to take in a chat.

This object represents a chat photo.

This object contains information about a chat that was shared with the bot using a KeyboardButtonRequestChat button.

Represents a result of an inline query that was chosen by the user and sent to their chat partner.

This object represents a phone contact.

This object represents an animated emoji that displays a random value.

This object represents a general file (as opposed to photos, voice messages and audio files).

Describes data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.

Describes documents or other Telegram Passport elements shared with the bot by the user.

This object contains information about a message that is being replied to, which may come from another chat or forum topic.

This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile.

Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.

This object represents a forum topic.

This object represents a service message about a forum topic closed in the chat. Currently holds no information.

This object represents a service message about a new forum topic created in the chat.

This object represents a service message about an edited forum topic.

This object represents a service message about a forum topic reopened in the chat. Currently holds no information.

This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.

This object represents one row of the high scores table for a game.

This object represents a service message about General forum topic hidden in the chat. Currently holds no information.

This object represents a service message about General forum topic unhidden in the chat. Currently holds no information.

This object represents a message about a scheduled giveaway.

This object represents a service message about the completion of a giveaway without public winners.

This object represents a service message about the creation of a scheduled giveaway. Currently holds no information.

This object represents a message about the completion of a giveaway with public winners.

This object describes a message that was deleted or is otherwise inaccessible to the bot.

This object represents one button of an inline keyboard. You must use exactly one of the optional fields.

This object represents an inline keyboard that appears right next to the message it belongs to.

This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.

InlineQueryResult model. Valid subtypes: InlineQueryResultCachedAudio, InlineQueryResultCachedDocument, InlineQueryResultCachedGif, InlineQueryResultCachedMpeg4Gif, InlineQueryResultCachedPhoto, InlineQueryResultCachedSticker, InlineQueryResultCachedVideo, InlineQueryResultCachedVoice, InlineQueryResultArticle, InlineQueryResultAudio, InlineQueryResultContact, InlineQueryResultGame, InlineQueryResultDocument, InlineQueryResultGif, InlineQueryResultLocation, InlineQueryResultMpeg4Gif, InlineQueryResultPhoto, InlineQueryResultVenue, InlineQueryResultVideo, InlineQueryResultVoice

Represents a link to an article or web page.

Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.

Represents a link to an MP3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.

Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file.

Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with specified content instead of the animation.

Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.

Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.

Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the sticker.

Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.

Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the voice message.

Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the contact.

Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.

Represents a Game.

Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.

Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the location.

Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.

Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.

Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the venue.

Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.

Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the the voice message.

This object represents a button to be shown above inline query results. You must use exactly one of the optional fields.

Represents the content of a contact message to be sent as the result of an inline query.

Represents the content of an invoice message to be sent as the result of an inline query.

Represents the content of a location message to be sent as the result of an inline query.

InputMedia model. Valid subtypes: InputMediaAnimation, InputMediaDocument, InputMediaAudio, InputMediaPhoto, InputMediaVideo

Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.

Represents an audio file to be treated as music to be sent.

Represents a general file to be sent.

Represents a photo to be sent.

Represents a video to be sent.

InputMessageContent model. Valid subtypes: InputTextMessageContent, InputLocationMessageContent, InputVenueMessageContent, InputContactMessageContent, InputInvoiceMessageContent

This object describes a sticker to be added to a sticker set.

Represents the content of a text message to be sent as the result of an inline query.

Represents the content of a venue message to be sent as the result of an inline query.

This object contains basic information about an invoice.

This object represents one button of the reply keyboard. For simple text buttons, String can be used instead of this object to specify the button text. The optional fields web_app, request_users, request_chat, request_contact, request_location, and request_poll are mutually exclusive.

This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.

This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the сhat if appropriate More about requesting chats »

This object defines the criteria used to request suitable users. Information about the selected users will be shared with the bot when the corresponding button is pressed. More about requesting users »

This object represents a portion of the price for goods or services.

Describes the options used for link preview generation.

This object represents a point on the map.

This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in

This object describes the position on faces where a mask should be placed by default.

MaybeInaccessibleMessage model. Valid subtypes: Message, InaccessibleMessage

MenuButton model. Valid subtypes: MenuButtonCommands, MenuButtonWebApp, MenuButtonDefault

Represents a menu button, which opens the bot's list of commands.

Describes that no specific value for the menu button was set.

Represents a menu button, which launches a Web App.

This object represents a message.

This object represents a service message about a change in auto-delete timer settings.

This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

This object represents a unique message identifier.

MessageOrigin model. Valid subtypes: MessageOriginUser, MessageOriginHiddenUser, MessageOriginChat, MessageOriginChannel

The message was originally sent to a channel chat.

The message was originally sent on behalf of a chat to a group chat.

The message was originally sent by an unknown user.

The message was originally sent by a known user.

This object represents reaction changes on a message with anonymous reactions.

This object represents a change of a reaction on a message performed by a user.

This object represents information about an order.

Describes Telegram Passport data shared with the bot by the user.

PassportElementError model. Valid subtypes: PassportElementErrorDataField, PassportElementErrorFrontSide, PassportElementErrorReverseSide, PassportElementErrorSelfie, PassportElementErrorFile, PassportElementErrorFiles, PassportElementErrorTranslationFile, PassportElementErrorTranslationFiles, PassportElementErrorUnspecified

Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes.

Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.

Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.

Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes.

Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes.

Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.

Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.

Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.

Represents an issue in an unspecified place. The error is considered resolved when new data is added.

This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.

This object represents one size of a photo or a file / sticker thumbnail.

This object contains information about a poll.

This object represents an answer of a user in a non-anonymous poll.

This object contains information about one answer option in a poll.

This object contains information about an incoming pre-checkout query.

This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.

Represents a reaction added to a message along with the number of times it was added.

ReactionType model. Valid subtypes: ReactionTypeEmoji, ReactionTypeCustomEmoji

The reaction is based on a custom emoji.

The reaction is based on an emoji.

This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).

Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).

Describes reply parameters for the message that is being sent.

Describes why a request was unsuccessful.

Describes an inline message sent by a Web App on behalf of a user.

This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUser button.

This object represents a shipping address.

This object represents one shipping option.

This object contains information about an incoming shipping query.

This object represents a sticker.

This object represents a sticker set.

This object represents a story.

This object contains basic information about a successful payment.

This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.

This object contains information about the quoted part of a message that is replied to by the given message.

This object represents an incoming update. At most one of the optional parameters can be present in any given update.

This object represents a Telegram user or bot.

This object represents a list of boosts added to a chat by a user.

This object represent a user's profile pictures.

This object contains information about the users whose identifiers were shared with the bot using a KeyboardButtonRequestUsers button.

This object represents a venue.

This object represents a video file.

This object represents a service message about a video chat ended in the chat.

This object represents a service message about new members invited to a video chat.

This object represents a service message about a video chat scheduled in the chat.

This object represents a service message about a video chat started in the chat. Currently holds no information.

This object represents a video message (available in Telegram apps as of v.4.0).

This object represents a voice note.

Describes data sent from a Web App to the bot.

Describes a Web App.

Describes the current status of a webhook.

This object represents a service message about a user allowing a bot to write messages after adding it to the attachment menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess.

Responses protocol to create easier context flows

Simple text answer, it uses send_message

Answer callback query response

Answer inline query response

Delete message response

Edit inline message response. It will detect the message and use it accordingly to edit the normal or inline message.

Edit markup response. It will detect the message and use it accordingly to edit the normal or inline message markup.

Simple text answer, it uses send_message

Helpers when dealing with bot's tokens

Updates implementation that just start a process but don't do anything

Updates implementation that uses polling method

Updates implementation for testing purposes

Updates implementation that uses webhook method

Mix task to create a basic bot module