Word of caution: this documentation is generated automatically from https://core.telegram.org/bots/api and can be incomplete or wrongly formatted. Also this documentation do not contain information about general principles of the Telegram API and response objects. So, if you have any doubts, consult original api documentation and consider it as a ground truth. These docs were generated only for simpler navigation and better help hints in REPL and editors.

Please notice that this package implements the Bot API. The Telegram Bot API is an API specifically for bots, which is simpler but less customisable. It acts as an intermediary between bots and the Telegram API which allow you to build your own customized Telegram clients.

All API functions have TelegramClient as optional positional argument, which means that if it is not set explicitly, than global client is used, which is usually created during initial construction or by explicit call of useglobally! function.

All arguments usually have String/Boolean/Integer types which is in one to one correspondence with julian types. Special arguments like document, photo and the like, which are intended for file sending, can accept either IOStream argument as in open("picture.png", "r") or Pair{String, IO} in case of in-memory IO objects without names. Read Usage for additional info.

API Reference

Telegram.API.getUpdates — Function

getUpdates([tg::TelegramClient]; kwargs...)

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

Optional arguments

offset: (Integer) Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will be forgotten.
limit: (Integer) Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.
timeout: (Integer) Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only.
allowed_updates: (Array of String) A JSON-serialized list of the update types you want your bot to receive. For example, specify [“message”, “editedchannelpost”, “callbackquery”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chatmember (default). If not specified, the previous setting will be used.Please note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.

Notes1. This method will not work if an outgoing webhook is set up.2. In order to avoid getting duplicate updates, recalculate offset after each server response.