Telegex v0.1.0 Telegex View Source

All methods in the Bot API.

Link to this section Summary

Functions

Use this method to add a new sticker to a set created by the bot. You must use exactly one of the fields png_sticker or tgs_sticker. Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.

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.

Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Telegex.Model.Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.

f you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Telegex.Model.Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.

Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. You must use exactly one of the fields png_sticker or tgs_sticker. Returns True on success.

Use this method to delete a chat photo. Photos can't be changed for private chats. 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 to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.

Use this method to delete a message, including service messages, with the following limitations

Use this method to delete a sticker from a set created by the bot. Returns True on success.

Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success. Requires no parameters.

Use this method to edit captions of messages. On success, if edited message is sent by the bot, the edited Telegex.Model.Message is returned, otherwise True is returned.

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 animation, audio, document, photo, or video messages. If a message is a part of a message album, then it can be edited only to a photo or a video. Otherwise, message type can be changed arbitrarily. When inline message is edited, new file can't be uploaded. Use previously uploaded file via its file_id or specify a URL. 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 only the reply markup of messages. On success, if edited message is 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 Telegex.Model.Message is returned, otherwise True is returned.

Use this method to generate a new invite link for a chat; any previously generated link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the new invite link as String on success.

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 the number of members in a chat. Returns Int 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.

Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. On success, returns an Array of Telegex.Model.GameHighScore objects.

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 get the current list of the bot's commands. Requires no parameters. Returns Array of Telegex.Model.BotCommand on success.

Use this method to get a sticker set. On success, a Telegex.Model.StickerSet object is returned.

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 get current webhook status. Requires no parameters. On success, returns a Telegex.Model.WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.

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 pin a message in a group, a supergroup, or a channel. The bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in the supergroup or 'can_edit_messages' admin right in the channel. Returns True on success.

Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Pass False for all boolean parameters to demote a user. 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 a game. On success, the sent Telegex.Model.Message is returned.

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 static .WEBP or animated .TGS stickers. 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 set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.

Use this method to change the description of a group, a supergroup or a channel. 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 to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members admin rights. Returns True on success.

Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administratorin the chat for this to work and must have the appropriate admin rights. Returns True on success.

Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.

Use this method to change the title of a chat. Titles can't be changed for private chats. 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 to set the score of the specified user in a game. On success, if the message was sent by the bot, returns the edited Telegex.Model.Message, otherwise returns True. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.

Use this method to change the list of the bot's commands. Returns True on success.

Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.

Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.

Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Returns True on success.

Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Telegex.Model.Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.

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 stop a poll which was sent by the bot. On success, the stopped Telegex.Model.Poll with the final results 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.

Use this method to unpin a message in a group, a supergroup, or a channel. The bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in the supergroup or 'can_edit_messages' admin right in the channel. Returns True on success.

Use this method to upload a .PNG file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded Telegex.Model.File on success.

Link to this section Functions

Link to this function

add_sticker_to_set(user_id, name, emojis, optionals \\ [])

View Source

Specs

add_sticker_to_set(integer(), String.t(), String.t(),
  png_sticker: Telegex.Model.InputFile.t() | String.t(),
  tgs_sticker: Telegex.Model.InputFile.t(),
  mask_position: Telegex.Model.MaskPosition.t()
) :: {:ok, boolean()} | {:error, Telegex.Model.errors()}

Use this method to add a new sticker to a set created by the bot. You must use exactly one of the fields png_sticker or tgs_sticker. Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.

Link to this function

answer_callback_query(callback_query_id, optionals \\ [])

View Source

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.

Link to this function

answer_pre_checkout_query(pre_checkout_query_id, ok, optionals \\ [])

View Source

Specs

answer_pre_checkout_query(String.t(), boolean(), [{:error_message, String.t()}]) ::
  {:ok, boolean()} | {:error, Telegex.Model.errors()}

Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Telegex.Model.Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.

Link to this function

answer_shipping_query(shipping_query_id, ok, optionals \\ [])

View Source

Specs

answer_shipping_query(String.t(), boolean(),
  shipping_options: [Telegex.Model.ShippingOption.t()],
  error_message: String.t()
) :: {:ok, boolean()} | {:error, Telegex.Model.errors()}

f you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Telegex.Model.Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.

Link to this function

create_new_sticker_set(user_id, name, title, emojis, optionals \\ [])

View Source

Specs

create_new_sticker_set(integer(), String.t(), String.t(), String.t(),
  png_sticker: Telegex.Model.InputFile.t() | String.t(),
  tgs_sticker: Telegex.Model.InputFile.t(),
  contains_masks: boolean(),
  mask_position: Telegex.Model.MaskPosition.t()
) :: {:ok, boolean()} | {:error, Telegex.Model.errors()}

Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. You must use exactly one of the fields png_sticker or tgs_sticker. Returns True on success.

Link to this function

delete_chat_photo(chat_id)

View Source

Specs

delete_chat_photo(integer() | String.t()) ::
  {:ok, boolean()} | {:error, Telegex.Model.errors()}

Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.

Link to this function

delete_chat_sticker_set(chat_id)

View Source

Specs

delete_chat_sticker_set(integer() | String.t()) ::
  {:ok, boolean()} | {:error, Telegex.Model.errors()}

Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.

Link to this function

delete_message(chat_id, message_id)

View Source

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.
Link to this function

delete_sticker_from_set(sticker)

View Source

Specs

delete_sticker_from_set(String.t()) ::
  {:ok, boolean()} | {:error, Telegex.Model.errors()}

Use this method to delete a sticker from a set created by the bot. Returns True on success.

Specs

delete_webhook() :: {:ok, boolean()} | {:error, Telegex.Model.errors()}

Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success. Requires no parameters.

Link to this function

edit_message_caption(optionals \\ [])

View Source

Specs

edit_message_caption(
  chat_id: integer() | String.t(),
  message_id: integer(),
  inline_message_id: String.t(),
  caption: String.t(),
  parse_mode: String.t(),
  reply_markup: Telegex.Model.InlineKeyboardMarkup.t()
) :: {:ok, Telegex.Model.Message.t()} | {:error, Telegex.Model.errors()}

Use this method to edit captions of messages. On success, if edited message is sent by the bot, the edited Telegex.Model.Message is returned, otherwise True is returned.

Link to this function

edit_message_live_location(latitude, longitude, optionals \\ [])

View Source

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.

Link to this function

edit_message_media(media, optionals \\ [])

View Source

Specs

edit_message_media(Telegex.Model.InputMedia.t(),
  chat_id: integer() | String.t(),
  message_id: integer(),
  inline_message_id: String.t(),
  reply_markup: Telegex.Model.InlineKeyboardMarkup.t()
) :: {:ok, Telegex.Model.Message.t()} | {:error, Telegex.Model.errors()}

Use this method to edit animation, audio, document, photo, or video messages. If a message is a part of a message album, then it can be edited only to a photo or a video. Otherwise, message type can be changed arbitrarily. When inline message is edited, new file can't be uploaded. Use previously uploaded file via its file_id or specify a URL. On success, if the edited message was sent by the bot, the edited Telegex.Model.Message is returned, otherwise True is returned.

Link to this function

edit_message_reply_markup(optionals \\ [])

View Source

Specs

edit_message_reply_markup(
  chat_id: integer() | String.t(),
  message_id: integer(),
  inline_message_id: String.t(),
  reply_markup: Telegex.Model.InlineKeyboardMarkup.t()
) :: {:ok, Telegex.Model.Message.t()} | {:error, Telegex.Model.errors()}

Use this method to edit only the reply markup of messages. On success, if edited message is sent by the bot, the edited Telegex.Model.Message is returned, otherwise True is returned.

Link to this function

edit_message_text(text, optionals \\ [])

View Source

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 Telegex.Model.Message is returned, otherwise True is returned.

Link to this function

export_chat_invite_link(chat_id)

View Source

Specs

export_chat_invite_link(integer() | String.t()) ::
  {:ok, String.t()} | {:error, Telegex.Model.errors()}

Use this method to generate a new invite link for a chat; any previously generated link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the new invite link as String on success.

Link to this function

forward_message(chat_id, from_chat_id, message_id, optionals \\ [])

View Source

Specs

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.

Link to this function

get_chat_administrators(chat_id)

View Source

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.

Link to this function

get_chat_member(chat_id, user_id)

View Source

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.

Link to this function

get_chat_members_count(chat_id)

View Source

Specs

get_chat_members_count(integer() | String.t()) ::
  {:ok, integer()} | {:error, Telegex.Model.errors()}

Use this method to get the number of members in a chat. Returns Int on success.

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.

Link to this function

get_game_high_scores(user_id, optionals \\ [])

View Source

Specs

get_game_high_scores(integer(),
  chat_id: integer(),
  message_id: integer(),
  inline_message_id: String.t()
) :: {:ok, [Telegex.Model.GameHighScore.t()]} | {:error, Telegex.Model.errors()}

Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. On success, returns an Array of Telegex.Model.GameHighScore objects.

This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and his neighbors are not among them. Please note that this behavior is subject to change.

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()}

Use this method to get the current list of the bot's commands. Requires no parameters. Returns Array of Telegex.Model.BotCommand on success.

Specs

get_sticker_set(String.t()) ::
  {:ok, Telegex.Model.StickerSet.t()} | {:error, Telegex.Model.errors()}

Use this method to get a sticker set. On success, a Telegex.Model.StickerSet object is returned.

Link to this function

get_updates(optionals \\ [])

View Source

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.

Link to this function

get_user_profile_photos(user_id, optionals \\ [])

View Source

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

get_webhook_info() ::
  {:ok, Telegex.Model.WebhookInfo.t()} | {:error, Telegex.Model.errors()}

Use this method to get current webhook status. Requires no parameters. On success, returns a Telegex.Model.WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.

Link to this function

kick_chat_member(chat_id, user_id, optionals \\ [])

View Source

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.

Link to this function

pin_chat_message(chat_id, message_id, optionals \\ [])

View Source

Specs

pin_chat_message(integer() | String.t(), integer(), [
  {:disable_notification, boolean()}
]) :: {:ok, boolean()} | {:error, Telegex.Model.errors()}

Use this method to pin a message in a group, a supergroup, or a channel. The bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in the supergroup or 'can_edit_messages' admin right in the channel. Returns True on success.

Link to this function

promote_chat_member(chat_id, user_id, optionals \\ [])

View Source

Specs

promote_chat_member(integer() | String.t(), integer(),
  can_change_info: boolean(),
  can_post_messages: boolean(),
  can_edit_messages: boolean(),
  can_delete_messages: boolean(),
  can_invite_users: boolean(),
  can_restrict_members: boolean(),
  can_pin_messages: boolean(),
  can_promote_members: boolean()
) :: {:ok, boolean()} | {:error, Telegex.Model.errors()}

Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Pass False for all boolean parameters to demote a user. Returns True on success.

Link to this function

restrict_chat_member(chat_id, user_id, permissions, optionals \\ [])

View Source

Specs

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.

Link to this function

send_animation(chat_id, animation, thumb, optionals \\ [])

View Source

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.

Link to this function

send_audio(chat_id, audio, optionals \\ [])

View Source

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.

Link to this function

send_chat_action(chat_id, action)

View Source

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.

Link to this function

send_contact(chat_id, phone_number, first_name, optionals \\ [])

View Source

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.

Link to this function

send_dice(chat_id, optionals \\ [])

View Source

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.

Link to this function

send_document(chat_id, document, optionals \\ [])

View Source

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.

Link to this function

send_game(chat_id, game_short_name, optionals \\ [])

View Source

Specs

send_game(integer(), String.t(),
  disable_notification: boolean(),
  reply_to_message_id: integer(),
  reply_markup: Telegex.Model.InlineKeyboardMarkup.t()
) :: {:ok, Telegex.Model.Message.t()} | {:error, Telegex.Model.errors()}

Use this method to send a game. On success, the sent Telegex.Model.Message is returned.

Link to this function

send_invoice(chat_id, title, description, payload, provider_token, start_parameter, currency, prices, optionals \\ [])

View Source

Specs

send_invoice(
  integer(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  [Telegex.Model.LabeledPrice.t()],
  provider_data: String.t(),
  photo_url: String.t(),
  photo_size: integer(),
  photo_width: integer(),
  photo_height: integer(),
  need_name: boolean(),
  need_phone_number: boolean(),
  need_email: boolean(),
  need_shipping_address: boolean(),
  send_phone_number_to_provider: boolean(),
  send_email_to_provider: boolean(),
  is_flexible: boolean(),
  disable_notification: boolean(),
  reply_to_message_id: integer(),
  reply_markup: Telegex.Model.InlineKeyboardMarkup.t()
) :: {:ok, Telegex.Model.Message.t()} | {:error, Telegex.Model.errors()}

Use this method to send invoices. On success, the sent Telegex.Model.Message is returned.

Link to this function

send_location(chat_id, latitude, longitude, optionals \\ [])

View Source

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.

Link to this function

send_media_group(chat_id, media, optionals \\ [])

View Source

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.

Link to this function

send_message(chat_id, text, optionals \\ [])

View Source

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.

Link to this function

send_photo(chat_id, photo, optionals \\ [])

View Source

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.

Link to this function

send_poll(chat_id, question, options, optionals \\ [])

View Source

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.

Link to this function

send_sticker(chat_id, sticker, optionals \\ [])

View Source

Specs

Use this method to send static .WEBP or animated .TGS stickers. On success, the sent Telegex.Model.Message is returned.

Link to this function

send_venue(chat_id, latitude, longitude, title, address, optionals \\ [])

View Source

Specs

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.

Link to this function

send_video(chat_id, video, optionals \\ [])

View Source

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.

Link to this function

send_video_note(chat_id, video_note, optionals \\ [])

View Source

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.

Link to this function

send_voice(chat_id, voice, optionals \\ [])

View Source

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.

Link to this function

set_chat_administrator_custom_title(chat_id, user_id, custom_title)

View Source

Specs

set_chat_administrator_custom_title(
  integer() | String.t(),
  integer(),
  String.t()
) :: {:ok, boolean()} | {:error, Telegex.Model.errors()}

Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.

Link to this function

set_chat_description(chat_id, optionals \\ [])

View Source

Specs

set_chat_description(integer() | String.t(), [{:description, String.t()}]) ::
  {:ok, boolean()} | {:error, Telegex.Model.errors()}

Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.

Link to this function

set_chat_permissions(chat_id, permissions)

View Source

Specs

set_chat_permissions(integer() | String.t(), Telegex.Model.ChatPermissions.t()) ::
  {:ok, boolean()} | {:error, Telegex.Model.errors()}

Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members admin rights. Returns True on success.

Link to this function

set_chat_photo(chat_id, photo)

View Source

Specs

set_chat_photo(integer() | String.t(), Telegex.Model.InputFile.t()) ::
  {:ok, boolean()} | {:error, Telegex.Model.errors()}

Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administratorin the chat for this to work and must have the appropriate admin rights. Returns True on success.

Link to this function

set_chat_sticker_set(chat_id, sticker_set_name)

View Source

Specs

set_chat_sticker_set(integer() | String.t(), String.t()) ::
  {:ok, boolean()} | {:error, Telegex.Model.errors()}

Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.

Link to this function

set_chat_title(chat_id, title)

View Source

Specs

set_chat_title(integer() | String.t(), String.t()) ::
  {:ok, boolean()} | {:error, Telegex.Model.errors()}

Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.

Link to this function

set_game_score(user_id, score, optionals \\ [])

View Source

Specs

set_game_score(integer(), integer(),
  force: boolean(),
  disable_edit_message: boolean(),
  chat_id: integer(),
  message_id: integer(),
  inline_message_id: String.t()
) ::
  {:ok, Telegex.Model.Message.t() | boolean()}
  | {:error, Telegex.Model.errors()}

Use this method to set the score of the specified user in a game. On success, if the message was sent by the bot, returns the edited Telegex.Model.Message, otherwise returns True. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.

Link to this function

set_my_commands(commands)

View Source

Specs

set_my_commands([Telegex.Model.BotCommand.t()]) ::
  {:ok, boolean()} | {:error, Telegex.Model.errors()}

Use this method to change the list of the bot's commands. Returns True on success.

Link to this function

set_passport_data_errors(user_id, errors)

View Source

Specs

set_passport_data_errors(integer(), [Telegex.Model.PassportElementError.t()]) ::
  {:ok, boolean()} | {:error, Telegex.Model.errors()}

Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.

Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.

Link to this function

set_sticker_position_in_set(sticker, position)

View Source

Specs

set_sticker_position_in_set(String.t(), integer()) ::
  {:ok, boolean()} | {:error, Telegex.Model.errors()}

Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.

Link to this function

set_sticker_set_thumb(sticker, user_id, optionals \\ [])

View Source

Specs

set_sticker_set_thumb(String.t(), integer(), [
  {:thumb, Telegex.Model.InputFile.t() | String.t()}
]) :: {:ok, boolean()} | {:error, Telegex.Model.errors()}

Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Returns True on success.

Link to this function

set_webhook(url, optionals \\ [])

View Source

Specs

set_webhook(String.t(),
  certificate: Telegex.Model.InputFile.t(),
  max_connections: integer(),
  allowed_updates: [String.t()]
) :: {:ok, boolean()} | {:error, Telegex.Model.errors()}

Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Telegex.Model.Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.

If you'd like to make sure that the Webhook request comes from Telegram, we recommend using a secret path in the URL, e.g. https://www.example.com/<token>. Since nobody else knows your bot's token, you can be pretty sure it's us.

Link to this function

stop_message_live_location(optionals \\ [])

View Source

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.

Link to this function

stop_poll(chat_id, message_id, optionals \\ [])

View Source

Specs

stop_poll(integer() | String.t(), integer(), [
  {:reply_markup, Telegex.Model.InlineKeyboardMarkup.t()}
]) :: {:ok, Telegex.Model.Poll.t()} | {:error, Telegex.Model.errors()}

Use this method to stop a poll which was sent by the bot. On success, the stopped Telegex.Model.Poll with the final results is returned.

Link to this function

unban_chat_member(chat_id, user_id)

View Source

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.

Link to this function

unpin_chat_message(chat_id)

View Source

Specs

unpin_chat_message(integer() | String.t()) ::
  {:ok, boolean()} | {:error, Telegex.Model.errors()}

Use this method to unpin a message in a group, a supergroup, or a channel. The bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in the supergroup or 'can_edit_messages' admin right in the channel. Returns True on success.

Link to this function

upload_sticker_file(user_id, png_sticker)

View Source

Specs

upload_sticker_file(integer(), Telegex.Model.InputFile.t()) ::
  {:ok, Telegex.Model.File.t()} | {:error, Telegex.Model.errors()}

Use this method to upload a .PNG file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded Telegex.Model.File on success.