Telegex v0.1.0-rc.7 Telegex View Source
All methods in the Bot API.
Link to this section Summary
Functions
Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.
Use this method to delete a message, including service messages, with the following limitations
Use this method to edit live location messages.
A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation.
On success, if the edited message was sent by the bot, the edited Telegex.Model.Message
is returned, otherwise True is returned.
Use this method to edit text and game messages. On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.
Use this method to forward messages of any kind. On success, the sent Telegex.Model.Message
is returned.
Use this method to get up to date information about the chat (current name of the user for one-on-one conversations,
current username of a user, group or channel, etc.). Returns a Telegex.Model.Chat
object on success.
Use this method to get a list of administrators in a chat. On success,
returns an Array of Telegex.Model.ChatMember
objects that contains information about all chat administrators except other bots.
If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.
Use this method to get information about a member of a chat.
Returns a Telegex.Model.ChatMember
object on success.
Use this method to get basic info about a file and prepare it for downloading.
For the moment, bots can download files of up to 20MB in size. On success, a Telegex.Model.File
object is returned.
The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>,
where <file_path> is taken from the response. 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 again.
A simple method for testing your bot's auth token. Requires no parameters.
Returns basic information about the bot in form of a Telegex.Model.User
object.
Use this method to receive incoming updates using long polling (wiki).
An Array of Telegex.Model.Update
objects is returned.
Use this method to get a list of profile pictures for a user. Returns a Telegex.Model.UserProfilePhotos
object.
Use this method to kick a user from a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.
Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound).
On success, the sent Telegex.Model.Message
is returned.
Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.
Use this method to send audio files, if you want Telegram clients to display them in the music player.
Your audio must be in the .MP3 or .M4A format.
On success, the sent Telegex.Model.Message
is returned. Bots can currently send audio files of up to 50 MB in size,
this limit may be changed in the future.
Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success.
Use this method to send phone contacts. On success, the sent Telegex.Model.Message
is returned.
Use this method to send an animated emoji that will display a random value.On success, the sent Telegex.Model.Message
is returned.
Use this method to send general files. On success, the sent Telegex.Model.Message
is returned.
Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.
Use this method to send point on the map. On success, the sent Telegex.Model.Message
is returned.
Use this method to send a group of photos or videos as an album. On success, an array of the sent [Telegex.Model.Message]
is returned.
Use this method to send text messages. On success, the sent Telegex.Model.Message
is returned.
Use this method to send photos. On success, the sent Telegex.Model.Message
is returned.
Use this method to send a native poll. On success, the sent Telegex.Model.Message
is returned.
Use this method to send information about a venue. On success, the sent Telegex.Model.Message
is returned.
Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Telegex.Model.Document
).
On success, the sent Telegex.Model.Message
is returned.
Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.
As of v.4.0,
Telegram clients support rounded square mp4 videos of up to 1 minute long.
Use this method to send video messages. On success, the sent Telegex.Model.Message
is returned.
Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message.
For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Telegex.Model.Audio
or Telegex.Model.Document
).
On success, the sent Telegex.Model.Message
is returned.
Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
Use this method to stop updating a live location message before live_period expires.
On success, if the message was sent by the bot, the sent Telegex.Model.Message
is returned, otherwise True is returned.
Use this method to unban a previously kicked user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. Returns True on success.
Link to this section Functions
Specs
answer_callback_query(String.t(), text: String.t(), show_alert: boolean(), url: String.t(), cache_time: integer() ) :: {:ok, boolean()} | {:error, Telegex.Model.errors()}
Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.
Specs
delete_chat_photo() :: {:ok, boolean()} | {:error, Telegex.Model.errors()}
Specs
delete_chat_sticker_set() :: {:ok, boolean()} | {:error, Telegex.Model.errors()}
Specs
delete_message(integer() | String.t(), integer()) :: {:ok, boolean()} | {:error, Telegex.Model.errors()}
Use this method to delete a message, including service messages, with the following limitations:
- A message can only be deleted if it was sent less than 48 hours ago.
- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.
- Bots can delete outgoing messages in private chats, groups, and supergroups.
- Bots can delete incoming messages in private chats.
- Bots granted can_post_messages permissions can delete outgoing messages in channels.
- If the bot is an administrator of a group, it can delete any message there.
- If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there. Returns True on success.
Specs
edit_message_live_location(float(), float(), chat_id: integer() | String.t(), message_id: integer(), inline_message_id: String.t(), reply_markup: Telegex.Model.InlineKeyboardMarkup.t() ) :: {:ok, Telegex.Model.Message.t() | boolean()} | {:error, Telegex.Model.errors()}
Use this method to edit live location messages.
A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation.
On success, if the edited message was sent by the bot, the edited Telegex.Model.Message
is returned, otherwise True is returned.
Specs
edit_message_text(String.t(), chat_id: integer() | String.t(), message_id: integer(), inline_message_id: String.t(), parse_mode: String.t(), disable_web_page_preview: boolean(), reply_markup: Telegex.Model.InlineKeyboardMarkup.t() ) :: {:ok, Telegex.Model.Message.t() | boolean()} | {:error, Telegex.Model.errors()}
Use this method to edit text and game messages. On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.
Specs
export_chat_invite_link() :: {:ok, boolean()} | {:error, Telegex.Model.errors()}
forward_message(chat_id, from_chat_id, message_id, optionals \\ [])
View SourceSpecs
forward_message(integer() | String.t(), integer() | String.t(), integer(), [ {:disable_notification, boolean()} ]) :: {:ok, Telegex.Model.Message.t()} | {:error, Telegex.Model.errors()}
Use this method to forward messages of any kind. On success, the sent Telegex.Model.Message
is returned.
Specs
get_chat(integer() | String.t()) :: {:ok, Telegex.Model.Chat.t()} | {:error, Telegex.Model.errors()}
Use this method to get up to date information about the chat (current name of the user for one-on-one conversations,
current username of a user, group or channel, etc.). Returns a Telegex.Model.Chat
object on success.
Specs
get_chat_administrators(integer() | String.t()) :: {:ok, [Telegex.Model.ChatMember.t()]} | {:error, Telegex.Model.errors()}
Use this method to get a list of administrators in a chat. On success,
returns an Array of Telegex.Model.ChatMember
objects that contains information about all chat administrators except other bots.
If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.
Specs
get_chat_member(integer() | String.t(), integer()) :: {:ok, Telegex.Model.ChatMember.t()} | {:error, Telegex.Model.errors()}
Use this method to get information about a member of a chat.
Returns a Telegex.Model.ChatMember
object on success.
Specs
get_chat_members_count() :: {:ok, integer()} | {:error, Telegex.Model.errors()}
Specs
get_file(String.t()) :: {:ok, Telegex.Model.File.t()} | {:error, Telegex.Model.errors()}
Use this method to get basic info about a file and prepare it for downloading.
For the moment, bots can download files of up to 20MB in size. On success, a Telegex.Model.File
object is returned.
The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>,
where <file_path> is taken from the response. 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 again.
Specs
get_me() :: {:ok, Telegex.Model.User.t()} | {:error, Telegex.Model.errors()}
A simple method for testing your bot's auth token. Requires no parameters.
Returns basic information about the bot in form of a Telegex.Model.User
object.
Specs
get_my_commands() :: {:ok, [Telegex.Model.BotCommand.t()]} | {:error, Telegex.Model.errors()}
Specs
get_updates( offset: integer(), limit: integer(), timeout: integer(), allowed_updates: [String.t()] ) :: {:ok, [Telegex.Model.Update.t()]} | {:error, Telegex.Model.errors()}
Use this method to receive incoming updates using long polling (wiki).
An Array of Telegex.Model.Update
objects is returned.
Specs
get_user_profile_photos(integer(), offset: integer(), limit: integer()) :: {:ok, Telegex.Model.UserProfilePhotos.t()} | {:error, Telegex.Model.errors()}
Use this method to get a list of profile pictures for a user. Returns a Telegex.Model.UserProfilePhotos
object.
Specs
kick_chat_member(integer() | String.t(), integer(), [{:until_date, integer()}]) :: {:ok, boolean()} | {:error, Telegex.Model.errors()}
Use this method to kick a user from a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
Specs
leave_chat(integer() | String.t()) :: {:ok, boolean()} | {:error, Telegex.Model.errors()}
Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
Specs
pin_chat_message() :: {:ok, boolean()} | {:error, Telegex.Model.errors()}
Specs
promote_chat_member() :: {:ok, boolean()} | {:error, Telegex.Model.errors()}
restrict_chat_member(chat_id, user_id, permissions, optionals \\ [])
View SourceSpecs
restrict_chat_member( integer() | String.t(), integer(), Telegex.Model.ChatPermissions.t(), [{:until_date, integer()}] ) :: {:ok, boolean()} | {:error, Telegex.Model.errors()}
Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.
Specs
send_animation( integer() | String.t(), Telegex.Model.InputFile.t() | String.t(), Telegex.Model.InputFile.t() | String.t(), duration: integer(), width: integer(), height: integer(), caption: String.t(), parse_mode: String.t(), disable_notification: boolean(), reply_to_message_id: integer(), reply_markup: Telegex.Model.InlineKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardRemove.t() | Telegex.Model.ForceReply.t() ) :: {:ok, Telegex.Model.Message.t()} | {:error, Telegex.Model.errors()}
Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound).
On success, the sent Telegex.Model.Message
is returned.
Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.
Specs
send_audio(integer() | String.t(), Telegex.Model.InputFile.t() | String.t(), caption: String.t(), parse_mode: String.t(), performer: String.t(), title: String.t(), thumb: Telegex.Model.InputFile.t() | String.t(), disable_notification: boolean(), reply_to_message_id: integer(), reply_markup: Telegex.Model.InlineKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardRemove.t() | Telegex.Model.ForceReply.t() ) :: {:ok, Telegex.Model.Message.t()} | {:error, Telegex.Model.errors()}
Use this method to send audio files, if you want Telegram clients to display them in the music player.
Your audio must be in the .MP3 or .M4A format.
On success, the sent Telegex.Model.Message
is returned. Bots can currently send audio files of up to 50 MB in size,
this limit may be changed in the future.
For sending voice messages, use the sendVoice method instead.
Specs
send_chat_action(integer() | String.t(), String.t()) :: {:ok, boolean()} | {:error, Telegex.Model.errors()}
Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success.
Specs
send_contact(integer() | String.t(), String.t(), String.t(), last_name: String.t(), vcard: String.t(), disable_notification: boolean(), reply_to_message_id: integer(), reply_markup: Telegex.Model.InlineKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardRemove.t() | Telegex.Model.ForceReply.t() ) :: {:ok, Telegex.Model.Message.t()} | {:error, Telegex.Model.errors()}
Use this method to send phone contacts. On success, the sent Telegex.Model.Message
is returned.
Specs
send_dice(integer() | String.t(), emoji: String.t(), disable_notification: boolean(), reply_to_message_id: integer(), reply_markup: Telegex.Model.InlineKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardRemove.t() | Telegex.Model.ForceReply.t() ) :: {:ok, Telegex.Model.Message.t()} | {:error, Telegex.Model.errors()}
Use this method to send an animated emoji that will display a random value.On success, the sent Telegex.Model.Message
is returned.
Specs
send_document(integer() | String.t(), Telegex.Model.InputFile.t() | String.t(), thumb: Telegex.Model.InputFile.t() | String.t(), caption: String.t(), parse_mode: String.t(), disable_notification: boolean(), reply_to_message_id: integer(), reply_markup: Telegex.Model.InlineKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardRemove.t() | Telegex.Model.ForceReply.t() ) :: {:ok, Telegex.Model.Message.t()} | {:error, Telegex.Model.errors()}
Use this method to send general files. On success, the sent Telegex.Model.Message
is returned.
Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.
Specs
send_location(integer() | String.t(), float(), float(), live_period: integer(), disable_notification: boolean(), reply_to_message_id: integer(), reply_markup: Telegex.Model.InlineKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardRemove.t() | Telegex.Model.ForceReply.t() ) :: {:ok, Telegex.Model.Message.t()} | {:error, Telegex.Model.errors()}
Use this method to send point on the map. On success, the sent Telegex.Model.Message
is returned.
Specs
send_media_group( integer() | String.t(), [Telegex.Model.InputMediaPhoto.t() | Telegex.Model.InputMediaVideo.t()], disable_notification: boolean(), reply_to_message_id: integer() ) :: {:ok, [Telegex.Model.Message.t()]} | {:error, Telegex.Model.errors()}
Use this method to send a group of photos or videos as an album. On success, an array of the sent [Telegex.Model.Message]
is returned.
Specs
send_message(integer() | String.t(), String.t(), parse_mode: String.t(), disable_web_page_preview: boolean(), disable_notification: boolean(), reply_to_message_id: integer(), reply_markup: Telegex.Model.InlineKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardRemove.t() | Telegex.Model.ForceReply.t() ) :: {:ok, Telegex.Model.Message.t()} | {:error, Telegex.Model.errors()}
Use this method to send text messages. On success, the sent Telegex.Model.Message
is returned.
Specs
send_photo(integer() | String.t(), Telegex.Model.InputFile.t() | String.t(), caption: String.t(), parse_mode: String.t(), disable_notification: boolean(), reply_to_message_id: integer(), reply_markup: Telegex.Model.InlineKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardRemove.t() | Telegex.Model.ForceReply.t() ) :: {:ok, Telegex.Model.Message.t()} | {:error, Telegex.Model.errors()}
Use this method to send photos. On success, the sent Telegex.Model.Message
is returned.
Specs
send_poll(integer() | String.t(), String.t(), [String.t()], is_anonymous: boolean(), type: String.t(), allows_multiple_answers: boolean(), correct_option_id: integer(), explanation: String.t(), explanation_parse_mode: String.t(), open_period: integer(), close_date: integer(), is_closed: boolean(), disable_notification: boolean(), reply_to_message_id: integer(), reply_markup: Telegex.Model.InlineKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardRemove.t() | Telegex.Model.ForceReply.t() ) :: {:ok, Telegex.Model.Message.t()} | {:error, Telegex.Model.errors()}
Use this method to send a native poll. On success, the sent Telegex.Model.Message
is returned.
send_venue(chat_id, latitude, longitude, title, address, optionals \\ [])
View SourceSpecs
send_venue(integer() | String.t(), float(), float(), String.t(), String.t(), foursquare_id: String.t(), foursquare_type: String.t(), disable_notification: boolean(), reply_to_message_id: integer(), reply_markup: Telegex.Model.InlineKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardRemove.t() | Telegex.Model.ForceReply.t() ) :: {:ok, Telegex.Model.Message.t()} | {:error, Telegex.Model.errors()}
Use this method to send information about a venue. On success, the sent Telegex.Model.Message
is returned.
Specs
send_video(integer() | String.t(), Telegex.Model.InputFile.t() | String.t(), duration: integer(), width: integer(), height: integer(), thumb: Telegex.Model.InputFile.t() | String.t(), caption: String.t(), parse_mode: String.t(), supports_streaming: boolean(), disable_notification: boolean(), reply_to_message_id: integer(), reply_markup: Telegex.Model.InlineKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardRemove.t() | Telegex.Model.ForceReply.t() ) :: {:ok, Telegex.Model.Message.t()} | {:error, Telegex.Model.errors()}
Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Telegex.Model.Document
).
On success, the sent Telegex.Model.Message
is returned.
Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.
Specs
send_video_note( integer() | String.t(), Telegex.Model.InputFile.t() | String.t(), duration: integer(), length: integer(), thumb: Telegex.Model.InputFile.t() | String.t(), disable_notification: boolean(), reply_to_message_id: integer(), reply_markup: Telegex.Model.InlineKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardRemove.t() | Telegex.Model.ForceReply.t() ) :: {:ok, Telegex.Model.Message.t()} | {:error, Telegex.Model.errors()}
As of v.4.0,
Telegram clients support rounded square mp4 videos of up to 1 minute long.
Use this method to send video messages. On success, the sent Telegex.Model.Message
is returned.
Specs
send_voice(integer() | String.t(), Telegex.Model.InputFile.t() | String.t(), caption: String.t(), parse_mode: String.t(), duration: integer(), disable_notification: boolean(), reply_to_message_id: integer(), reply_markup: Telegex.Model.InlineKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardMarkup.t() | Telegex.Model.ReplyKeyboardRemove.t() | Telegex.Model.ForceReply.t() ) :: {:ok, Telegex.Model.Message.t()} | {:error, Telegex.Model.errors()}
Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message.
For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Telegex.Model.Audio
or Telegex.Model.Document
).
On success, the sent Telegex.Model.Message
is returned.
Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
Specs
set_chat_administrator_custom_title() :: {:ok, boolean()} | {:error, Telegex.Model.errors()}
Specs
set_chat_description() :: {:ok, boolean()} | {:error, Telegex.Model.errors()}
Specs
set_chat_permissions() :: {:ok, boolean()} | {:error, Telegex.Model.errors()}
Specs
set_chat_photo() :: {:ok, boolean()} | {:error, Telegex.Model.errors()}
Specs
set_chat_sticker_set() :: {:ok, boolean()} | {:error, Telegex.Model.errors()}
Specs
set_chat_title() :: {:ok, boolean()} | {:error, Telegex.Model.errors()}
Specs
set_my_commands() :: {:ok, boolean()} | {:error, Telegex.Model.errors()}
Specs
stop_message_live_location( chat_id: integer() | String.t(), message_id: integer(), inline_message_id: String.t(), reply_markup: Telegex.Model.InlineKeyboardMarkup.t() ) :: {:ok, Telegex.Model.Message.t() | boolean()} | {:error, Telegex.Model.errors()}
Use this method to stop updating a live location message before live_period expires.
On success, if the message was sent by the bot, the sent Telegex.Model.Message
is returned, otherwise True is returned.
Specs
unban_chat_member(integer() | String.t(), integer()) :: {:ok, boolean()} | {:error, Telegex.Model.errors()}
Use this method to unban a previously kicked user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. Returns True on success.
Specs
unpin_chat_message() :: {:ok, boolean()} | {:error, Telegex.Model.errors()}