ExGram (ex_gram v0.31.0) View Source

ExGram main supervisor that starts the bot's registry.

All the API calls are in this module. The API method's and models are auto generated and uses macros to build them.

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, tgs_sticker, or webm_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.

Unsafe version of add_sticker_to_set. It will return the response or raise in case of error.

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.

Unsafe version of answer_callback_query. It will return the response or raise in case of error.

Use this method to send answers to an inline query. On success, True is returned. No more than 50 results per query are allowed.

Unsafe version of answer_inline_query. It will return the response or raise in case of error.

Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an 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.

Unsafe version of answer_pre_checkout_query. It will return the response or raise in case of error.

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

Unsafe version of answer_shipping_query. It will return the response or raise in case of error.

Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.

Unsafe version of answer_web_app_query. It will return the response or raise in case of error.

Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

Unsafe version of approve_chat_join_request. It will return the response or raise in case of error.

Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat 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 administrator rights. Returns True on success.

Unsafe version of ban_chat_member. It will return the response or raise in case of error.

Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.

Unsafe version of ban_chat_sender_chat. It will return the response or raise in case of error.

Returns a specification to start this module under a supervisor.

Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.

Unsafe version of close. It will return the response or raise in case of error.

Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Unsafe version of close_forum_topic. It will return the response or raise in case of error.

Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

Unsafe version of close_general_forum_topic. It will return the response or raise in case of error.

Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.

Unsafe version of copy_message. It will return the response or raise in case of error.

Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.

Unsafe version of create_chat_invite_link. It will return the response or raise in case of error.

Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns information about the created topic as a ForumTopic object.

Unsafe version of create_forum_topic. It will return the response or raise in case of error.

Use this method to create a link for an invoice. Returns the created invoice link as String on success.

Unsafe version of create_invoice_link. It will return the response or raise in case of error.

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, tgs_sticker, or webm_sticker. Returns True on success.

Unsafe version of create_new_sticker_set. It will return the response or raise in case of error.

Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

Unsafe version of decline_chat_join_request. It will return the response or raise in case of error.

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 administrator rights. Returns True on success.

Unsafe version of delete_chat_photo. It will return the response or raise in case of error.

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 administrator 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.

Unsafe version of delete_chat_sticker_set. It will return the response or raise in case of error.

Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.

Unsafe version of delete_forum_topic. It will return the response or raise in case of error.

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. - Service messages about a supergroup, channel, or forum topic creation can't be deleted. - 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.

Unsafe version of delete_message. It will return the response or raise in case of error.

Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.

Unsafe version of delete_my_commands. It will return the response or raise in case of error.

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

Unsafe version of delete_sticker_from_set. It will return the response or raise in case of error.

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

Unsafe version of delete_webhook. It will return the response or raise in case of error.

Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.

Unsafe version of edit_chat_invite_link. It will return the response or raise in case of error.

Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Unsafe version of edit_forum_topic. It will return the response or raise in case of error.

Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.

Unsafe version of edit_general_forum_topic. It will return the response or raise in case of error.

Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Unsafe version of edit_message_caption. It will return the response or raise in case of error.

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 is not an inline message, the edited Message is returned, otherwise True is returned.

Unsafe version of edit_message_live_location. It will return the response or raise in case of error.

Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Unsafe version of edit_message_media. It will return the response or raise in case of error.

Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Unsafe version of edit_message_reply_markup. It will return the response or raise in case of error.

Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Unsafe version of edit_message_text. It will return the response or raise in case of error.

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

Unsafe version of export_chat_invite_link. It will return the response or raise in case of error.

Use this method to forward messages of any kind. Service messages can't be forwarded. On success, the sent Message is returned.

Unsafe version of forward_message. It will return the response or raise in case of error.

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 Chat object on success.

Unsafe version of get_chat. It will return the response or raise in case of error.

Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects.

Unsafe version of get_chat_administrators. It will return the response or raise in case of error.

Use this method to get information about a member of a chat. The method is guaranteed to work only if the bot is an administrator in the chat. Returns a ChatMember object on success.

Unsafe version of get_chat_member. It will return the response or raise in case of error.

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

Unsafe version of get_chat_member_count. It will return the response or raise in case of error.

Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success.

Unsafe version of get_chat_menu_button. It will return the response or raise in case of error.

Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.

Unsafe version of get_custom_emoji_stickers. It will return the response or raise in case of error.

Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a 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.

Unsafe version of get_file. It will return the response or raise in case of error.

Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects.

Unsafe version of get_forum_topic_icon_stickers. It will return the response or raise in case of error.

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. Returns an Array of GameHighScore objects.

Unsafe version of get_game_high_scores. It will return the response or raise in case of error.

A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object.

Unsafe version of get_me. It will return the response or raise in case of error.

Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned.

Unsafe version of get_my_commands. It will return the response or raise in case of error.

Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.

Unsafe version of get_my_default_administrator_rights. It will return the response or raise in case of error.

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

Unsafe version of get_sticker_set. It will return the response or raise in case of error.

Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.

Unsafe version of get_updates. It will return the response or raise in case of error.

Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.

Unsafe version of get_user_profile_photos. It will return the response or raise in case of error.

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

Unsafe version of get_webhook_info. It will return the response or raise in case of error.

Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.

Unsafe version of hide_general_forum_topic. It will return the response or raise in case of error.

Callback implementation for Supervisor.init/1.

Use this method for your bot to leave a group, supergroup or channel. Returns True on success.

Unsafe version of leave_chat. It will return the response or raise in case of error.

Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.

Unsafe version of log_out. It will return the response or raise in case of error.

Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.

Unsafe version of pin_chat_message. It will return the response or raise in case of error.

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 administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.

Unsafe version of promote_chat_member. It will return the response or raise in case of error.

Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Unsafe version of reopen_forum_topic. It will return the response or raise in case of error.

Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.

Unsafe version of reopen_general_forum_topic. It will return the response or raise in case of error.

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 administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.

Unsafe version of restrict_chat_member. It will return the response or raise in case of error.

Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.

Unsafe version of revoke_chat_invite_link. It will return the response or raise in case of error.

Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.

Unsafe version of send_animation. It will return the response or raise in case of error.

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 Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.

Unsafe version of send_audio. It will return the response or raise in case of error.

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.

Unsafe version of send_chat_action. It will return the response or raise in case of error.

Use this method to send phone contacts. On success, the sent Message is returned.

Unsafe version of send_contact. It will return the response or raise in case of error.

Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.

Unsafe version of send_dice. It will return the response or raise in case of error.

Use this method to send general files. On success, the sent 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.

Unsafe version of send_document. It will return the response or raise in case of error.

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

Unsafe version of send_game. It will return the response or raise in case of error.

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

Unsafe version of send_invoice. It will return the response or raise in case of error.

Use this method to send point on the map. On success, the sent Message is returned.

Unsafe version of send_location. It will return the response or raise in case of error.

Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned.

Unsafe version of send_media_group. It will return the response or raise in case of error.

Use this method to send text messages. On success, the sent Message is returned.

Unsafe version of send_message. It will return the response or raise in case of error.

Use this method to send photos. On success, the sent Message is returned.

Unsafe version of send_photo. It will return the response or raise in case of error.

Use this method to send a native poll. On success, the sent Message is returned.

Unsafe version of send_poll. It will return the response or raise in case of error.

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

Unsafe version of send_sticker. It will return the response or raise in case of error.

Use this method to send information about a venue. On success, the sent Message is returned.

Unsafe version of send_venue. It will return the response or raise in case of error.

Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.

Unsafe version of send_video. It will return the response or raise in case of error.

As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.

Unsafe version of send_video_note. It will return the response or raise in case of error.

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 Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.

Unsafe version of send_voice. It will return the response or raise in case of error.

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

Unsafe version of set_chat_administrator_custom_title. It will return the response or raise in case of error.

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 administrator rights. Returns True on success.

Unsafe version of set_chat_description. It will return the response or raise in case of error.

Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success.

Unsafe version of set_chat_menu_button. It will return the response or raise in case of error.

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 administrator rights. Returns True on success.

Unsafe version of set_chat_permissions. It will return the response or raise in case of error.

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 administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Unsafe version of set_chat_photo. It will return the response or raise in case of error.

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 administrator 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.

Unsafe version of set_chat_sticker_set. It will return the response or raise in case of error.

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 administrator rights. Returns True on success.

Unsafe version of set_chat_title. It will return the response or raise in case of error.

Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.

Unsafe version of set_game_score. It will return the response or raise in case of error.

Use this method to change the list of the bot's commands. See this manual for more details about bot commands. Returns True on success.

Unsafe version of set_my_commands. It will return the response or raise in case of error.

Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are are free to modify the list before adding the bot. Returns True on success.

Unsafe version of set_my_default_administrator_rights. It will return the response or raise in case of error.

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.

Unsafe version of set_passport_data_errors. It will return the response or raise in case of error.

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

Unsafe version of set_sticker_position_in_set. It will return the response or raise in case of error.

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

Unsafe version of set_sticker_set_thumb. It will return the response or raise in case of error.

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 Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.

Unsafe version of set_webhook. It will return the response or raise in case of error.

Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.

Unsafe version of stop_message_live_location. It will return the response or raise in case of error.

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

Unsafe version of stop_poll. It will return the response or raise in case of error.

Use this method to unban a previously banned 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. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.

Unsafe version of unban_chat_member. It will return the response or raise in case of error.

Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.

Unsafe version of unban_chat_sender_chat. It will return the response or raise in case of error.

Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

Unsafe version of unhide_general_forum_topic. It will return the response or raise in case of error.

Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.

Unsafe version of unpin_all_chat_messages. It will return the response or raise in case of error.

Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.

Unsafe version of unpin_all_forum_topic_messages. It will return the response or raise in case of error.

Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.

Unsafe version of unpin_chat_message. It will return the response or raise in case of error.

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 File on success.

Unsafe version of upload_sticker_file. It will return the response or raise in case of error.

Link to this section Functions

Link to this function

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

View Source

Specs

add_sticker_to_set(
  user_id :: integer(),
  name :: String.t(),
  emojis :: String.t(),
  options :: [
    png_sticker:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    tgs_sticker:
      {:file, String.t()} | {:file_content, iodata() | Enum.t(), String.t()},
    webm_sticker:
      {:file, String.t()} | {:file_content, iodata() | Enum.t(), String.t()},
    mask_position: ExGram.Model.MaskPosition.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

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, tgs_sticker, or webm_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.

Check the documentation of this method in https://core.telegram.org/bots/api#addstickertoset

Link to this function

add_sticker_to_set!(user_id, name, emojis, ops \\ [])

View Source

Specs

add_sticker_to_set!(
  user_id :: integer(),
  name :: String.t(),
  emojis :: String.t(),
  ops :: [
    png_sticker:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    tgs_sticker:
      {:file, String.t()} | {:file_content, iodata() | Enum.t(), String.t()},
    webm_sticker:
      {:file, String.t()} | {:file_content, iodata() | Enum.t(), String.t()},
    mask_position: ExGram.Model.MaskPosition.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of add_sticker_to_set. It will return the response or raise in case of error.

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, tgs_sticker, or webm_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.

Check the documentation of this method in https://core.telegram.org/bots/api#addstickertoset

Link to this function

answer_callback_query(callback_query_id, options \\ [])

View Source

Specs

answer_callback_query(
  callback_query_id :: String.t(),
  options :: [
    text: String.t(),
    show_alert: boolean(),
    url: String.t(),
    cache_time: integer(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

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.

Check the documentation of this method in https://core.telegram.org/bots/api#answercallbackquery

Link to this function

answer_callback_query!(callback_query_id, ops \\ [])

View Source

Specs

answer_callback_query!(
  callback_query_id :: String.t(),
  ops :: [
    text: String.t(),
    show_alert: boolean(),
    url: String.t(),
    cache_time: integer(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of answer_callback_query. It will return the response or raise in case of error.

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.

Check the documentation of this method in https://core.telegram.org/bots/api#answercallbackquery

Link to this function

answer_inline_query(inline_query_id, results, options \\ [])

View Source

Specs

answer_inline_query(
  inline_query_id :: String.t(),
  results :: [ExGram.Model.InlineQueryResult.t()],
  options :: [
    cache_time: integer(),
    is_personal: boolean(),
    next_offset: String.t(),
    switch_pm_text: String.t(),
    switch_pm_parameter: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to send answers to an inline query. On success, True is returned. No more than 50 results per query are allowed.

Check the documentation of this method in https://core.telegram.org/bots/api#answerinlinequery

Link to this function

answer_inline_query!(inline_query_id, results, ops \\ [])

View Source

Specs

answer_inline_query!(
  inline_query_id :: String.t(),
  results :: [ExGram.Model.InlineQueryResult.t()],
  ops :: [
    cache_time: integer(),
    is_personal: boolean(),
    next_offset: String.t(),
    switch_pm_text: String.t(),
    switch_pm_parameter: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of answer_inline_query. It will return the response or raise in case of error.

Use this method to send answers to an inline query. On success, True is returned. No more than 50 results per query are allowed.

Check the documentation of this method in https://core.telegram.org/bots/api#answerinlinequery

Link to this function

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

View Source

Specs

answer_pre_checkout_query(
  pre_checkout_query_id :: String.t(),
  ok :: boolean(),
  options :: [
    error_message: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an 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.

Check the documentation of this method in https://core.telegram.org/bots/api#answerprecheckoutquery

Link to this function

answer_pre_checkout_query!(pre_checkout_query_id, ok, ops \\ [])

View Source

Specs

answer_pre_checkout_query!(
  pre_checkout_query_id :: String.t(),
  ok :: boolean(),
  ops :: [
    error_message: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of answer_pre_checkout_query. It will return the response or raise in case of error.

Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an 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.

Check the documentation of this method in https://core.telegram.org/bots/api#answerprecheckoutquery

Link to this function

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

View Source

Specs

answer_shipping_query(
  shipping_query_id :: String.t(),
  ok :: boolean(),
  options :: [
    shipping_options: [ExGram.Model.ShippingOption.t()],
    error_message: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

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

Check the documentation of this method in https://core.telegram.org/bots/api#answershippingquery

Link to this function

answer_shipping_query!(shipping_query_id, ok, ops \\ [])

View Source

Specs

answer_shipping_query!(
  shipping_query_id :: String.t(),
  ok :: boolean(),
  ops :: [
    shipping_options: [ExGram.Model.ShippingOption.t()],
    error_message: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of answer_shipping_query. It will return the response or raise in case of error.

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

Check the documentation of this method in https://core.telegram.org/bots/api#answershippingquery

Link to this function

answer_web_app_query(web_app_query_id, result, options \\ [])

View Source

Specs

answer_web_app_query(
  web_app_query_id :: String.t(),
  result :: ExGram.Model.InlineQueryResult.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.SentWebAppMessage.t()} | {:error, ExGram.Error.t()}

Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#answerwebappquery

Link to this function

answer_web_app_query!(web_app_query_id, result, ops \\ [])

View Source

Specs

answer_web_app_query!(
  web_app_query_id :: String.t(),
  result :: ExGram.Model.InlineQueryResult.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.SentWebAppMessage.t()

Unsafe version of answer_web_app_query. It will return the response or raise in case of error.

Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#answerwebappquery

Link to this function

approve_chat_join_request(chat_id, user_id, options \\ [])

View Source

Specs

approve_chat_join_request(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#approvechatjoinrequest

Link to this function

approve_chat_join_request!(chat_id, user_id, ops \\ [])

View Source

Specs

approve_chat_join_request!(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of approve_chat_join_request. It will return the response or raise in case of error.

Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#approvechatjoinrequest

Link to this function

ban_chat_member(chat_id, user_id, options \\ [])

View Source

Specs

ban_chat_member(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  options :: [
    until_date: integer(),
    revoke_messages: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat 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 administrator rights. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#banchatmember

Link to this function

ban_chat_member!(chat_id, user_id, ops \\ [])

View Source

Specs

ban_chat_member!(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  ops :: [
    until_date: integer(),
    revoke_messages: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of ban_chat_member. It will return the response or raise in case of error.

Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat 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 administrator rights. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#banchatmember

Link to this function

ban_chat_sender_chat(chat_id, sender_chat_id, options \\ [])

View Source

Specs

ban_chat_sender_chat(
  chat_id :: integer() | String.t(),
  sender_chat_id :: integer(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#banchatsenderchat

Link to this function

ban_chat_sender_chat!(chat_id, sender_chat_id, ops \\ [])

View Source

Specs

ban_chat_sender_chat!(
  chat_id :: integer() | String.t(),
  sender_chat_id :: integer(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of ban_chat_sender_chat. It will return the response or raise in case of error.

Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#banchatsenderchat

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

close(chat_id, text, options \\ [])

View Source

Specs

close(
  chat_id :: integer() | String.t(),
  text :: String.t(),
  options :: [
    message_thread_id: integer(),
    parse_mode: String.t(),
    entities: [ExGram.Model.MessageEntity.t()],
    disable_web_page_preview: boolean(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.

Check the documentation of this method in https://core.telegram.org/bots/api#close

Link to this function

close!(chat_id, text, ops \\ [])

View Source

Specs

close!(
  chat_id :: integer() | String.t(),
  text :: String.t(),
  ops :: [
    message_thread_id: integer(),
    parse_mode: String.t(),
    entities: [ExGram.Model.MessageEntity.t()],
    disable_web_page_preview: boolean(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of close. It will return the response or raise in case of error.

Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.

Check the documentation of this method in https://core.telegram.org/bots/api#close

Link to this function

close_forum_topic(chat_id, message_thread_id, options \\ [])

View Source

Specs

close_forum_topic(
  chat_id :: integer() | String.t(),
  message_thread_id :: integer(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#closeforumtopic

Link to this function

close_forum_topic!(chat_id, message_thread_id, ops \\ [])

View Source

Specs

close_forum_topic!(
  chat_id :: integer() | String.t(),
  message_thread_id :: integer(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of close_forum_topic. It will return the response or raise in case of error.

Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#closeforumtopic

Link to this function

close_general_forum_topic(chat_id, options \\ [])

View Source

Specs

close_general_forum_topic(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#closegeneralforumtopic

Link to this function

close_general_forum_topic!(chat_id, ops \\ [])

View Source

Specs

close_general_forum_topic!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of close_general_forum_topic. It will return the response or raise in case of error.

Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#closegeneralforumtopic

Link to this function

copy_message(chat_id, from_chat_id, message_id, options \\ [])

View Source

Specs

copy_message(
  chat_id :: integer() | String.t(),
  from_chat_id :: integer() | String.t(),
  message_id :: integer(),
  options :: [
    message_thread_id: integer(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.MessageId.t()} | {:error, ExGram.Error.t()}

Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.

Check the documentation of this method in https://core.telegram.org/bots/api#copymessage

Link to this function

copy_message!(chat_id, from_chat_id, message_id, ops \\ [])

View Source

Specs

copy_message!(
  chat_id :: integer() | String.t(),
  from_chat_id :: integer() | String.t(),
  message_id :: integer(),
  ops :: [
    message_thread_id: integer(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.MessageId.t()

Unsafe version of copy_message. It will return the response or raise in case of error.

Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.

Check the documentation of this method in https://core.telegram.org/bots/api#copymessage

Link to this function

create_chat_invite_link(chat_id, options \\ [])

View Source

Specs

create_chat_invite_link(
  chat_id :: integer() | String.t(),
  options :: [
    name: String.t(),
    expire_date: integer(),
    member_limit: integer(),
    creates_join_request: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.ChatInviteLink.t()} | {:error, ExGram.Error.t()}

Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.

Check the documentation of this method in https://core.telegram.org/bots/api#createchatinvitelink

Link to this function

create_chat_invite_link!(chat_id, ops \\ [])

View Source

Specs

create_chat_invite_link!(
  chat_id :: integer() | String.t(),
  ops :: [
    name: String.t(),
    expire_date: integer(),
    member_limit: integer(),
    creates_join_request: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.ChatInviteLink.t()

Unsafe version of create_chat_invite_link. It will return the response or raise in case of error.

Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.

Check the documentation of this method in https://core.telegram.org/bots/api#createchatinvitelink

Link to this function

create_forum_topic(chat_id, name, options \\ [])

View Source

Specs

create_forum_topic(
  chat_id :: integer() | String.t(),
  name :: String.t(),
  options :: [
    icon_color: integer(),
    icon_custom_emoji_id: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.ForumTopic.t()} | {:error, ExGram.Error.t()}

Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns information about the created topic as a ForumTopic object.

Check the documentation of this method in https://core.telegram.org/bots/api#createforumtopic

Link to this function

create_forum_topic!(chat_id, name, ops \\ [])

View Source

Specs

create_forum_topic!(
  chat_id :: integer() | String.t(),
  name :: String.t(),
  ops :: [
    icon_color: integer(),
    icon_custom_emoji_id: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.ForumTopic.t()

Unsafe version of create_forum_topic. It will return the response or raise in case of error.

Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns information about the created topic as a ForumTopic object.

Check the documentation of this method in https://core.telegram.org/bots/api#createforumtopic

Link to this function

create_invoice_link(title, description, payload, provider_token, currency, prices, options \\ [])

View Source

Specs

create_invoice_link(
  title :: String.t(),
  description :: String.t(),
  payload :: String.t(),
  provider_token :: String.t(),
  currency :: String.t(),
  prices :: [ExGram.Model.LabeledPrice.t()],
  options :: [
    max_tip_amount: integer(),
    suggested_tip_amounts: [integer()],
    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(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, String.t()} | {:error, ExGram.Error.t()}

Use this method to create a link for an invoice. Returns the created invoice link as String on success.

Check the documentation of this method in https://core.telegram.org/bots/api#createinvoicelink

Link to this function

create_invoice_link!(title, description, payload, provider_token, currency, prices, ops \\ [])

View Source

Specs

create_invoice_link!(
  title :: String.t(),
  description :: String.t(),
  payload :: String.t(),
  provider_token :: String.t(),
  currency :: String.t(),
  prices :: [ExGram.Model.LabeledPrice.t()],
  ops :: [
    max_tip_amount: integer(),
    suggested_tip_amounts: [integer()],
    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(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: String.t()

Unsafe version of create_invoice_link. It will return the response or raise in case of error.

Use this method to create a link for an invoice. Returns the created invoice link as String on success.

Check the documentation of this method in https://core.telegram.org/bots/api#createinvoicelink

Link to this function

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

View Source

Specs

create_new_sticker_set(
  user_id :: integer(),
  name :: String.t(),
  title :: String.t(),
  emojis :: String.t(),
  options :: [
    png_sticker:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    tgs_sticker:
      {:file, String.t()} | {:file_content, iodata() | Enum.t(), String.t()},
    webm_sticker:
      {:file, String.t()} | {:file_content, iodata() | Enum.t(), String.t()},
    sticker_type: String.t(),
    mask_position: ExGram.Model.MaskPosition.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

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, tgs_sticker, or webm_sticker. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#createnewstickerset

Link to this function

create_new_sticker_set!(user_id, name, title, emojis, ops \\ [])

View Source

Specs

create_new_sticker_set!(
  user_id :: integer(),
  name :: String.t(),
  title :: String.t(),
  emojis :: String.t(),
  ops :: [
    png_sticker:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    tgs_sticker:
      {:file, String.t()} | {:file_content, iodata() | Enum.t(), String.t()},
    webm_sticker:
      {:file, String.t()} | {:file_content, iodata() | Enum.t(), String.t()},
    sticker_type: String.t(),
    mask_position: ExGram.Model.MaskPosition.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of create_new_sticker_set. It will return the response or raise in case of error.

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, tgs_sticker, or webm_sticker. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#createnewstickerset

Link to this function

decline_chat_join_request(chat_id, user_id, options \\ [])

View Source

Specs

decline_chat_join_request(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#declinechatjoinrequest

Link to this function

decline_chat_join_request!(chat_id, user_id, ops \\ [])

View Source

Specs

decline_chat_join_request!(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of decline_chat_join_request. It will return the response or raise in case of error.

Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#declinechatjoinrequest

Link to this function

delete_chat_photo(chat_id, options \\ [])

View Source

Specs

delete_chat_photo(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

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 administrator rights. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#deletechatphoto

Link to this function

delete_chat_photo!(chat_id, ops \\ [])

View Source

Specs

delete_chat_photo!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of delete_chat_photo. It will return the response or raise in case of error.

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 administrator rights. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#deletechatphoto

Link to this function

delete_chat_sticker_set(chat_id, options \\ [])

View Source

Specs

delete_chat_sticker_set(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

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 administrator 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.

Check the documentation of this method in https://core.telegram.org/bots/api#deletechatstickerset

Link to this function

delete_chat_sticker_set!(chat_id, ops \\ [])

View Source

Specs

delete_chat_sticker_set!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of delete_chat_sticker_set. It will return the response or raise in case of error.

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 administrator 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.

Check the documentation of this method in https://core.telegram.org/bots/api#deletechatstickerset

Link to this function

delete_forum_topic(chat_id, message_thread_id, options \\ [])

View Source

Specs

delete_forum_topic(
  chat_id :: integer() | String.t(),
  message_thread_id :: integer(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#deleteforumtopic

Link to this function

delete_forum_topic!(chat_id, message_thread_id, ops \\ [])

View Source

Specs

delete_forum_topic!(
  chat_id :: integer() | String.t(),
  message_thread_id :: integer(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of delete_forum_topic. It will return the response or raise in case of error.

Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#deleteforumtopic

Link to this function

delete_message(chat_id, message_id, options \\ [])

View Source

Specs

delete_message(
  chat_id :: integer() | String.t(),
  message_id :: integer(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

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. - Service messages about a supergroup, channel, or forum topic creation can't be deleted. - 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.

Check the documentation of this method in https://core.telegram.org/bots/api#deletemessage

Link to this function

delete_message!(chat_id, message_id, ops \\ [])

View Source

Specs

delete_message!(
  chat_id :: integer() | String.t(),
  message_id :: integer(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of delete_message. It will return the response or raise in case of error.

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. - Service messages about a supergroup, channel, or forum topic creation can't be deleted. - 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.

Check the documentation of this method in https://core.telegram.org/bots/api#deletemessage

Link to this function

delete_my_commands(options \\ [])

View Source

Specs

delete_my_commands(
  options :: [
    scope: ExGram.Model.BotCommandScope.t(),
    language_code: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#deletemycommands

Link to this function

delete_my_commands!(ops \\ [])

View Source

Specs

delete_my_commands!(
  ops :: [
    scope: ExGram.Model.BotCommandScope.t(),
    language_code: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of delete_my_commands. It will return the response or raise in case of error.

Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#deletemycommands

Link to this function

delete_sticker_from_set(sticker, options \\ [])

View Source

Specs

delete_sticker_from_set(
  sticker :: String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

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

Check the documentation of this method in https://core.telegram.org/bots/api#deletestickerfromset

Link to this function

delete_sticker_from_set!(sticker, ops \\ [])

View Source

Specs

delete_sticker_from_set!(
  sticker :: String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of delete_sticker_from_set. It will return the response or raise in case of error.

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

Check the documentation of this method in https://core.telegram.org/bots/api#deletestickerfromset

Link to this function

delete_webhook(options \\ [])

View Source

Specs

delete_webhook(
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

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

Check the documentation of this method in https://core.telegram.org/bots/api#deletewebhook

Link to this function

delete_webhook!(ops \\ [])

View Source

Specs

delete_webhook!(
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of delete_webhook. It will return the response or raise in case of error.

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

Check the documentation of this method in https://core.telegram.org/bots/api#deletewebhook

Link to this function

edit_chat_invite_link(chat_id, invite_link, options \\ [])

View Source

Specs

edit_chat_invite_link(
  chat_id :: integer() | String.t(),
  invite_link :: String.t(),
  options :: [
    name: String.t(),
    expire_date: integer(),
    member_limit: integer(),
    creates_join_request: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.ChatInviteLink.t()} | {:error, ExGram.Error.t()}

Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.

Check the documentation of this method in https://core.telegram.org/bots/api#editchatinvitelink

Link to this function

edit_chat_invite_link!(chat_id, invite_link, ops \\ [])

View Source

Specs

edit_chat_invite_link!(
  chat_id :: integer() | String.t(),
  invite_link :: String.t(),
  ops :: [
    name: String.t(),
    expire_date: integer(),
    member_limit: integer(),
    creates_join_request: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.ChatInviteLink.t()

Unsafe version of edit_chat_invite_link. It will return the response or raise in case of error.

Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.

Check the documentation of this method in https://core.telegram.org/bots/api#editchatinvitelink

Link to this function

edit_forum_topic(chat_id, message_thread_id, options \\ [])

View Source

Specs

edit_forum_topic(
  chat_id :: integer() | String.t(),
  message_thread_id :: integer(),
  options :: [
    name: String.t(),
    icon_custom_emoji_id: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#editforumtopic

Link to this function

edit_forum_topic!(chat_id, message_thread_id, ops \\ [])

View Source

Specs

edit_forum_topic!(
  chat_id :: integer() | String.t(),
  message_thread_id :: integer(),
  ops :: [
    name: String.t(),
    icon_custom_emoji_id: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of edit_forum_topic. It will return the response or raise in case of error.

Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#editforumtopic

Link to this function

edit_general_forum_topic(chat_id, name, options \\ [])

View Source

Specs

edit_general_forum_topic(
  chat_id :: integer() | String.t(),
  name :: String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#editgeneralforumtopic

Link to this function

edit_general_forum_topic!(chat_id, name, ops \\ [])

View Source

Specs

edit_general_forum_topic!(
  chat_id :: integer() | String.t(),
  name :: String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of edit_general_forum_topic. It will return the response or raise in case of error.

Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#editgeneralforumtopic

Link to this function

edit_message_caption(options \\ [])

View Source

Specs

edit_message_caption(
  options :: [
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#editmessagecaption

Link to this function

edit_message_caption!(ops \\ [])

View Source

Specs

edit_message_caption!(
  ops :: [
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of edit_message_caption. It will return the response or raise in case of error.

Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#editmessagecaption

Link to this function

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

View Source

Specs

edit_message_live_location(
  latitude :: float(),
  longitude :: float(),
  options :: [
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    horizontal_accuracy: float(),
    heading: integer(),
    proximity_alert_radius: integer(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

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 is not an inline message, the edited Message is returned, otherwise True is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#editmessagelivelocation

Link to this function

edit_message_live_location!(latitude, longitude, ops \\ [])

View Source

Specs

edit_message_live_location!(
  latitude :: float(),
  longitude :: float(),
  ops :: [
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    horizontal_accuracy: float(),
    heading: integer(),
    proximity_alert_radius: integer(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of edit_message_live_location. It will return the response or raise in case of error.

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 is not an inline message, the edited Message is returned, otherwise True is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#editmessagelivelocation

Link to this function

edit_message_media(media, options \\ [])

View Source

Specs

edit_message_media(
  media :: ExGram.Model.InputMedia.t(),
  options :: [
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#editmessagemedia

Link to this function

edit_message_media!(media, ops \\ [])

View Source

Specs

edit_message_media!(
  media :: ExGram.Model.InputMedia.t(),
  ops :: [
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of edit_message_media. It will return the response or raise in case of error.

Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#editmessagemedia

Link to this function

edit_message_reply_markup(options \\ [])

View Source

Specs

edit_message_reply_markup(
  options :: [
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#editmessagereplymarkup

Link to this function

edit_message_reply_markup!(ops \\ [])

View Source

Specs

edit_message_reply_markup!(
  ops :: [
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of edit_message_reply_markup. It will return the response or raise in case of error.

Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#editmessagereplymarkup

Link to this function

edit_message_text(text, options \\ [])

View Source

Specs

edit_message_text(
  text :: String.t(),
  options :: [
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    parse_mode: String.t(),
    entities: [ExGram.Model.MessageEntity.t()],
    disable_web_page_preview: boolean(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#editmessagetext

Link to this function

edit_message_text!(text, ops \\ [])

View Source

Specs

edit_message_text!(
  text :: String.t(),
  ops :: [
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    parse_mode: String.t(),
    entities: [ExGram.Model.MessageEntity.t()],
    disable_web_page_preview: boolean(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of edit_message_text. It will return the response or raise in case of error.

Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#editmessagetext

Link to this function

export_chat_invite_link(chat_id, options \\ [])

View Source

Specs

export_chat_invite_link(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, String.t()} | {:error, ExGram.Error.t()}

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

Check the documentation of this method in https://core.telegram.org/bots/api#exportchatinvitelink

Link to this function

export_chat_invite_link!(chat_id, ops \\ [])

View Source

Specs

export_chat_invite_link!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: String.t()

Unsafe version of export_chat_invite_link. It will return the response or raise in case of error.

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

Check the documentation of this method in https://core.telegram.org/bots/api#exportchatinvitelink

Link to this function

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

View Source

Specs

forward_message(
  chat_id :: integer() | String.t(),
  from_chat_id :: integer() | String.t(),
  message_id :: integer(),
  options :: [
    message_thread_id: integer(),
    disable_notification: boolean(),
    protect_content: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Use this method to forward messages of any kind. Service messages can't be forwarded. On success, the sent Message is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#forwardmessage

Link to this function

forward_message!(chat_id, from_chat_id, message_id, ops \\ [])

View Source

Specs

forward_message!(
  chat_id :: integer() | String.t(),
  from_chat_id :: integer() | String.t(),
  message_id :: integer(),
  ops :: [
    message_thread_id: integer(),
    disable_notification: boolean(),
    protect_content: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of forward_message. It will return the response or raise in case of error.

Use this method to forward messages of any kind. Service messages can't be forwarded. On success, the sent Message is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#forwardmessage

Link to this function

get_chat(chat_id, options \\ [])

View Source

Specs

get_chat(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Chat.t()} | {:error, ExGram.Error.t()}

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 Chat object on success.

Check the documentation of this method in https://core.telegram.org/bots/api#getchat

Link to this function

get_chat!(chat_id, ops \\ [])

View Source

Specs

get_chat!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Chat.t()

Unsafe version of get_chat. It will return the response or raise in case of error.

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 Chat object on success.

Check the documentation of this method in https://core.telegram.org/bots/api#getchat

Link to this function

get_chat_administrators(chat_id, options \\ [])

View Source

Specs

get_chat_administrators(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.ChatMember.t()} | {:error, ExGram.Error.t()}

Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects.

Check the documentation of this method in https://core.telegram.org/bots/api#getchatadministrators

Link to this function

get_chat_administrators!(chat_id, ops \\ [])

View Source

Specs

get_chat_administrators!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.ChatMember.t()

Unsafe version of get_chat_administrators. It will return the response or raise in case of error.

Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects.

Check the documentation of this method in https://core.telegram.org/bots/api#getchatadministrators

Link to this function

get_chat_member(chat_id, user_id, options \\ [])

View Source

Specs

get_chat_member(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.ChatMember.t()} | {:error, ExGram.Error.t()}

Use this method to get information about a member of a chat. The method is guaranteed to work only if the bot is an administrator in the chat. Returns a ChatMember object on success.

Check the documentation of this method in https://core.telegram.org/bots/api#getchatmember

Link to this function

get_chat_member!(chat_id, user_id, ops \\ [])

View Source

Specs

get_chat_member!(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.ChatMember.t()

Unsafe version of get_chat_member. It will return the response or raise in case of error.

Use this method to get information about a member of a chat. The method is guaranteed to work only if the bot is an administrator in the chat. Returns a ChatMember object on success.

Check the documentation of this method in https://core.telegram.org/bots/api#getchatmember

Link to this function

get_chat_member_count(chat_id, options \\ [])

View Source

Specs

get_chat_member_count(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, integer()} | {:error, ExGram.Error.t()}

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

Check the documentation of this method in https://core.telegram.org/bots/api#getchatmembercount

Link to this function

get_chat_member_count!(chat_id, ops \\ [])

View Source

Specs

get_chat_member_count!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: integer()

Unsafe version of get_chat_member_count. It will return the response or raise in case of error.

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

Check the documentation of this method in https://core.telegram.org/bots/api#getchatmembercount

Link to this function

get_chat_menu_button(options \\ [])

View Source

Specs

get_chat_menu_button(
  options :: [
    chat_id: integer(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.MenuButton.t()} | {:error, ExGram.Error.t()}

Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success.

Check the documentation of this method in https://core.telegram.org/bots/api#getchatmenubutton

Link to this function

get_chat_menu_button!(ops \\ [])

View Source

Specs

get_chat_menu_button!(
  ops :: [
    chat_id: integer(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.MenuButton.t()

Unsafe version of get_chat_menu_button. It will return the response or raise in case of error.

Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success.

Check the documentation of this method in https://core.telegram.org/bots/api#getchatmenubutton

Link to this function

get_custom_emoji_stickers(custom_emoji_ids, options \\ [])

View Source

Specs

get_custom_emoji_stickers(
  custom_emoji_ids :: [String.t()],
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Sticker.t()} | {:error, ExGram.Error.t()}

Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.

Check the documentation of this method in https://core.telegram.org/bots/api#getcustomemojistickers

Link to this function

get_custom_emoji_stickers!(custom_emoji_ids, ops \\ [])

View Source

Specs

get_custom_emoji_stickers!(
  custom_emoji_ids :: [String.t()],
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Sticker.t()

Unsafe version of get_custom_emoji_stickers. It will return the response or raise in case of error.

Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.

Check the documentation of this method in https://core.telegram.org/bots/api#getcustomemojistickers

Link to this function

get_file(file_id, options \\ [])

View Source

Specs

get_file(
  file_id :: String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.File.t()} | {:error, ExGram.Error.t()}

Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a 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.

Check the documentation of this method in https://core.telegram.org/bots/api#getfile

Link to this function

get_file!(file_id, ops \\ [])

View Source

Specs

get_file!(
  file_id :: String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.File.t()

Unsafe version of get_file. It will return the response or raise in case of error.

Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a 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.

Check the documentation of this method in https://core.telegram.org/bots/api#getfile

Link to this function

get_forum_topic_icon_stickers(chat_id, name, options \\ [])

View Source

Specs

get_forum_topic_icon_stickers(
  chat_id :: integer() | String.t(),
  name :: String.t(),
  options :: [
    icon_color: integer(),
    icon_custom_emoji_id: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Sticker.t()} | {:error, ExGram.Error.t()}

Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects.

Check the documentation of this method in https://core.telegram.org/bots/api#getforumtopiciconstickers

Link to this function

get_forum_topic_icon_stickers!(chat_id, name, ops \\ [])

View Source

Specs

get_forum_topic_icon_stickers!(
  chat_id :: integer() | String.t(),
  name :: String.t(),
  ops :: [
    icon_color: integer(),
    icon_custom_emoji_id: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Sticker.t()

Unsafe version of get_forum_topic_icon_stickers. It will return the response or raise in case of error.

Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects.

Check the documentation of this method in https://core.telegram.org/bots/api#getforumtopiciconstickers

Link to this function

get_game_high_scores(user_id, options \\ [])

View Source

Specs

get_game_high_scores(
  user_id :: integer(),
  options :: [
    chat_id: integer(),
    message_id: integer(),
    inline_message_id: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.GameHighScore.t()} | {:error, ExGram.Error.t()}

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. Returns an Array of GameHighScore objects.

Check the documentation of this method in https://core.telegram.org/bots/api#getgamehighscores

Link to this function

get_game_high_scores!(user_id, ops \\ [])

View Source

Specs

get_game_high_scores!(
  user_id :: integer(),
  ops :: [
    chat_id: integer(),
    message_id: integer(),
    inline_message_id: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.GameHighScore.t()

Unsafe version of get_game_high_scores. It will return the response or raise in case of error.

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. Returns an Array of GameHighScore objects.

Check the documentation of this method in https://core.telegram.org/bots/api#getgamehighscores

Specs

get_me(
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.User.t()} | {:error, ExGram.Error.t()}

A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object.

Check the documentation of this method in https://core.telegram.org/bots/api#getme

Specs

get_me!(
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.User.t()

Unsafe version of get_me. It will return the response or raise in case of error.

A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object.

Check the documentation of this method in https://core.telegram.org/bots/api#getme

Link to this function

get_my_commands(options \\ [])

View Source

Specs

get_my_commands(
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.BotCommand.t()} | {:error, ExGram.Error.t()}

Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#getmycommands

Link to this function

get_my_commands!(ops \\ [])

View Source

Specs

get_my_commands!(
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.BotCommand.t()

Unsafe version of get_my_commands. It will return the response or raise in case of error.

Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#getmycommands

Link to this function

get_my_default_administrator_rights(options \\ [])

View Source

Specs

get_my_default_administrator_rights(
  options :: [
    for_channels: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) ::
  {:ok, ExGram.Model.ChatAdministratorRights.t()} | {:error, ExGram.Error.t()}

Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.

Check the documentation of this method in https://core.telegram.org/bots/api#getmydefaultadministratorrights

Link to this function

get_my_default_administrator_rights!(ops \\ [])

View Source

Specs

get_my_default_administrator_rights!(
  ops :: [
    for_channels: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.ChatAdministratorRights.t()

Unsafe version of get_my_default_administrator_rights. It will return the response or raise in case of error.

Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.

Check the documentation of this method in https://core.telegram.org/bots/api#getmydefaultadministratorrights

Link to this function

get_sticker_set(name, options \\ [])

View Source

Specs

get_sticker_set(
  name :: String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.StickerSet.t()} | {:error, ExGram.Error.t()}

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

Check the documentation of this method in https://core.telegram.org/bots/api#getstickerset

Link to this function

get_sticker_set!(name, ops \\ [])

View Source

Specs

get_sticker_set!(
  name :: String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.StickerSet.t()

Unsafe version of get_sticker_set. It will return the response or raise in case of error.

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

Check the documentation of this method in https://core.telegram.org/bots/api#getstickerset

Link to this function

get_updates(options \\ [])

View Source

Specs

get_updates(
  options :: [
    offset: integer(),
    limit: integer(),
    timeout: integer(),
    allowed_updates: [String.t()],
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Update.t()} | {:error, ExGram.Error.t()}

Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.

Check the documentation of this method in https://core.telegram.org/bots/api#getupdates

Specs

get_updates!(
  ops :: [
    offset: integer(),
    limit: integer(),
    timeout: integer(),
    allowed_updates: [String.t()],
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Update.t()

Unsafe version of get_updates. It will return the response or raise in case of error.

Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.

Check the documentation of this method in https://core.telegram.org/bots/api#getupdates

Link to this function

get_user_profile_photos(user_id, options \\ [])

View Source

Specs

get_user_profile_photos(
  user_id :: integer(),
  options :: [
    offset: integer(),
    limit: integer(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.UserProfilePhotos.t()} | {:error, ExGram.Error.t()}

Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.

Check the documentation of this method in https://core.telegram.org/bots/api#getuserprofilephotos

Link to this function

get_user_profile_photos!(user_id, ops \\ [])

View Source

Specs

get_user_profile_photos!(
  user_id :: integer(),
  ops :: [
    offset: integer(),
    limit: integer(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.UserProfilePhotos.t()

Unsafe version of get_user_profile_photos. It will return the response or raise in case of error.

Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.

Check the documentation of this method in https://core.telegram.org/bots/api#getuserprofilephotos

Link to this function

get_webhook_info(options \\ [])

View Source

Specs

get_webhook_info(
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.WebhookInfo.t()} | {:error, ExGram.Error.t()}

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

Check the documentation of this method in https://core.telegram.org/bots/api#getwebhookinfo

Link to this function

get_webhook_info!(ops \\ [])

View Source

Specs

get_webhook_info!(
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.WebhookInfo.t()

Unsafe version of get_webhook_info. It will return the response or raise in case of error.

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

Check the documentation of this method in https://core.telegram.org/bots/api#getwebhookinfo

Link to this function

hide_general_forum_topic(chat_id, options \\ [])

View Source

Specs

hide_general_forum_topic(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#hidegeneralforumtopic

Link to this function

hide_general_forum_topic!(chat_id, ops \\ [])

View Source

Specs

hide_general_forum_topic!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of hide_general_forum_topic. It will return the response or raise in case of error.

Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#hidegeneralforumtopic

Callback implementation for Supervisor.init/1.

Link to this function

leave_chat(chat_id, options \\ [])

View Source

Specs

leave_chat(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method for your bot to leave a group, supergroup or channel. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#leavechat

Link to this function

leave_chat!(chat_id, ops \\ [])

View Source

Specs

leave_chat!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of leave_chat. It will return the response or raise in case of error.

Use this method for your bot to leave a group, supergroup or channel. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#leavechat

Link to this function

log_out(chat_id, text, options \\ [])

View Source

Specs

log_out(
  chat_id :: integer() | String.t(),
  text :: String.t(),
  options :: [
    message_thread_id: integer(),
    parse_mode: String.t(),
    entities: [ExGram.Model.MessageEntity.t()],
    disable_web_page_preview: boolean(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.

Check the documentation of this method in https://core.telegram.org/bots/api#logout

Link to this function

log_out!(chat_id, text, ops \\ [])

View Source

Specs

log_out!(
  chat_id :: integer() | String.t(),
  text :: String.t(),
  ops :: [
    message_thread_id: integer(),
    parse_mode: String.t(),
    entities: [ExGram.Model.MessageEntity.t()],
    disable_web_page_preview: boolean(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of log_out. It will return the response or raise in case of error.

Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.

Check the documentation of this method in https://core.telegram.org/bots/api#logout

Link to this function

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

View Source

Specs

pin_chat_message(
  chat_id :: integer() | String.t(),
  message_id :: integer(),
  options :: [
    disable_notification: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#pinchatmessage

Link to this function

pin_chat_message!(chat_id, message_id, ops \\ [])

View Source

Specs

pin_chat_message!(
  chat_id :: integer() | String.t(),
  message_id :: integer(),
  ops :: [
    disable_notification: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of pin_chat_message. It will return the response or raise in case of error.

Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#pinchatmessage

Link to this function

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

View Source

Specs

promote_chat_member(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  options :: [
    is_anonymous: boolean(),
    can_manage_chat: boolean(),
    can_post_messages: boolean(),
    can_edit_messages: boolean(),
    can_delete_messages: boolean(),
    can_manage_video_chats: boolean(),
    can_restrict_members: boolean(),
    can_promote_members: boolean(),
    can_change_info: boolean(),
    can_invite_users: boolean(),
    can_pin_messages: boolean(),
    can_manage_topics: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

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 administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#promotechatmember

Link to this function

promote_chat_member!(chat_id, user_id, ops \\ [])

View Source

Specs

promote_chat_member!(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  ops :: [
    is_anonymous: boolean(),
    can_manage_chat: boolean(),
    can_post_messages: boolean(),
    can_edit_messages: boolean(),
    can_delete_messages: boolean(),
    can_manage_video_chats: boolean(),
    can_restrict_members: boolean(),
    can_promote_members: boolean(),
    can_change_info: boolean(),
    can_invite_users: boolean(),
    can_pin_messages: boolean(),
    can_manage_topics: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of promote_chat_member. It will return the response or raise in case of error.

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 administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#promotechatmember

Link to this function

reopen_forum_topic(chat_id, message_thread_id, options \\ [])

View Source

Specs

reopen_forum_topic(
  chat_id :: integer() | String.t(),
  message_thread_id :: integer(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#reopenforumtopic

Link to this function

reopen_forum_topic!(chat_id, message_thread_id, ops \\ [])

View Source

Specs

reopen_forum_topic!(
  chat_id :: integer() | String.t(),
  message_thread_id :: integer(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of reopen_forum_topic. It will return the response or raise in case of error.

Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#reopenforumtopic

Link to this function

reopen_general_forum_topic(chat_id, options \\ [])

View Source

Specs

reopen_general_forum_topic(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#reopengeneralforumtopic

Link to this function

reopen_general_forum_topic!(chat_id, ops \\ [])

View Source

Specs

reopen_general_forum_topic!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of reopen_general_forum_topic. It will return the response or raise in case of error.

Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#reopengeneralforumtopic

Link to this function

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

View Source

Specs

restrict_chat_member(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  permissions :: ExGram.Model.ChatPermissions.t(),
  options :: [
    until_date: integer(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

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 administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#restrictchatmember

Link to this function

restrict_chat_member!(chat_id, user_id, permissions, ops \\ [])

View Source

Specs

restrict_chat_member!(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  permissions :: ExGram.Model.ChatPermissions.t(),
  ops :: [
    until_date: integer(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of restrict_chat_member. It will return the response or raise in case of error.

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 administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#restrictchatmember

Link to this function

revoke_chat_invite_link(chat_id, invite_link, options \\ [])

View Source

Specs

revoke_chat_invite_link(
  chat_id :: integer() | String.t(),
  invite_link :: String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.ChatInviteLink.t()} | {:error, ExGram.Error.t()}

Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.

Check the documentation of this method in https://core.telegram.org/bots/api#revokechatinvitelink

Link to this function

revoke_chat_invite_link!(chat_id, invite_link, ops \\ [])

View Source

Specs

revoke_chat_invite_link!(
  chat_id :: integer() | String.t(),
  invite_link :: String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.ChatInviteLink.t()

Unsafe version of revoke_chat_invite_link. It will return the response or raise in case of error.

Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.

Check the documentation of this method in https://core.telegram.org/bots/api#revokechatinvitelink

Link to this function

send_animation(chat_id, animation, options \\ [])

View Source

Specs

send_animation(
  chat_id :: integer() | String.t(),
  animation ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  options :: [
    message_thread_id: integer(),
    duration: integer(),
    width: integer(),
    height: integer(),
    thumb:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    has_spoiler: boolean(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.

Check the documentation of this method in https://core.telegram.org/bots/api#sendanimation

Link to this function

send_animation!(chat_id, animation, ops \\ [])

View Source

Specs

send_animation!(
  chat_id :: integer() | String.t(),
  animation ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  ops :: [
    message_thread_id: integer(),
    duration: integer(),
    width: integer(),
    height: integer(),
    thumb:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    has_spoiler: boolean(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_animation. It will return the response or raise in case of error.

Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.

Check the documentation of this method in https://core.telegram.org/bots/api#sendanimation

Link to this function

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

View Source

Specs

send_audio(
  chat_id :: integer() | String.t(),
  audio ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  options :: [
    message_thread_id: integer(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    duration: integer(),
    performer: String.t(),
    title: String.t(),
    thumb:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

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 Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.

Check the documentation of this method in https://core.telegram.org/bots/api#sendaudio

Link to this function

send_audio!(chat_id, audio, ops \\ [])

View Source

Specs

send_audio!(
  chat_id :: integer() | String.t(),
  audio ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  ops :: [
    message_thread_id: integer(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    duration: integer(),
    performer: String.t(),
    title: String.t(),
    thumb:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_audio. It will return the response or raise in case of error.

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 Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.

Check the documentation of this method in https://core.telegram.org/bots/api#sendaudio

Link to this function

send_chat_action(chat_id, action, options \\ [])

View Source

Specs

send_chat_action(
  chat_id :: integer() | String.t(),
  action :: String.t(),
  options :: [
    message_thread_id: integer(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

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.

Check the documentation of this method in https://core.telegram.org/bots/api#sendchataction

Link to this function

send_chat_action!(chat_id, action, ops \\ [])

View Source

Specs

send_chat_action!(
  chat_id :: integer() | String.t(),
  action :: String.t(),
  ops :: [
    message_thread_id: integer(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of send_chat_action. It will return the response or raise in case of error.

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.

Check the documentation of this method in https://core.telegram.org/bots/api#sendchataction

Link to this function

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

View Source

Specs

send_contact(
  chat_id :: integer() | String.t(),
  phone_number :: String.t(),
  first_name :: String.t(),
  options :: [
    message_thread_id: integer(),
    last_name: String.t(),
    vcard: String.t(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Use this method to send phone contacts. On success, the sent Message is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#sendcontact

Link to this function

send_contact!(chat_id, phone_number, first_name, ops \\ [])

View Source

Specs

send_contact!(
  chat_id :: integer() | String.t(),
  phone_number :: String.t(),
  first_name :: String.t(),
  ops :: [
    message_thread_id: integer(),
    last_name: String.t(),
    vcard: String.t(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_contact. It will return the response or raise in case of error.

Use this method to send phone contacts. On success, the sent Message is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#sendcontact

Link to this function

send_dice(chat_id, options \\ [])

View Source

Specs

send_dice(
  chat_id :: integer() | String.t(),
  options :: [
    message_thread_id: integer(),
    emoji: String.t(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#senddice

Link to this function

send_dice!(chat_id, ops \\ [])

View Source

Specs

send_dice!(
  chat_id :: integer() | String.t(),
  ops :: [
    message_thread_id: integer(),
    emoji: String.t(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_dice. It will return the response or raise in case of error.

Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#senddice

Link to this function

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

View Source

Specs

send_document(
  chat_id :: integer() | String.t(),
  document ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  options :: [
    message_thread_id: integer(),
    thumb:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    disable_content_type_detection: boolean(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Use this method to send general files. On success, the sent 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.

Check the documentation of this method in https://core.telegram.org/bots/api#senddocument

Link to this function

send_document!(chat_id, document, ops \\ [])

View Source

Specs

send_document!(
  chat_id :: integer() | String.t(),
  document ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  ops :: [
    message_thread_id: integer(),
    thumb:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    disable_content_type_detection: boolean(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_document. It will return the response or raise in case of error.

Use this method to send general files. On success, the sent 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.

Check the documentation of this method in https://core.telegram.org/bots/api#senddocument

Link to this function

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

View Source

Specs

send_game(
  chat_id :: integer(),
  game_short_name :: String.t(),
  options :: [
    message_thread_id: integer(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

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

Check the documentation of this method in https://core.telegram.org/bots/api#sendgame

Link to this function

send_game!(chat_id, game_short_name, ops \\ [])

View Source

Specs

send_game!(
  chat_id :: integer(),
  game_short_name :: String.t(),
  ops :: [
    message_thread_id: integer(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_game. It will return the response or raise in case of error.

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

Check the documentation of this method in https://core.telegram.org/bots/api#sendgame

Link to this function

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

View Source

Specs

send_invoice(
  chat_id :: integer() | String.t(),
  title :: String.t(),
  description :: String.t(),
  payload :: String.t(),
  provider_token :: String.t(),
  currency :: String.t(),
  prices :: [ExGram.Model.LabeledPrice.t()],
  options :: [
    message_thread_id: integer(),
    max_tip_amount: integer(),
    suggested_tip_amounts: [integer()],
    start_parameter: String.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(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

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

Check the documentation of this method in https://core.telegram.org/bots/api#sendinvoice

Link to this function

send_invoice!(chat_id, title, description, payload, provider_token, currency, prices, ops \\ [])

View Source

Specs

send_invoice!(
  chat_id :: integer() | String.t(),
  title :: String.t(),
  description :: String.t(),
  payload :: String.t(),
  provider_token :: String.t(),
  currency :: String.t(),
  prices :: [ExGram.Model.LabeledPrice.t()],
  ops :: [
    message_thread_id: integer(),
    max_tip_amount: integer(),
    suggested_tip_amounts: [integer()],
    start_parameter: String.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(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_invoice. It will return the response or raise in case of error.

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

Check the documentation of this method in https://core.telegram.org/bots/api#sendinvoice

Link to this function

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

View Source

Specs

send_location(
  chat_id :: integer() | String.t(),
  latitude :: float(),
  longitude :: float(),
  options :: [
    message_thread_id: integer(),
    horizontal_accuracy: float(),
    live_period: integer(),
    heading: integer(),
    proximity_alert_radius: integer(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Use this method to send point on the map. On success, the sent Message is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#sendlocation

Link to this function

send_location!(chat_id, latitude, longitude, ops \\ [])

View Source

Specs

send_location!(
  chat_id :: integer() | String.t(),
  latitude :: float(),
  longitude :: float(),
  ops :: [
    message_thread_id: integer(),
    horizontal_accuracy: float(),
    live_period: integer(),
    heading: integer(),
    proximity_alert_radius: integer(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_location. It will return the response or raise in case of error.

Use this method to send point on the map. On success, the sent Message is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#sendlocation

Link to this function

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

View Source

Specs

send_media_group(
  chat_id :: integer() | String.t(),
  media :: [
    ExGram.Model.InputMediaAudio.t()
    | ExGram.Model.InputMediaDocument.t()
    | ExGram.Model.InputMediaPhoto.t()
    | ExGram.Model.InputMediaVideo.t()
  ],
  options :: [
    message_thread_id: integer(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#sendmediagroup

Link to this function

send_media_group!(chat_id, media, ops \\ [])

View Source

Specs

send_media_group!(
  chat_id :: integer() | String.t(),
  media :: [
    ExGram.Model.InputMediaAudio.t()
    | ExGram.Model.InputMediaDocument.t()
    | ExGram.Model.InputMediaPhoto.t()
    | ExGram.Model.InputMediaVideo.t()
  ],
  ops :: [
    message_thread_id: integer(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_media_group. It will return the response or raise in case of error.

Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#sendmediagroup

Link to this function

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

View Source

Specs

send_message(
  chat_id :: integer() | String.t(),
  text :: String.t(),
  options :: [
    message_thread_id: integer(),
    parse_mode: String.t(),
    entities: [ExGram.Model.MessageEntity.t()],
    disable_web_page_preview: boolean(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Use this method to send text messages. On success, the sent Message is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#sendmessage

Link to this function

send_message!(chat_id, text, ops \\ [])

View Source

Specs

send_message!(
  chat_id :: integer() | String.t(),
  text :: String.t(),
  ops :: [
    message_thread_id: integer(),
    parse_mode: String.t(),
    entities: [ExGram.Model.MessageEntity.t()],
    disable_web_page_preview: boolean(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_message. It will return the response or raise in case of error.

Use this method to send text messages. On success, the sent Message is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#sendmessage

Link to this function

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

View Source

Specs

send_photo(
  chat_id :: integer() | String.t(),
  photo ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  options :: [
    message_thread_id: integer(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    has_spoiler: boolean(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Use this method to send photos. On success, the sent Message is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#sendphoto

Link to this function

send_photo!(chat_id, photo, ops \\ [])

View Source

Specs

send_photo!(
  chat_id :: integer() | String.t(),
  photo ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  ops :: [
    message_thread_id: integer(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    has_spoiler: boolean(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_photo. It will return the response or raise in case of error.

Use this method to send photos. On success, the sent Message is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#sendphoto

Link to this function

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

View Source

Specs

send_poll(
  chat_id :: integer() | String.t(),
  question :: String.t(),
  options :: [String.t()],
  options :: [
    message_thread_id: integer(),
    is_anonymous: boolean(),
    type: String.t(),
    allows_multiple_answers: boolean(),
    correct_option_id: integer(),
    explanation: String.t(),
    explanation_parse_mode: String.t(),
    explanation_entities: [ExGram.Model.MessageEntity.t()],
    open_period: integer(),
    close_date: integer(),
    is_closed: boolean(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Use this method to send a native poll. On success, the sent Message is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#sendpoll

Link to this function

send_poll!(chat_id, question, options, ops \\ [])

View Source

Specs

send_poll!(
  chat_id :: integer() | String.t(),
  question :: String.t(),
  options :: [String.t()],
  ops :: [
    message_thread_id: integer(),
    is_anonymous: boolean(),
    type: String.t(),
    allows_multiple_answers: boolean(),
    correct_option_id: integer(),
    explanation: String.t(),
    explanation_parse_mode: String.t(),
    explanation_entities: [ExGram.Model.MessageEntity.t()],
    open_period: integer(),
    close_date: integer(),
    is_closed: boolean(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_poll. It will return the response or raise in case of error.

Use this method to send a native poll. On success, the sent Message is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#sendpoll

Link to this function

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

View Source

Specs

send_sticker(
  chat_id :: integer() | String.t(),
  sticker ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  options :: [
    message_thread_id: integer(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

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

Check the documentation of this method in https://core.telegram.org/bots/api#sendsticker

Link to this function

send_sticker!(chat_id, sticker, ops \\ [])

View Source

Specs

send_sticker!(
  chat_id :: integer() | String.t(),
  sticker ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  ops :: [
    message_thread_id: integer(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_sticker. It will return the response or raise in case of error.

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

Check the documentation of this method in https://core.telegram.org/bots/api#sendsticker

Link to this function

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

View Source

Specs

send_venue(
  chat_id :: integer() | String.t(),
  latitude :: float(),
  longitude :: float(),
  title :: String.t(),
  address :: String.t(),
  options :: [
    message_thread_id: integer(),
    foursquare_id: String.t(),
    foursquare_type: String.t(),
    google_place_id: String.t(),
    google_place_type: String.t(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Use this method to send information about a venue. On success, the sent Message is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#sendvenue

Link to this function

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

View Source

Specs

send_venue!(
  chat_id :: integer() | String.t(),
  latitude :: float(),
  longitude :: float(),
  title :: String.t(),
  address :: String.t(),
  ops :: [
    message_thread_id: integer(),
    foursquare_id: String.t(),
    foursquare_type: String.t(),
    google_place_id: String.t(),
    google_place_type: String.t(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_venue. It will return the response or raise in case of error.

Use this method to send information about a venue. On success, the sent Message is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#sendvenue

Link to this function

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

View Source

Specs

send_video(
  chat_id :: integer() | String.t(),
  video ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  options :: [
    message_thread_id: integer(),
    duration: integer(),
    width: integer(),
    height: integer(),
    thumb:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    has_spoiler: boolean(),
    supports_streaming: boolean(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.

Check the documentation of this method in https://core.telegram.org/bots/api#sendvideo

Link to this function

send_video!(chat_id, video, ops \\ [])

View Source

Specs

send_video!(
  chat_id :: integer() | String.t(),
  video ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  ops :: [
    message_thread_id: integer(),
    duration: integer(),
    width: integer(),
    height: integer(),
    thumb:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    has_spoiler: boolean(),
    supports_streaming: boolean(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_video. It will return the response or raise in case of error.

Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.

Check the documentation of this method in https://core.telegram.org/bots/api#sendvideo

Link to this function

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

View Source

Specs

send_video_note(
  chat_id :: integer() | String.t(),
  video_note ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  options :: [
    message_thread_id: integer(),
    duration: integer(),
    length: integer(),
    thumb:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#sendvideonote

Link to this function

send_video_note!(chat_id, video_note, ops \\ [])

View Source

Specs

send_video_note!(
  chat_id :: integer() | String.t(),
  video_note ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  ops :: [
    message_thread_id: integer(),
    duration: integer(),
    length: integer(),
    thumb:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_video_note. It will return the response or raise in case of error.

As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#sendvideonote

Link to this function

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

View Source

Specs

send_voice(
  chat_id :: integer() | String.t(),
  voice ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  options :: [
    message_thread_id: integer(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    duration: integer(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

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 Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.

Check the documentation of this method in https://core.telegram.org/bots/api#sendvoice

Link to this function

send_voice!(chat_id, voice, ops \\ [])

View Source

Specs

send_voice!(
  chat_id :: integer() | String.t(),
  voice ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  ops :: [
    message_thread_id: integer(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    duration: integer(),
    disable_notification: boolean(),
    protect_content: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_voice. It will return the response or raise in case of error.

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 Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.

Check the documentation of this method in https://core.telegram.org/bots/api#sendvoice

Link to this function

set_chat_administrator_custom_title(chat_id, user_id, custom_title, options \\ [])

View Source

Specs

set_chat_administrator_custom_title(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  custom_title :: String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

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

Check the documentation of this method in https://core.telegram.org/bots/api#setchatadministratorcustomtitle

Link to this function

set_chat_administrator_custom_title!(chat_id, user_id, custom_title, ops \\ [])

View Source

Specs

set_chat_administrator_custom_title!(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  custom_title :: String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of set_chat_administrator_custom_title. It will return the response or raise in case of error.

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

Check the documentation of this method in https://core.telegram.org/bots/api#setchatadministratorcustomtitle

Link to this function

set_chat_description(chat_id, options \\ [])

View Source

Specs

set_chat_description(
  chat_id :: integer() | String.t(),
  options :: [
    description: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

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 administrator rights. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#setchatdescription

Link to this function

set_chat_description!(chat_id, ops \\ [])

View Source

Specs

set_chat_description!(
  chat_id :: integer() | String.t(),
  ops :: [
    description: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of set_chat_description. It will return the response or raise in case of error.

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 administrator rights. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#setchatdescription

Link to this function

set_chat_menu_button(options \\ [])

View Source

Specs

set_chat_menu_button(
  options :: [
    chat_id: integer(),
    menu_button: ExGram.Model.MenuButton.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#setchatmenubutton

Link to this function

set_chat_menu_button!(ops \\ [])

View Source

Specs

set_chat_menu_button!(
  ops :: [
    chat_id: integer(),
    menu_button: ExGram.Model.MenuButton.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of set_chat_menu_button. It will return the response or raise in case of error.

Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#setchatmenubutton

Link to this function

set_chat_permissions(chat_id, permissions, options \\ [])

View Source

Specs

set_chat_permissions(
  chat_id :: integer() | String.t(),
  permissions :: ExGram.Model.ChatPermissions.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

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 administrator rights. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#setchatpermissions

Link to this function

set_chat_permissions!(chat_id, permissions, ops \\ [])

View Source

Specs

set_chat_permissions!(
  chat_id :: integer() | String.t(),
  permissions :: ExGram.Model.ChatPermissions.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of set_chat_permissions. It will return the response or raise in case of error.

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 administrator rights. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#setchatpermissions

Link to this function

set_chat_photo(chat_id, photo, options \\ [])

View Source

Specs

set_chat_photo(
  chat_id :: integer() | String.t(),
  photo ::
    {:file, String.t()} | {:file_content, iodata() | Enum.t(), String.t()},
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

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 administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#setchatphoto

Link to this function

set_chat_photo!(chat_id, photo, ops \\ [])

View Source

Specs

set_chat_photo!(
  chat_id :: integer() | String.t(),
  photo ::
    {:file, String.t()} | {:file_content, iodata() | Enum.t(), String.t()},
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of set_chat_photo. It will return the response or raise in case of error.

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 administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#setchatphoto

Link to this function

set_chat_sticker_set(chat_id, sticker_set_name, options \\ [])

View Source

Specs

set_chat_sticker_set(
  chat_id :: integer() | String.t(),
  sticker_set_name :: String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

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 administrator 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.

Check the documentation of this method in https://core.telegram.org/bots/api#setchatstickerset

Link to this function

set_chat_sticker_set!(chat_id, sticker_set_name, ops \\ [])

View Source

Specs

set_chat_sticker_set!(
  chat_id :: integer() | String.t(),
  sticker_set_name :: String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of set_chat_sticker_set. It will return the response or raise in case of error.

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 administrator 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.

Check the documentation of this method in https://core.telegram.org/bots/api#setchatstickerset

Link to this function

set_chat_title(chat_id, title, options \\ [])

View Source

Specs

set_chat_title(
  chat_id :: integer() | String.t(),
  title :: String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

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 administrator rights. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#setchattitle

Link to this function

set_chat_title!(chat_id, title, ops \\ [])

View Source

Specs

set_chat_title!(
  chat_id :: integer() | String.t(),
  title :: String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of set_chat_title. It will return the response or raise in case of error.

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 administrator rights. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#setchattitle

Link to this function

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

View Source

Specs

set_game_score(
  user_id :: integer(),
  score :: integer(),
  options :: [
    force: boolean(),
    disable_edit_message: boolean(),
    chat_id: integer(),
    message_id: integer(),
    inline_message_id: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.

Check the documentation of this method in https://core.telegram.org/bots/api#setgamescore

Link to this function

set_game_score!(user_id, score, ops \\ [])

View Source

Specs

set_game_score!(
  user_id :: integer(),
  score :: integer(),
  ops :: [
    force: boolean(),
    disable_edit_message: boolean(),
    chat_id: integer(),
    message_id: integer(),
    inline_message_id: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of set_game_score. It will return the response or raise in case of error.

Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.

Check the documentation of this method in https://core.telegram.org/bots/api#setgamescore

Link to this function

set_my_commands(commands, options \\ [])

View Source

Specs

set_my_commands(
  commands :: [ExGram.Model.BotCommand.t()],
  options :: [
    scope: ExGram.Model.BotCommandScope.t(),
    language_code: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to change the list of the bot's commands. See this manual for more details about bot commands. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#setmycommands

Link to this function

set_my_commands!(commands, ops \\ [])

View Source

Specs

set_my_commands!(
  commands :: [ExGram.Model.BotCommand.t()],
  ops :: [
    scope: ExGram.Model.BotCommandScope.t(),
    language_code: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of set_my_commands. It will return the response or raise in case of error.

Use this method to change the list of the bot's commands. See this manual for more details about bot commands. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#setmycommands

Link to this function

set_my_default_administrator_rights(options \\ [])

View Source

Specs

set_my_default_administrator_rights(
  options :: [
    rights: ExGram.Model.ChatAdministratorRights.t(),
    for_channels: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are are free to modify the list before adding the bot. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#setmydefaultadministratorrights

Link to this function

set_my_default_administrator_rights!(ops \\ [])

View Source

Specs

set_my_default_administrator_rights!(
  ops :: [
    rights: ExGram.Model.ChatAdministratorRights.t(),
    for_channels: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of set_my_default_administrator_rights. It will return the response or raise in case of error.

Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are are free to modify the list before adding the bot. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#setmydefaultadministratorrights

Link to this function

set_passport_data_errors(user_id, errors, options \\ [])

View Source

Specs

set_passport_data_errors(
  user_id :: integer(),
  errors :: [ExGram.Model.PassportElementError.t()],
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

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.

Check the documentation of this method in https://core.telegram.org/bots/api#setpassportdataerrors

Link to this function

set_passport_data_errors!(user_id, errors, ops \\ [])

View Source

Specs

set_passport_data_errors!(
  user_id :: integer(),
  errors :: [ExGram.Model.PassportElementError.t()],
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of set_passport_data_errors. It will return the response or raise in case of error.

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.

Check the documentation of this method in https://core.telegram.org/bots/api#setpassportdataerrors

Link to this function

set_sticker_position_in_set(sticker, position, options \\ [])

View Source

Specs

set_sticker_position_in_set(
  sticker :: String.t(),
  position :: integer(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

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

Check the documentation of this method in https://core.telegram.org/bots/api#setstickerpositioninset

Link to this function

set_sticker_position_in_set!(sticker, position, ops \\ [])

View Source

Specs

set_sticker_position_in_set!(
  sticker :: String.t(),
  position :: integer(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of set_sticker_position_in_set. It will return the response or raise in case of error.

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

Check the documentation of this method in https://core.telegram.org/bots/api#setstickerpositioninset

Link to this function

set_sticker_set_thumb(name, user_id, options \\ [])

View Source

Specs

set_sticker_set_thumb(
  name :: String.t(),
  user_id :: integer(),
  options :: [
    thumb:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

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

Check the documentation of this method in https://core.telegram.org/bots/api#setstickersetthumb

Link to this function

set_sticker_set_thumb!(name, user_id, ops \\ [])

View Source

Specs

set_sticker_set_thumb!(
  name :: String.t(),
  user_id :: integer(),
  ops :: [
    thumb:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of set_sticker_set_thumb. It will return the response or raise in case of error.

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

Check the documentation of this method in https://core.telegram.org/bots/api#setstickersetthumb

Link to this function

set_webhook(url, options \\ [])

View Source

Specs

set_webhook(
  url :: String.t(),
  options :: [
    certificate:
      {:file, String.t()} | {:file_content, iodata() | Enum.t(), String.t()},
    ip_address: String.t(),
    max_connections: integer(),
    allowed_updates: [String.t()],
    drop_pending_updates: boolean(),
    secret_token: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

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 Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#setwebhook

Link to this function

set_webhook!(url, ops \\ [])

View Source

Specs

set_webhook!(
  url :: String.t(),
  ops :: [
    certificate:
      {:file, String.t()} | {:file_content, iodata() | Enum.t(), String.t()},
    ip_address: String.t(),
    max_connections: integer(),
    allowed_updates: [String.t()],
    drop_pending_updates: boolean(),
    secret_token: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of set_webhook. It will return the response or raise in case of error.

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 Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#setwebhook

Link to this function

stop_message_live_location(options \\ [])

View Source

Specs

stop_message_live_location(
  options :: [
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#stopmessagelivelocation

Link to this function

stop_message_live_location!(ops \\ [])

View Source

Specs

stop_message_live_location!(
  ops :: [
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of stop_message_live_location. It will return the response or raise in case of error.

Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.

Check the documentation of this method in https://core.telegram.org/bots/api#stopmessagelivelocation

Link to this function

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

View Source

Specs

stop_poll(
  chat_id :: integer() | String.t(),
  message_id :: integer(),
  options :: [
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Poll.t()} | {:error, ExGram.Error.t()}

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

Check the documentation of this method in https://core.telegram.org/bots/api#stoppoll

Link to this function

stop_poll!(chat_id, message_id, ops \\ [])

View Source

Specs

stop_poll!(
  chat_id :: integer() | String.t(),
  message_id :: integer(),
  ops :: [
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Poll.t()

Unsafe version of stop_poll. It will return the response or raise in case of error.

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

Check the documentation of this method in https://core.telegram.org/bots/api#stoppoll

Link to this function

unban_chat_member(chat_id, user_id, options \\ [])

View Source

Specs

unban_chat_member(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  options :: [
    only_if_banned: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to unban a previously banned 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. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#unbanchatmember

Link to this function

unban_chat_member!(chat_id, user_id, ops \\ [])

View Source

Specs

unban_chat_member!(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  ops :: [
    only_if_banned: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of unban_chat_member. It will return the response or raise in case of error.

Use this method to unban a previously banned 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. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#unbanchatmember

Link to this function

unban_chat_sender_chat(chat_id, sender_chat_id, options \\ [])

View Source

Specs

unban_chat_sender_chat(
  chat_id :: integer() | String.t(),
  sender_chat_id :: integer(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#unbanchatsenderchat

Link to this function

unban_chat_sender_chat!(chat_id, sender_chat_id, ops \\ [])

View Source

Specs

unban_chat_sender_chat!(
  chat_id :: integer() | String.t(),
  sender_chat_id :: integer(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of unban_chat_sender_chat. It will return the response or raise in case of error.

Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#unbanchatsenderchat

Link to this function

unhide_general_forum_topic(chat_id, options \\ [])

View Source

Specs

unhide_general_forum_topic(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#unhidegeneralforumtopic

Link to this function

unhide_general_forum_topic!(chat_id, ops \\ [])

View Source

Specs

unhide_general_forum_topic!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of unhide_general_forum_topic. It will return the response or raise in case of error.

Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#unhidegeneralforumtopic

Link to this function

unpin_all_chat_messages(chat_id, options \\ [])

View Source

Specs

unpin_all_chat_messages(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#unpinallchatmessages

Link to this function

unpin_all_chat_messages!(chat_id, ops \\ [])

View Source

Specs

unpin_all_chat_messages!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of unpin_all_chat_messages. It will return the response or raise in case of error.

Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#unpinallchatmessages

Link to this function

unpin_all_forum_topic_messages(chat_id, message_thread_id, options \\ [])

View Source

Specs

unpin_all_forum_topic_messages(
  chat_id :: integer() | String.t(),
  message_thread_id :: integer(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#unpinallforumtopicmessages

Link to this function

unpin_all_forum_topic_messages!(chat_id, message_thread_id, ops \\ [])

View Source

Specs

unpin_all_forum_topic_messages!(
  chat_id :: integer() | String.t(),
  message_thread_id :: integer(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of unpin_all_forum_topic_messages. It will return the response or raise in case of error.

Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#unpinallforumtopicmessages

Link to this function

unpin_chat_message(chat_id, options \\ [])

View Source

Specs

unpin_chat_message(
  chat_id :: integer() | String.t(),
  options :: [
    message_id: integer(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#unpinchatmessage

Link to this function

unpin_chat_message!(chat_id, ops \\ [])

View Source

Specs

unpin_chat_message!(
  chat_id :: integer() | String.t(),
  ops :: [
    message_id: integer(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of unpin_chat_message. It will return the response or raise in case of error.

Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.

Check the documentation of this method in https://core.telegram.org/bots/api#unpinchatmessage

Link to this function

upload_sticker_file(user_id, png_sticker, options \\ [])

View Source

Specs

upload_sticker_file(
  user_id :: integer(),
  png_sticker ::
    {:file, String.t()} | {:file_content, iodata() | Enum.t(), String.t()},
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.File.t()} | {:error, ExGram.Error.t()}

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 File on success.

Check the documentation of this method in https://core.telegram.org/bots/api#uploadstickerfile

Link to this function

upload_sticker_file!(user_id, png_sticker, ops \\ [])

View Source

Specs

upload_sticker_file!(
  user_id :: integer(),
  png_sticker ::
    {:file, String.t()} | {:file_content, iodata() | Enum.t(), String.t()},
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.File.t()

Unsafe version of upload_sticker_file. It will return the response or raise in case of error.

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 File on success.

Check the documentation of this method in https://core.telegram.org/bots/api#uploadstickerfile