telegrambot-lib.core — telegrambot-lib 0.3.1

A Clojure library for interacting with the Telegram Bot API.

• Getting started
• Functions accurate as of: Telegram Bot API 5.0

add-sticker-to-set clj

(add-sticker-to-set this content)

(add-sticker-to-set this user_id name emojis)

(add-sticker-to-set this user_id name emojis & optional)

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

Required

• this ; a bot instance
• user_id ; id of sticker set owner
• name ; sticker set name
• emojis ; one or more emoji corresponding to the sticker

Optional

• png_sticker ; PNG image with the sticker
• tgs_sticker ; TGS animation with the sticker
• mask_position ; json object for where the mask should be placed on faces

answer-callback-query clj multimethod

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.

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)

Optional

• text ; text of the notification
• show_alert ; if true, show alert instead of a notification
• url ; url that will be opened by the user's client.
• cache_time ; max time in seconds for caching callback query. (default: 0)

answer-inline-query clj

(answer-inline-query this content)

(answer-inline-query this inline_query_id results)

(answer-inline-query this inline_query_id results & optional)

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

Required

• this ; a bot instance
• inline_query_id ; id for the answered query
• results ; json array of results for inline query

Optional

• cache_time ; max time in seconds
• is_personal ; true if query results are cached only for individuals
• next_offset ; Pagination offset a client should use for more results
• switch_pm_text ; display a button that allows clients to start a private chat with the bot
• switch_pm_parameter ; 'deep-linking' param for /start sent to bot during switch

answer-precheckout-query-error clj

(answer-precheckout-query-error this content)

(answer-precheckout-query-error this pre_checkout_query_id error_message)

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. Sets 'ok' param to false.

Required

• this ; a bot instance
• pre_checkout_query_id ; id of query to be answered
• ok ; true if all is good (in stock, etc) and bot is ready to proceed with order (auto set by this function)
• error_message ; Required if 'ok' is false, message why checkout cannot proceed

answer-precheckout-query-ok clj multimethod

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. Sets 'ok' param to true.

Required

• this ; a bot instance
• pre_checkout_query_id ; id of query to be answered
• ok ; true if all is good (in stock, etc) and bot is ready to proceed with order (auto set by this function)

answer-shipping-query-error clj

(answer-shipping-query-error this content)

(answer-shipping-query-error this shipping_query_id error_message)

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. Sets 'ok' param to false.

Required

• this ; a bot instance
• shipping_query_id ; id of query to be answered
• ok ; true if delivery to address is possible (auto set by this function)
• error_message ; Required if 'ok' is false, message why order cannot complete

answer-shipping-query-ok clj

(answer-shipping-query-ok this content)

(answer-shipping-query-ok this shipping_query_id shipping_options)

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. Sets 'ok' param to true.

Required

• this ; a bot instance
• shipping_query_id ; id of query to be answered
• ok ; true if delivery to address is possible (auto set by this function)
• shipping_options ; Required if 'ok' is true, array of shipping options

call clj

(call this endpoint)

(call this endpoint content)

A generic function to call any endpoint with optional content. Provided in the case where methods are added to the API and are not available in this library yet.

Required

• this ; a bot instance
• endpoint ; the api method path

Optional

• content ; parameters for the api method

close clj

(close this)

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.

Required

• this ; a bot instance

copy-message clj

(copy-message this content)

(copy-message this chat_id from_chat_id message_id)

(copy-message this chat_id from_chat_id message_id & optional)

Use this method to copy messages of any kind. The method is analogous to the method forwardMessages, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• from_chat_id ; id of chat from original message
• message_id ; message id in chat specified in 'from_chat_id'

Optional

• disable_notification ; send silently

create clj

(create)

(create bot-token)

Create a new Telegram Bot API instance.

• No argument attempts to load the bot-token from the environment.
• 1 argument will use the passed in bot-token.

create-new-sticker-set clj

(create-new-sticker-set this content)

(create-new-sticker-set this user_id name title emojis)

(create-new-sticker-set this user_id name title emojis & optional)

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

Required

• this ; a bot instance
• user_id ; id of created sticker set owner
• name ; short name of sticker set for use in URLs
• title ; sticker set title
• emojis ; one or more emoji corresponding to the sticker

Optional

• png_sticker ; PNG image with the sticker
• tgs_sticker ; TGS animation with the sticker
• contains_masks ; true to create a set of mask stickers
• mask_position ; json object for where the mask should be placed on faces

delete-chat-photo clj multimethod

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)

delete-chat-sticker-set clj multimethod

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)

delete-message clj

(delete-message this content)

(delete-message this chat_id message_id)

Use this method to delete a message, including service messages. Returns True on success.

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• message_id ; id of message to delete

delete-sticker-from-set clj multimethod

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

Required

• this ; a bot instance
• sticker ; file id of the sticker

delete-webhook clj

(delete-webhook this)

(delete-webhook this content)

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

Required

• this ; a bot instance

Optional

• drop_pending_updates ; Pass True to drop all pending updates

edit-message-caption clj

(edit-message-caption this content)

(edit-message-caption this chat_id message_id caption)

(edit-message-caption this chat_id message_id caption & optional)

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• message_id ; id of message to edit
• caption ; new caption of message

Optional

• parse_mode ; entity parsing in message
• caption_entities ; list of MessageEntity - can use instead of parse_mode
• reply_markup ; inline keyboard markup

edit-message-caption-inline clj

(edit-message-caption-inline this content)

(edit-message-caption-inline this inline_message_id caption)

(edit-message-caption-inline this inline_message_id caption & optional)

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

Required

• this ; a bot instance
• inline_message_id ; id of the inline message
• caption ; new caption of message

Optional

• parse_mode ; entity parsing in message
• reply_markup ; inline keyboard markup

edit-message-live-location clj

(edit-message-live-location this content)

(edit-message-live-location this chat_id message_id latitude longitude)

(edit-message-live-location this
                            chat_id
                            message_id
                            latitude
                            longitude
                            &
                            optional)

Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message was sent by the bot, the edited Message is returned, otherwise True is returned.

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• message_id ; id of the message to edit
• latitude ; lat of new location
• longitude ; long of new location

Optional

• horizontal_accuracy ; 1-1500 meters radius of uncertainty
• heading ; 1-360 degrees direction user is moving
• proximity_alert_radius ; 1-100000 meters max distance for proximity alerts
• reply_markup ; additional interface options

edit-message-live-location-inline clj

(edit-message-live-location-inline this content)

(edit-message-live-location-inline this inline_message_id latitude longitude)

(edit-message-live-location-inline this
                                   inline_message_id
                                   latitude
                                   longitude
                                   &
                                   optional)

Use this method to edit live location inline messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message was sent by the bot, the edited Message is returned, otherwise True is returned.

Required

• this ; a bot instance
• inline_message_id ; id of the inline message to edit
• latitude ; lat of new location
• longitude ; long of new location

Optional

• reply_markup ; additional interface options

edit-message-media clj

(edit-message-media this content)

(edit-message-media this chat_id message_id media)

(edit-message-media this chat_id message_id media & optional)

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• message_id ; id of message to edit
• media ; json object for new media content

Optional

• reply_markup ; inline keyboard markup

edit-message-media-inline clj

(edit-message-media-inline this content)

(edit-message-media-inline this inline_message_id media)

(edit-message-media-inline this inline_message_id media & optional)

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

Required

• this ; a bot instance
• inline_message_id ; id of the inline message
• media ; json object for new media content

Optional

• reply_markup ; inline keyboard markup

edit-message-reply-markup clj

(edit-message-reply-markup this content)

(edit-message-reply-markup this chat_id message_id reply_markup)

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• message_id ; id of message to edit
• reply_markup ; inline keyboard markup

edit-message-reply-markup-inline clj

(edit-message-reply-markup-inline this content)

(edit-message-reply-markup-inline this inline_message_id reply_markup)

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

Required

• this ; a bot instance
• inline_message_id ; id of the inline message
• reply_markup ; inline keyboard markup

edit-message-text clj

(edit-message-text this content)

(edit-message-text this chat_id message_id text)

(edit-message-text this chat_id message_id text & optional)

Use this method to edit text and game messages. On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• message_id ; id of message to edit
• text ; new text of message

Optional

• parse_mode ; entity parsing in message
• entities ; list of MessageEntity - can use instead of parse_mode
• disable_web_page_preview ; disable link previews
• reply_markup ; inline keyboard markup

edit-message-text-inline clj

(edit-message-text-inline this content)

(edit-message-text-inline this inline_message_id text)

(edit-message-text-inline this inline_message_id text & optional)

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

Required

• this ; a bot instance
• inline_message_id ; id of the inline message
• text ; new text of message

Optional

• parse_mode ; entity parsing in message
• disable_web_page_preview ; disable link previews
• reply_markup ; inline keyboard markup

export-chat-invite-link clj multimethod

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)

forward-message clj

(forward-message this content)

(forward-message this chat_id from_chat_id message_id)

(forward-message this chat_id from_chat_id message_id & optional)

Use this method to forward messages of any kind. On success, the sent Message is returned.

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• from_chat_id ; id of chat from original message
• message_id ; message id in chat specified in 'from_chat_id'

Optional

• disable_notification ; send silently

get-chat clj multimethod

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.

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)

get-chat-administrators clj multimethod

Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)

get-chat-member clj

(get-chat-member this content)

(get-chat-member this chat_id user_id)

Use this method to get information about a member of a chat. Returns a ChatMember object on success.

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• user_id ; id of target user

get-chat-members-count clj multimethod

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)

get-file clj multimethod

Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bottoken/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.

Required

• this ; a bot instance
• file_id ; file id to get info about

get-game-high-scores clj

(get-game-high-scores this content)

(get-game-high-scores this chat_id message_id user_id)

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

Required

• this ; a bot instance
• chat_id ; id of the target chat
• message_id ; id of the sent message
• user_id ; target user

get-game-high-scores-inline clj

(get-game-high-scores-inline this content)

(get-game-high-scores-inline this inline_message_id user_id)

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

Required

• this ; a bot instance
• inline_message_id ; id of the sent message
• user_id ; target user

get-me clj

(get-me this)

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

Required

• this ; a bot instance

get-my-commands clj

(get-my-commands this)

Use this method to get the current list of the bot's commands. Returns Array of BotCommand on success.

Required

• this ; a bot instance

get-sticker-set clj multimethod

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

Required

• this ; a bot instance
• name ; name of the sticker set

get-updates clj

(get-updates this)

(get-updates this content)

Use this method to receive incoming updates using long polling. An Array of Update objects is returned.

Required

• this ; a bot instance

Optional - map of the following

• offset ; id of first update to return
• limit ; num of updates to retrieve (1-100). default: 100
• timeout ; timeout in seconds. default: 0 (short poll)
• allowed_updates ; json array of update types bot will receive

get-user-profile-photos clj multimethod

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

Required

• this ; a bot instance
• user_id ; id of target user

Optional

• offset ; number of first photo returned
• limit ; limit number of photos retrieved (1-100, default: 100)

get-webhook clj

(get-webhook this)

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

Required

• this ; a bot instance

kick-chat-member clj

(kick-chat-member this content)

(kick-chat-member this chat_id user_id)

(kick-chat-member this chat_id user_id & optional)

Use this method to kick a user from a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• user_id ; id of target user

Optional

• until_date ; unix time when user is unbanned. 30 seconds - 366 days. if less or more, user is banned forever.

leave-chat clj multimethod

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)

log-out clj

(log-out this)

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

Required

• this ; a bot instance

pin-chat-message clj

(pin-chat-message this content)

(pin-chat-message this chat_id message_id)

(pin-chat-message this chat_id message_id & optional)

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• message_id ; id of message to pin

Optional

• disable_notification ; true to pin silently. default true in channels.

promote-chat-member clj

(promote-chat-member this content)

(promote-chat-member this chat_id user_id)

(promote-chat-member this chat_id user_id & optional)

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• user_id ; id of target user

Optional

• is_anonymous ; true if admin presence in chat is hidden
• can_change_info ; true if admin can change chat title, photo, other settings
• can_post_messages ; true if admin can create channel posts
• can_edit_messages ; true if admin can edit messages of other users, pin messages
• can_delete_messages ; true if admin can delete messages of other users
• can_invite_users ; true if admin can invite new users to chat
• can_restrict_members ; true if admin can restrict, ban, unban members
• can_pin_messages ; true if admin can pin messages
• can_promote_members ; true if admin can add new admins

restrict-chat-member clj

(restrict-chat-member this content)

(restrict-chat-member this chat_id user_id permissions)

(restrict-chat-member this chat_id user_id permissions & optional)

Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• user_id ; id of target user
• permissions ; json object 'ChatPermissions' for new user permissions

Optional

• until_date ; unix time when user is unbanned. 30 seconds - 366 days. if less or more, user is banned forever.

send-animation clj

(send-animation this content)

(send-animation this chat_id animation)

(send-animation this chat_id animation & optional)

Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is rbeturned.

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• animation ; 'file_id' of animation to send that exists on Telegram servers or url

Optional

• duration ; duration of animation in seconds
• width
• height
• caption ; animation caption
• parse_mode ; entity parsing in animation caption
• caption_entities ; list of MessageEntity - can use instead of parse_mode
• thumb ; thumbnail of file sent
• disable_notification ; send silently
• reply_to_message_id ; id of the original message
• allow_sending_without_reply ; true to send message even if replied-to message is not found
• reply_markup ; additional interface options

send-audio clj

(send-audio this content)

(send-audio this chat_id audio)

(send-audio this chat_id audio & optional)

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.

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• audio ; 'file_id' of audio to send that exists on Telegram servers or url

Optional

• caption ; audio caption
• parse_mode ; entity parsing in audio caption
• caption_entities ; list of MessageEntity - can use instead of parse_mode
• duration ; duration of audio in seconds
• performer ; audio performer
• title ; audio track title
• thumb ; thumbnail of the file sent
• disable_notification ; send silently
• reply_to_message_id ; id of the original message
• allow_sending_without_reply ; true to send message even if replied-to message is not found
• reply_markup ; additional interface options

send-chat-action clj

(send-chat-action this content)

(send-chat-action this chat_id action)

(send-chat-action this chat_id action & optional)

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.

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• action ; type of action to broadcast (typing, upload_photo, record_video, upload_video, record_audio, upload_audio, upload_document, find_location, record_video_note, upload_video_note)

send-contact clj

(send-contact this content)

(send-contact this chat_id phone_number first_name)

(send-contact this chat_id phone_number first_name last_name)

(send-contact this chat_id phone_number first_name last_name & optional)

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• phone_number ; contact phone number
• first_name

Optional

• last_name
• vcard ; 'vCard' formatted additional data
• disable_notification ; send silently
• reply_to_message_id ; id of the original message
• allow_sending_without_reply ; true to send message even if replied-to message is not found
• reply_markup ; additional interface options

send-dice clj multimethod

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)

Optional

• emoji ; image for dice animation (default: dice)
• disable_notification ; send silently
• reply_to_message_id ; id of the original message
• allow_sending_without_reply ; true to send message even if replied-to message is not found
• reply_markup ; additional interface options

send-document clj

(send-document this content)

(send-document this chat_id document)

(send-document this chat_id document & optional)

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• document ; 'file_id' of document to send that exists on Telegram servers or url

Optional

• caption ; document caption
• parse_mode ; entity parsing in document caption
• caption_entities ; list of MessageEntity - can use instead of parse_mode
• thumb ; thumbnail of the file sent
• disable_content_type_detection ; disable auto content type detection for files uploaded
• disable_notification ; send silently
• reply_to_message_id ; id of the original message
• allow_sending_without_reply ; true to send message even if replied-to message is not found
• reply_markup ; additional interface options

send-game clj

(send-game this content)

(send-game this chat_id game_short_name)

(send-game this chat_id game_short_name & optional)

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

Required

• this ; a bot instance
• chat_id ; target chat id
• game_short_name ; serves as unique id for the game

Optional

• disable_notification ; send message silently
• reply_to_message_id ; id of original message
• allow_sending_without_reply ; true to send message even if replied-to message is not found
• reply_markup ; inline keyboard markup

send-invoice clj

(send-invoice this content)

(send-invoice this
              chat_id
              title
              description
              payload
              provider_token
              start_parameter
              currency
              prices)

(send-invoice this
              chat_id
              title
              description
              payload
              provider_token
              start_parameter
              currency
              prices
              &
              optional)

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

Required

• this ; a bot instance
• chat_id ; id for the target private chat
• title ; product name
• description ; product description
• payload ; internal bot defined invoice payload
• provider_token ; payments provider token
• start_parameter ; 'deep-linking' start param
• currency ; three letter ISO 4217 currency code
• prices ; 'LabeledPrice' array breakdown (price, tax, discount, delivery, etc)

Optional

• provider_data ; json data about invoice, payment provider specific
• photo_url ; product photo for the invoice
• photo_size
• photo_width
• photo_height
• need_name ; true if the user's full name is required for order
• need_phone_number ; true if the user's phone number is required for order
• need_email ; true if the user's email is required for order
• need_shipping_address ; true if the user's address is required for order
• send_phone_number_to_provider ; true to send phone number to provider
• send_email_to_provider ; true to send email to provider
• is_flexible ; true if final price depends on shipping method
• disable_notification ; send message silently
• reply_to_message_id ; id of original message if a reply
• allow_sending_without_reply ; true to send message even if replied-to message is not found
• reply_markup ; inline keyboard markup

send-location clj

(send-location this content)

(send-location this chat_id latitude longitude)

(send-location this chat_id latitude longitude & optional)

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• latitude ; lat of location
• longitude ; long of location

Optional

• horizontal_accuracy ; 1-1500 meters radius of uncertainty
• live_period ; seconds for which location will be updated (60-86400)
• heading ; 1-360 degrees direction user is moving
• proximity_alert_radius ; 1-100000 meters max distance for proximity alerts
• disable_notification ; send silently
• reply_to_message_id ; id of the original message
• allow_sending_without_reply ; true to send message even if replied-to message is not found
• reply_markup ; additional interface options

send-media-group clj

(send-media-group this content)

(send-media-group this chat_id media)

(send-media-group this chat_id media & optional)

Use this method to send a group of photos or videos as an album. On success, an array of the sent Messages is returned.

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• media ; json array describing photos/videos to be sent

Optional

• disable_notification ; send silently
• reply_to_message_id ; id of the original message
• allow_sending_without_reply ; true to send message even if replied-to message is not found

send-message clj

(send-message this content)

(send-message this chat_id text)

(send-message this chat_id text & optional)

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• text ; message to send

Optional

• parse_mode ; entity parsing in message
• entities ; list of MessageEntity - can use instead of parse_mode
• disable_web_page_preview ; disable link previews
• disable_notification ; send silently
• reply_to_message_id ; id of the original message
• allow_sending_without_reply ; true to send message even if replied-to message is not found
• reply_markup ; additional interface options

send-photo clj

(send-photo this content)

(send-photo this chat_id photo)

(send-photo this chat_id photo & optional)

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• photo ; 'file_id' of photo to send that exists on Telegram servers or url

Optional

• caption ; photo caption
• parse_mode ; entity parsing in photo caption
• caption_entities ; list of MessageEntity - can use instead of parse_mode
• disable_notification ; send silently
• reply_to_message_id ; id of the original message
• allow_sending_without_reply ; true to send message even if replied-to message is not found
• reply_markup ; additional interface options

send-poll clj

(send-poll this content)

(send-poll this chat_id question options)

(send-poll this chat_id question options & optional)

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• question ; poll question
• options ; array/list of answer options

Optional

• is_anonymous ; true if poll is anonymous
• type ; 'quiz' or 'regular' (default: regular)
• allows_multiple_answers ; true poll allows multiple answers
• correct_option_id ; 0-based id of correct answer. Required for quiz mode
• explanation ; shown when user chooses incorrect answer
• explanation_parse_mode ; parsing entities in explanation
• explanation_entities ; list of MessageEntity - can use instead of parse_mode
• open_period ; 5-600 seconds - time poll will be active
• close_date ; unix timestamp when poll will be auto closed (5-600 secs in future)
• is_closed ; true if poll needs to be immediately closed
• disable_notification ; send silently
• reply_to_message_id ; id of the original message
• allow_sending_without_reply ; true to send message even if replied-to message is not found
• reply_markup ; additional interface options

send-sticker clj

(send-sticker this content)

(send-sticker this chat_id sticker)

(send-sticker this chat_id sticker & optional)

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• sticker ; sticker to send, file_id for existing on Telegram servers

Optional

• disable_notification ; true to send message silently
• reply_to_message_id ; id of original message if reply
• allow_sending_without_reply ; true to send message even if replied-to message is not found
• reply_markup ; additional interface options

send-venue clj

(send-venue this content)

(send-venue this chat_id latitude longitude title address)

(send-venue this chat_id latitude longitude title address & optional)

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• latitude ; lat of venue
• longitude ; long of venue
• title ; name of venue
• address ; address of venue

Optional

• foursquare_id ; foursquare id of venue
• foursquare_type ; foursquare type of venue
• google_place_id ; Google Places id of venue
• google_place_type ; Google Places type of venue
• disable_notification ; send silently
• reply_to_message_id ; id of the original message
• allow_sending_without_reply ; true to send message even if replied-to message is not found
• reply_markup ; additional interface options

send-video clj

(send-video this content)

(send-video this chat_id video)

(send-video this chat_id video & optional)

Use tffhis method to send video files, Telegram clients support mp4 videos other formats may be sent as Document). On success, the sent Message is returned.

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• video ; 'file_id' of video to send that exists on Telegram servers or url

Optional

• duration ; duration of video in seconds
• width
• height
• caption ; video caption
• parse_mode ; entity parsing in video caption
• caption_entities ; list of MessageEntity - can use instead of parse_mode
• thumb ; thumbnail of file sent
• supports_streaming ; true if uploaded video is ok for streaming
• disable_notification ; send silently
• reply_to_message_id ; id of the original message
• allow_sending_without_reply ; true to send message even if replied-to message is not found
• reply_markup ; additional interface options

send-video-note clj

(send-video-note this content)

(send-video-note this chat_id video_note)

(send-video-note this chat_id video_note & optional)

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• video_note ; 'file_id' of video note that exists on Telegram servers or url

Optional

• duration ; duration of video in seconds
• length ; video width and height
• thumb ; thumbnail of the file sent
• disable_notification ; send silently
• reply_to_message_id ; id of the original message
• allow_sending_without_reply ; true to send message even if replied-to message is not found
• reply_markup ; additional interface options

send-voice clj

(send-voice this content)

(send-voice this chat_id voice)

(send-voice this chat_id voice & optional)

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.

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• voice ; 'file_id' of audio file that exists on Telegram servers or url

Optional

• duration ; duration of voice message in seconds
• caption ; voice message caption
• parse_mode ; entity parsing in voice message caption
• caption_entities ; list of MessageEntity - can use instead of parse_mode
• disable_notification ; send silently
• reply_to_message_id ; id of the original message
• allow_sending_without_reply ; true to send message even if replied-to message is not found
• reply_markup ; additional interface options

set-chat-administrator-custom-title clj

(set-chat-administrator-custom-title this content)

(set-chat-administrator-custom-title this chat_id user_id custom_title)

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• user_id ; id of target user
• custom_title ; new custom title for the admin

set-chat-description clj

(set-chat-description this content)

(set-chat-description this chat_id description)

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• description ; new chat description

set-chat-permissions clj

(set-chat-permissions this content)

(set-chat-permissions this chat_id permissions)

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• permissions ; new default chat permissions

set-chat-photo clj

(set-chat-photo this content)

(set-chat-photo this chat_id photo)

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• photo ; new chat photo

set-chat-sticker-set clj

(set-chat-sticker-set this content)

(set-chat-sticker-set this chat_id sticker_set_name)

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• sticker_set_name ; name of sticker set

set-chat-title clj

(set-chat-title this content)

(set-chat-title this chat_id title)

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• title ; new chat title

set-game-score clj

(set-game-score this content)

(set-game-score this chat_id message_id user_id score)

(set-game-score this chat_id message_id user_id score & optional)

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

Required

• this ; a bot instance
• chat_id ; id of target chat
• message_id ; id of the sent message
• user_id ; user identifier
• score ; new score, non-negative

Optional

• force ; true if high score is allowed to decrease
• disable_edit_message ; true if game msg should not be auto edited to include the scoreboard

set-game-score-inline clj

(set-game-score-inline this content)

(set-game-score-inline this inline_message_id user_id score)

(set-game-score-inline this inline_message_id user_id score & optional)

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

Required

• this ; a bot instance
• inline_message_id ; id of the inline message
• user_id ; user identifier
• score ; new score, non-negative

Optional

• force ; true if high score is allowed to decrease
• disable_edit_message ; true if game msg should not be auto edited to include the scoreboard

set-my-commands clj multimethod

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

Required

• this ; a bot instance
• commands ; json array/list of 'BotCommand'

set-passport-data-errors clj

(set-passport-data-errors this content)

(set-passport-data-errors this user_id errors)

Informs a user that some of the Telegram Passport elements they provided contains errors.

Required

• this ; a bot instance
• user_id ; user identifier
• errors ; json array of 'PassportElementError' describing the errors

set-sticker-position-in-set clj

(set-sticker-position-in-set this content)

(set-sticker-position-in-set this sticker position)

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

Required

• this ; a bot instance
• sticker ; file id of the sticker
• position ; new sticker position in the set

set-sticker-set-thumb clj

(set-sticker-set-thumb this content)

(set-sticker-set-thumb this name user_id)

(set-sticker-set-thumb this name user_id & optional)

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

Required

• this ; a bot instance
• name ; sticker set name
• user_id ; id of the sticker set owner

Optional

• thumb ; PNG image with the thumbnail

set-webhook clj multimethod

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.

Required

• this ; a bot instance
• url ; https url to send updates to. empty string to remove webhook

Optional

• certificate ; upload public key cert
• ip_address ; use this IP instead of resolving URL in DNS
• max_connections ; max allowed simultaneous https connections for updates. (1-100) default: 40
• allowed_updates ; json array of update types bot will receive
• drop_pending_updates ; Pass True to drop all pending updates

stop-message-live-location clj

(stop-message-live-location this content)

(stop-message-live-location this chat_id message_id)

(stop-message-live-location this chat_id message_id & optional)

Use this method to stop updating a live location message before live_period expires. On success, if the message was sent by the bot, the sent Message is returned, otherwise True is returned.

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• message_id ; id of the message to edit

Optional

• reply_markup ; additional interface options

stop-message-live-location-inline clj multimethod

Use this method to stop updating a live location inline message before live_period expires. On success, if the message was sent by the bot, the sent Message is returned, otherwise True is returned.

Required

• this ; a bot instance
• inline_message_id ; id of the inline message to edit

Optional

• reply_markup ; additional interface options

stop-poll clj

(stop-poll this content)

(stop-poll this chat_id message_id)

(stop-poll this chat_id message_id & optional)

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• message_id ; id of original message with the poll

Optional

• reply_markup ; inline keyboard markup

TBot clj

unban-chat-member clj

(unban-chat-member this content)

(unban-chat-member this chat_id user_id)

(unban-chat-member this chat_id user_id & optional)

Use this method to unban a previously kicked user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. Returns True on success.

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• user_id ; id of target user

Optional

• only_if_banned ; Do nothing if the user is not banned

unpin-all-chat-messages clj multimethod

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' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success.

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)

unpin-chat-message clj multimethod

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

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)

Optional

• message_id ; id of message to unpin (unpins most recent if not specified)

upload-sticker-file clj

(upload-sticker-file this content)

(upload-sticker-file this user_id png_sticker)

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.

Required

• this ; a bot instance
• user_id ; id of sticker file owner
• png_sticker ; PNG image with the sticker