Package {telegramR}

Addition operator for raw (fallback)

Description

This is tricky because we can't easily override '+' for base 'raw' type. But if the first operand is 'raw_bytes', it works. If the first operand is 'raw', we might need to cast it.

Usage

## S3 method for class 'raw'
e1 + e2

Arguments

Value

A new raw_bytes object.

Addition operator for raw_bytes

Description

Allows using '+' to concatenate raw_bytes objects, mimicking Python's byte concatenation.

Usage

## S3 method for class 'raw_bytes'
e1 + e2

Arguments

Value

A new raw_bytes object.

TelegramClient

Description

High-level 'Telegram' 'MTProto' client. Create one with TelegramClient$new(session, api_id, api_hash), then $start() (interactive login) or $connect() together with $send_code_request() and $sign_in() to authenticate. Once connected it exposes the messaging, channel, media and download methods used throughout the package documentation.

Details

This is an R6 class. Typical usage:

client <- TelegramClient$new("my_session", api_id = 123, api_hash = "...")
client$connect()

Value

An R6 generator object of class TelegramClient.

Super class

telegramR::TelegramBaseClient -> TelegramClient

Methods

Public methods

• TelegramClient$takeout()

• TelegramClient$end_takeout()

• TelegramClient$start()

• TelegramClient$sign_in()

• TelegramClient$sign_up()

• TelegramClient$send_code_request()

• TelegramClient$qr_login()

• TelegramClient$log_out()

• TelegramClient$edit_2fa()

• TelegramClient$parse_phone_and_hash()

• TelegramClient$on_login()

• TelegramClient$start_impl()

• TelegramClient$parse_phone()

• TelegramClient$compute_check()

• TelegramClient$compute_digest()

• TelegramClient$get_display_name()

• TelegramClient$download_profile_photo()

• TelegramClient$download_media()

• TelegramClient$download_file()

• TelegramClient$.download_file()

• TelegramClient$iter_download()

• TelegramClient$.iter_download()

• TelegramClient$get_thumb()

• TelegramClient$download_cached_photo_size()

• TelegramClient$download_photo()

• TelegramClient$get_kind_and_names()

• TelegramClient$download_document()

• TelegramClient$download_contact()

• TelegramClient$download_web_document()

• TelegramClient$get_proper_filename()

• TelegramClient$iter_dialogs()

• TelegramClient$get_dialogs()

• TelegramClient$iter_drafts()

• TelegramClient$get_drafts()

• TelegramClient$edit_folder()

• TelegramClient$delete_dialog()

• TelegramClient$conversation()

• TelegramClient$iter_participants()

• TelegramClient$get_participants()

• TelegramClient$iter_admin_log()

• TelegramClient$get_admin_log()

• TelegramClient$iter_profile_photos()

• TelegramClient$get_profile_photos()

• TelegramClient$action()

• TelegramClient$edit_admin()

• TelegramClient$edit_permissions()

• TelegramClient$kick_participant()

• TelegramClient$get_permissions()

• TelegramClient$get_stats()

• TelegramClient$inline_query()

• TelegramClient$invoke_function()

• TelegramClient$custom_inline_results()

• TelegramClient$iter_messages()

• TelegramClient$iter_messages_page()

• TelegramClient$get_messages()

• TelegramClient$channels_get_messages()

• TelegramClient$collect()

• TelegramClient$collect_one()

• TelegramClient$send_message()

• TelegramClient$forward_messages()

• TelegramClient$edit_message()

• TelegramClient$delete_messages()

• TelegramClient$send_read_acknowledge()

• TelegramClient$pin_message()

• TelegramClient$unpin_message()

• TelegramClient$get_comment_data()

• TelegramClient$pin_internal()

• TelegramClient$send_file()

• TelegramClient$upload_file()

• TelegramClient$file_to_media()

• TelegramClient$resize_photo_if_needed()

• TelegramClient$is_image()

• TelegramClient$get_appropriated_part_size()

• TelegramClient$invoke()

• TelegramClient$build_reply_markup()

• TelegramClient$run_until_disconnected()

• TelegramClient$set_receive_updates()

• TelegramClient$on()

• TelegramClient$add_event_handler()

• TelegramClient$remove_event_handler()

• TelegramClient$list_event_handlers()

• TelegramClient$catch_up()

• TelegramClient$update_loop()

• TelegramClient$preprocess_updates()

• TelegramClient$keepalive_loop()

• TelegramClient$dispatch_update()

• TelegramClient$handle_auto_reconnect()

• TelegramClient$set_parse_mode()

• TelegramClient$get_parse_mode()

• TelegramClient$sanitize_parse_mode()

• TelegramClient$parse_message_text()

• TelegramClient$replace_with_mention()

• TelegramClient$get_response_message()

• TelegramClient$call()

• TelegramClient$call_internal()

• TelegramClient$get_me()

• TelegramClient$self_id()

• TelegramClient$is_bot()

• TelegramClient$is_user_authorized()

• TelegramClient$get_entity()

• TelegramClient$get_input_entity()

• TelegramClient$getInputEntity()

• TelegramClient$getInputPeer()

• TelegramClient$getInputUser()

• TelegramClient$getInputChannel()

• TelegramClient$getInputMessage()

• TelegramClient$getInputMedia()

• TelegramClient$getInputDocument()

• TelegramClient$getInputPhoto()

• TelegramClient$getInputChatPhoto()

• TelegramClient$getInputGroupCall()

• TelegramClient$get_peer()

• TelegramClient$get_peer_id()

• TelegramClient$get_entity_from_string()

• TelegramClient$get_input_dialog()

• TelegramClient$get_input_notify()

• TelegramClient$download_files_parallel()

• TelegramClient$new()

• TelegramClient$clone()

Method takeout()

Usage

TelegramClient$takeout(
  finalize = TRUE,
  contacts = NULL,
  users = NULL,
  chats = NULL,
  megagroups = NULL,
  channels = NULL,
  files = NULL,
  max_file_size = NULL
)

Method end_takeout()

Usage

TelegramClient$end_takeout(success)

Method start()

Usage

TelegramClient$start(
  phone = NULL,
  password = NULL,
  bot_token = NULL,
  force_sms = FALSE,
  code_callback = NULL,
  first_name = "New User",
  last_name = "",
  max_attempts = 3
)

Method sign_in()

Usage

TelegramClient$sign_in(
  phone = NULL,
  code = NULL,
  password = NULL,
  bot_token = NULL,
  phone_code_hash = NULL
)

Method sign_up()

Usage

TelegramClient$sign_up(
  code,
  first_name,
  last_name = "",
  phone = NULL,
  phone_code_hash = NULL
)

Method send_code_request()

Usage

TelegramClient$send_code_request(phone, force_sms = FALSE, retry_count = 0)

Method qr_login()

Usage

TelegramClient$qr_login(ignored_ids = NULL)

Method log_out()

Usage

TelegramClient$log_out()

Method edit_2fa()

Usage

TelegramClient$edit_2fa(
  current_password = NULL,
  new_password = NULL,
  hint = "",
  email = NULL,
  email_code_callback = NULL
)

Method parse_phone_and_hash()

Usage

TelegramClient$parse_phone_and_hash(phone, phone_hash)

Method on_login()

Usage

TelegramClient$on_login(user)

Method start_impl()

Usage

TelegramClient$start_impl(
  phone,
  password,
  bot_token,
  force_sms,
  code_callback,
  first_name,
  last_name,
  max_attempts
)

Method parse_phone()

Usage

TelegramClient$parse_phone(phone)

Method compute_check()

Usage

TelegramClient$compute_check(request, password)

Method compute_digest()

Usage

TelegramClient$compute_digest(algo, password)

Method get_display_name()

Usage

TelegramClient$get_display_name(user)

Method download_profile_photo()

Usage

TelegramClient$download_profile_photo(entity, file = NULL, download_big = TRUE)

Method download_media()

Usage

TelegramClient$download_media(
  message,
  file = NULL,
  thumb = NULL,
  progress_callback = NULL
)

Method download_file()

Usage

TelegramClient$download_file(
  input_location,
  file = NULL,
  part_size_kb = NULL,
  file_size = NULL,
  progress_callback = NULL,
  dc_id = NULL,
  key = NULL,
  iv = NULL,
  msg_data = NULL,
  cdn_redirect = NULL
)

Method .download_file()

Usage

TelegramClient$.download_file(
  input_location,
  file = NULL,
  part_size_kb = NULL,
  file_size = NULL,
  progress_callback = NULL,
  dc_id = NULL,
  key = NULL,
  iv = NULL,
  msg_data = NULL,
  cdn_redirect = NULL
)

Method iter_download()

Usage

TelegramClient$iter_download(
  file,
  offset = 0,
  stride = NULL,
  limit = NULL,
  chunk_size = NULL,
  request_size = MAX_CHUNK_SIZE,
  file_size = NULL,
  dc_id = NULL,
  msg_data = NULL,
  cdn_redirect = NULL
)

Method .iter_download()

Usage

TelegramClient$.iter_download(
  file,
  offset = 0,
  stride = NULL,
  limit = NULL,
  chunk_size = NULL,
  request_size = MAX_CHUNK_SIZE,
  file_size = NULL,
  dc_id = NULL,
  msg_data = NULL,
  cdn_redirect = NULL
)

Method get_thumb()

Usage

TelegramClient$get_thumb(thumbs, thumb)

Method download_cached_photo_size()

Usage

TelegramClient$download_cached_photo_size(size, file)

Method download_photo()

Usage

TelegramClient$download_photo(photo, file, date, thumb, progress_callback)

Method get_kind_and_names()

Usage

TelegramClient$get_kind_and_names(attributes)

Method download_document()

Usage

TelegramClient$download_document(
  document,
  file,
  date,
  thumb,
  progress_callback,
  msg_data
)

Method download_contact()

Usage

TelegramClient$download_contact(mm_contact, file)

Method download_web_document()

Usage

TelegramClient$download_web_document(web, file, progress_callback)

Method get_proper_filename()

Usage

TelegramClient$get_proper_filename(
  file,
  kind,
  extension,
  date = NULL,
  possible_names = NULL
)

Method iter_dialogs()

Usage

TelegramClient$iter_dialogs(
  limit = NULL,
  offset_date = NULL,
  offset_id = 0,
  offset_peer = InputPeerEmpty$new(),
  ignore_pinned = FALSE,
  ignore_migrated = FALSE,
  folder = NULL,
  archived = NULL
)

Method get_dialogs()

Usage

TelegramClient$get_dialogs(
  limit = NULL,
  offset_date = NULL,
  offset_id = 0,
  offset_peer = InputPeerEmpty$new(),
  ignore_pinned = FALSE,
  ignore_migrated = FALSE,
  folder = NULL,
  archived = NULL
)

Method iter_drafts()

Usage

TelegramClient$iter_drafts(entity = NULL)

Method get_drafts()

Usage

TelegramClient$get_drafts(entity = NULL)

Method edit_folder()

Usage

TelegramClient$edit_folder(entity = NULL, folder = NULL, unpack = NULL)

Method delete_dialog()

Usage

TelegramClient$delete_dialog(entity, revoke = FALSE)

Method conversation()

Usage

TelegramClient$conversation(
  entity,
  timeout = 60,
  total_timeout = NULL,
  max_messages = 100,
  exclusive = TRUE,
  replies_are_responses = TRUE
)

Method iter_participants()

Usage

TelegramClient$iter_participants(
  entity,
  limit = NULL,
  search = "",
  filter = NULL,
  aggressive = FALSE
)

Method get_participants()

Usage

TelegramClient$get_participants(...)

Method iter_admin_log()

Usage

TelegramClient$iter_admin_log(
  entity,
  limit = NULL,
  max_id = 0,
  min_id = 0,
  search = NULL,
  admins = NULL,
  join = NULL,
  leave = NULL,
  invite = NULL,
  restrict = NULL,
  unrestrict = NULL,
  ban = NULL,
  unban = NULL,
  promote = NULL,
  demote = NULL,
  info = NULL,
  settings = NULL,
  pinned = NULL,
  edit = NULL,
  delete = NULL,
  group_call = NULL
)

Method get_admin_log()

Usage

TelegramClient$get_admin_log(...)

Method iter_profile_photos()

Usage

TelegramClient$iter_profile_photos(
  entity,
  limit = NULL,
  offset = 0,
  max_id = 0
)

Method get_profile_photos()

Usage

TelegramClient$get_profile_photos(...)

Method action()

Usage

TelegramClient$action(entity, action, delay = 4, auto_cancel = TRUE)

Method edit_admin()

Usage

TelegramClient$edit_admin(
  entity,
  user,
  change_info = NULL,
  post_messages = NULL,
  edit_messages = NULL,
  delete_messages = NULL,
  ban_users = NULL,
  invite_users = NULL,
  pin_messages = NULL,
  add_admins = NULL,
  manage_call = NULL,
  anonymous = NULL,
  is_admin = NULL,
  title = NULL
)

Method edit_permissions()

Usage

TelegramClient$edit_permissions(
  entity,
  user = NULL,
  until_date = NULL,
  view_messages = TRUE,
  send_messages = TRUE,
  send_media = TRUE,
  send_stickers = TRUE,
  send_gifs = TRUE,
  send_games = TRUE,
  send_inline = TRUE,
  embed_link_previews = TRUE,
  send_polls = TRUE,
  change_info = TRUE,
  invite_users = TRUE,
  pin_messages = TRUE
)

Method kick_participant()

Usage

TelegramClient$kick_participant(entity, user)

Method get_permissions()

Usage

TelegramClient$get_permissions(entity, user = NULL)

Method get_stats()

Usage

TelegramClient$get_stats(entity, message = NULL)

Method inline_query()

Usage

TelegramClient$inline_query(
  bot,
  query,
  entity = NULL,
  offset = NULL,
  geo_point = NULL
)

Method invoke_function()

Usage

TelegramClient$invoke_function(function_name, params)

Method custom_inline_results()

Usage

TelegramClient$custom_inline_results(result, peer)

Method iter_messages()

Usage

TelegramClient$iter_messages(
  entity,
  limit = NULL,
  offset_date = NULL,
  offset_id = 0L,
  max_id = 0L,
  min_id = 0L,
  add_offset = 0L,
  search = NULL,
  filter = NULL,
  from_user = NULL,
  wait_time = NULL,
  ids = NULL,
  reverse = FALSE,
  reply_to = NULL,
  scheduled = FALSE
)

Method iter_messages_page()

Usage

TelegramClient$iter_messages_page(
  entity,
  limit = NULL,
  offset_date = NULL,
  offset_id = 0L,
  max_id = 0L,
  min_id = 0L,
  add_offset = 0L,
  search = NULL,
  filter = NULL,
  from_user = NULL,
  wait_time = NULL,
  reverse = FALSE,
  reply_to = NULL,
  scheduled = FALSE
)

Method get_messages()

Usage

TelegramClient$get_messages(...)

Method channels_get_messages()

Usage

TelegramClient$channels_get_messages(channel, ids)

Method collect()

Usage

TelegramClient$collect(it)

Method collect_one()

Usage

TelegramClient$collect_one(it)

Method send_message()

Usage

TelegramClient$send_message(
  entity,
  message = "",
  reply_to = NULL,
  attributes = NULL,
  parse_mode = NULL,
  formatting_entities = NULL,
  link_preview = TRUE,
  file = NULL,
  thumb = NULL,
  force_document = FALSE,
  clear_draft = FALSE,
  buttons = NULL,
  silent = NULL,
  background = NULL,
  supports_streaming = FALSE,
  schedule = NULL,
  comment_to = NULL,
  nosound_video = NULL,
  send_as = NULL,
  message_effect_id = NULL
)

Method forward_messages()

Usage

TelegramClient$forward_messages(
  entity,
  messages,
  from_peer = NULL,
  background = NULL,
  with_my_score = NULL,
  silent = NULL,
  as_album = NULL,
  schedule = NULL,
  drop_author = NULL,
  drop_media_captions = NULL
)

Method edit_message()

Usage

TelegramClient$edit_message(
  entity,
  message = NULL,
  text = NULL,
  parse_mode = NULL,
  attributes = NULL,
  formatting_entities = NULL,
  link_preview = TRUE,
  file = NULL,
  thumb = NULL,
  force_document = FALSE,
  buttons = NULL,
  supports_streaming = FALSE,
  schedule = NULL
)

Method delete_messages()

Usage

TelegramClient$delete_messages(entity, message_ids, revoke = TRUE)

Method send_read_acknowledge()

Usage

TelegramClient$send_read_acknowledge(
  entity,
  message = NULL,
  max_id = NULL,
  clear_mentions = FALSE,
  clear_reactions = FALSE
)

Method pin_message()

Usage

TelegramClient$pin_message(entity, message, notify = FALSE, pm_oneside = FALSE)

Method unpin_message()

Usage

TelegramClient$unpin_message(entity, message = NULL, notify = FALSE)

Method get_comment_data()

Usage

TelegramClient$get_comment_data(entity, message)

Method pin_internal()

Usage

TelegramClient$pin_internal(
  entity,
  message,
  unpin,
  notify = FALSE,
  pm_oneside = FALSE
)

Method send_file()

Usage

TelegramClient$send_file(
  entity,
  file,
  caption = NULL,
  force_document = FALSE,
  file_size = NULL,
  progress_callback = NULL,
  ...
)

Method upload_file()

Usage

TelegramClient$upload_file(
  file,
  part_size_kb = NULL,
  file_size = NULL,
  progress_callback = NULL,
  ...
)

Method file_to_media()

Usage

TelegramClient$file_to_media(
  file,
  force_document = FALSE,
  file_size = NULL,
  progress_callback = NULL,
  attributes = NULL,
  thumb = NULL,
  allow_cache = TRUE,
  voice_note = FALSE,
  video_note = FALSE,
  supports_streaming = FALSE,
  mime_type = NULL,
  as_image = NULL,
  ttl = NULL,
  nosound_video = NULL
)

Method resize_photo_if_needed()

Usage

TelegramClient$resize_photo_if_needed(
  file,
  is_image,
  width = 2560,
  height = 2560
)

Method is_image()

Usage

TelegramClient$is_image(file)

Method get_appropriated_part_size()

Usage

TelegramClient$get_appropriated_part_size(file_size)

Method invoke()

Usage

TelegramClient$invoke(request)

Method build_reply_markup()

Usage

TelegramClient$build_reply_markup(buttons = NULL, inline_only = FALSE)

Method run_until_disconnected()

Usage

TelegramClient$run_until_disconnected()

Method set_receive_updates()

Usage

TelegramClient$set_receive_updates(receive_updates)

Method on()

Usage

TelegramClient$on(event)

Method add_event_handler()

Usage

TelegramClient$add_event_handler(callback, event = NULL)

Method remove_event_handler()

Usage

TelegramClient$remove_event_handler(callback, event = NULL)

Method list_event_handlers()

Usage

TelegramClient$list_event_handlers()

Method catch_up()

Usage

TelegramClient$catch_up()

Method update_loop()

Usage

TelegramClient$update_loop()

Method preprocess_updates()

Usage

TelegramClient$preprocess_updates(updates, users, chats)

Method keepalive_loop()

Usage

TelegramClient$keepalive_loop()

Method dispatch_update()

Usage

TelegramClient$dispatch_update(update)

Method handle_auto_reconnect()

Usage

TelegramClient$handle_auto_reconnect()

Method set_parse_mode()

Usage

TelegramClient$set_parse_mode(mode)

Method get_parse_mode()

Usage

TelegramClient$get_parse_mode()

Method sanitize_parse_mode()

Usage

TelegramClient$sanitize_parse_mode(mode)

Method parse_message_text()

Usage

TelegramClient$parse_message_text(message, parse_mode = NULL)

Method replace_with_mention()

Usage

TelegramClient$replace_with_mention(entities, i, user)

Method get_response_message()

Usage

TelegramClient$get_response_message(request, result, input_chat)

Method call()

Usage

TelegramClient$call(request, ordered = FALSE, flood_sleep_threshold = NULL)

Method call_internal()

Usage

TelegramClient$call_internal(
  sender,
  request,
  ordered = FALSE,
  flood_sleep_threshold = NULL
)

Method get_me()

Usage

TelegramClient$get_me(input_peer = FALSE)

Method self_id()

Usage

TelegramClient$self_id()

Method is_bot()

Usage

TelegramClient$is_bot()

Method is_user_authorized()

Usage

TelegramClient$is_user_authorized()

Method get_entity()

Usage

TelegramClient$get_entity(entity)

Method get_input_entity()

Usage

TelegramClient$get_input_entity(peer)

Method getInputEntity()

Usage

TelegramClient$getInputEntity(peer)

Method getInputPeer()

Usage

TelegramClient$getInputPeer(peer, allow_self = TRUE, check_hash = TRUE)

Method getInputUser()

Usage

TelegramClient$getInputUser(entity)

Method getInputChannel()

Usage

TelegramClient$getInputChannel(entity)

Method getInputMessage()

Usage

TelegramClient$getInputMessage(message)

Method getInputMedia()

Usage

TelegramClient$getInputMedia(
  media,
  is_photo = FALSE,
  attributes = NULL,
  force_document = FALSE,
  file_size = NULL,
  progress_callback = NULL
)

Method getInputDocument()

Usage

TelegramClient$getInputDocument(document)

Method getInputPhoto()

Usage

TelegramClient$getInputPhoto(photo)

Method getInputChatPhoto()

Usage

TelegramClient$getInputChatPhoto(photo)

Method getInputGroupCall()

Usage

TelegramClient$getInputGroupCall(call)

Method get_peer()

Usage

TelegramClient$get_peer(peer)

Method get_peer_id()

Usage

TelegramClient$get_peer_id(peer, add_mark = TRUE)

Method get_entity_from_string()

Usage

TelegramClient$get_entity_from_string(string)

Method get_input_dialog()

Usage

TelegramClient$get_input_dialog(dialog)

Method get_input_notify()

Usage

TelegramClient$get_input_notify(notify)

Method download_files_parallel()

Usage

TelegramClient$download_files_parallel(
  items,
  output_dir = NULL,
  workers = 4L,
  stagger_ms = 500L
)

Method new()

Usage

TelegramClient$new(...)

Method clone()

The objects of this class are cloneable with this method.

Usage

TelegramClient$clone(deep = FALSE)

Arguments

Examples

## Not run: 
client <- TelegramClient$new("my_session", api_id = 123, api_hash = "...")
client$start()

## End(Not run)

Add a user to a chat or channel

Description

Add a user to a chat or channel

Usage

add_user_to_chat(client, chat, user, fwd_limit = 10)

Arguments

Value

The API response.

Batch Download Multiple Telegram Channels

Description

Downloads info and messages for multiple channels in sequence, running each channel in an isolated callr subprocess so crashes cannot corrupt the parent session. Supports resume: channels already present in msgs_file are skipped when skip_completed = TRUE.

Usage

batch_download_channels(
  channels,
  session,
  api_id,
  api_hash,
  info_file = NULL,
  msgs_file = NULL,
  reactions_file = NULL,
  replies_file = NULL,
  start_date = NULL,
  limit = Inf,
  timeout_sec = 30,
  max_timeouts = 5,
  chunk_size = 5000L,
  skip_completed = TRUE,
  dedup = TRUE,
  pkg_path = NULL,
  workers = 1L,
  verbose = TRUE
)

Arguments

Value

A tibble with columns channel, status ("ok"/"skipped"/"error"), rows_downloaded, error_message.

Check a chat invite link without joining

Description

Check a chat invite link without joining

Usage

check_invite_link(client, invite_link)

Arguments

Value

The API response.

Check whether a single phone number is registered on Telegram

Description

Adds the phone number to the authenticated account's contacts via 'ImportContactsRequest', captures any matching user, then removes the contact via 'DeleteContactsRequest'. The contact addition is transient — Telegram users are not notified.

Usage

check_phone_on_telegram(
  client,
  phone,
  download_profile_photo = FALSE,
  photo_dir = NULL
)

Arguments

Value

A named list with the user's public fields, or a list with an 'error' field describing why the lookup failed (no match, multiple matches, RPC error, ...).

See Also

[check_phones_on_telegram()] for batch lookups.

Check several phone numbers in one call

Description

Convenience wrapper around [check_phone_on_telegram()] that accepts either a character vector or a single comma-separated string (matching the upstream Python CLI). Duplicates are silently de-duplicated.

Usage

check_phones_on_telegram(
  client,
  phones,
  download_profile_photo = FALSE,
  photo_dir = NULL
)

Arguments

Value

A tibble with one row per unique phone number. Successful lookups expose the user's public fields; failures expose an 'error' column.

See Also

[check_phone_on_telegram()] for the single-phone variant.

Check whether a single username belongs to a Telegram user

Description

Looks up the username via 'client$get_entity()'. Channels and group chats produce an 'error' row — this helper is for user accounts only.

Usage

check_username_on_telegram(
  client,
  username,
  download_profile_photo = FALSE,
  photo_dir = NULL
)

Arguments

Value

A named list with the user's public fields, or a list with an 'error' field.

See Also

[check_usernames_on_telegram()] for batch lookups.

Check several usernames in one call

Description

Convenience wrapper around [check_username_on_telegram()].

Usage

check_usernames_on_telegram(
  client,
  usernames,
  download_profile_photo = FALSE,
  photo_dir = NULL
)

Arguments

Value

A tibble with one row per unique username.

See Also

[check_username_on_telegram()] for the single-username variant.

Download Full Channel Info By Channel

Description

Fetches channel entity and full channel info by username or numeric id and returns a tibble.

Usage

download_channel_info(
  client,
  channel,
  region = NULL,
  include_raw = FALSE,
  timeout_sec = getOption("telegramR.iter_timeout", 60),
  reconnect_on_timeout = TRUE,
  max_attempts = 3,
  skip_estimate = FALSE,
  hard_timeout_sec = NULL
)

Arguments

Value

A tibble with flattened channel info and optional list columns for raw objects.

Download Channel Media By Channel

Description

Downloads media (photos/videos/documents) from a channel by username or numeric id and returns a tibble with file paths.

Usage

download_channel_media(
  client,
  channel,
  limit = Inf,
  start_date = NULL,
  end_date = NULL,
  media_types = c("photo", "video", "image", "document"),
  out_dir = NULL,
  show_progress = TRUE,
  wait_time = 0,
  retries = 1,
  include_errors = TRUE,
  use_original_filename = FALSE,
  ...
)

Arguments

Value

A tibble with message_id, channel info, media_type, file_path, and original_filename.

Download Channel Members By Channel

Description

Fetches channel members (participants) by username or numeric id.

Usage

download_channel_members(
  client,
  channel,
  limit = Inf,
  search = "",
  filter = NULL,
  include_channel = TRUE,
  show_progress = TRUE
)

Arguments

Value

A tibble.

Download Channel Messages By Channel

Description

Fetches messages for a channel by username or numeric id and returns a tibble with message fields and nested structures as list columns.

Usage

download_channel_messages(
  client,
  channel,
  limit = Inf,
  include_channel = TRUE,
  start_date = NULL,
  end_date = NULL,
  since_message_id = NULL,
  show_progress = TRUE,
  timeout_sec = getOption("telegramR.iter_timeout", 60),
  max_timeouts = 3,
  reconnect_on_timeout = TRUE,
  output_file = NULL,
  chunk_size = 5000L,
  partial_on_error = TRUE,
  ...
)

Arguments

Value

A tibble (or invisible row count when output_file is set).

Download Channel Reactions By Channel

Description

Fetches message reactions for a channel by username or numeric id.

Usage

download_channel_reactions(
  client,
  channel,
  limit = Inf,
  start_date = NULL,
  end_date = NULL,
  include_channel = TRUE,
  show_progress = TRUE,
  output_file = NULL,
  chunk_size = 5000L,
  ...
)

Arguments

Value

A tibble.

Download Channel Replies/Comments By Channel

Description

Fetches replies (comments) to channel posts by username or numeric id.

Usage

download_channel_replies(
  client,
  channel,
  message_ids = NULL,
  message_limit = 100,
  reply_limit = Inf,
  include_channel = TRUE,
  show_progress = TRUE,
  output_file = NULL,
  chunk_size = 5000L,
  ...
)

Arguments

Value

A tibble.

Estimate Channel Post Count (Approx)

Description

Gets the latest message ID and uses it as an upper-bound estimate of total posts. This is approximate due to deletions and gaps in message IDs.

Usage

estimate_channel_post_count(
  client,
  channel,
  timeout_sec = getOption("telegramR.iter_timeout", 60),
  reconnect_on_timeout = TRUE
)

Arguments

Value

A tibble with last_message_id and a note.

Retrieve full information about a user

Description

Retrieve full information about a user

Usage

get_full_user(client, user = "me")

Arguments

Value

The API response (UserFull).

Increase view count for channel messages

Description

Increase view count for channel messages

Usage

increase_view_count(client, channel, message_ids)

Arguments

Value

The API response (views).

Join a chat or channel by username or invite link

Description

Join a chat or channel by username or invite link

Usage

join_channel(client, channel)

Arguments

Value

The API response.

Join a private chat or channel by invite link

Description

Join a private chat or channel by invite link

Usage

join_private_chat(client, invite_link)

Arguments

Value

The API response.

Join a public channel by username

Description

Join a public channel by username

Usage

join_public_channel(client, channel)

Arguments

Value

The API response.

Check whether phone numbers or usernames belong to Telegram accounts

Description

These helpers port the functionality of bellingcat's telegram-phone-number-checker Python tool to R. They use the currently authenticated [TelegramClient] to look up users by phone number (via 'ImportContactsRequest' / 'DeleteContactsRequest') or by username (via 'client$get_entity()'), and return the public profile fields Telegram returns about the matched user.

Details

Phone-number lookups briefly add the number to your contact list and then delete it. Telegram throttles abusive callers — Bellingcat recommends using a fresh, residential-IP account rather than a personal one.

Send an Audio File

Description

Convenience wrapper to send an audio file to a target entity.

Usage

send_audio(client, entity, file, ...)

Arguments

Value

The sent message object (or Updates result).

Send a Document

Description

Convenience wrapper to send a document (file) to a target entity.

Usage

send_document(client, entity, file, ...)

Arguments

Value

The sent message object (or Updates result).

Send a File

Description

Convenience wrapper around 'TelegramClient$send_message()' that sends a file and resolves futures/promises.

Usage

send_file(client, entity, file, ...)

Arguments

Value

The sent message object (or Updates result).

Send a Message

Description

Convenience wrapper around 'TelegramClient$send_message()' that resolves futures/promises and returns the sent message (or Updates object).

Usage

send_message(client, entity, ...)

Arguments

Value

The sent message object (or Updates result).

Send a Photo

Description

Convenience wrapper to send a photo to a target entity.

Usage

send_photo(client, entity, file, ...)

Arguments

Value

The sent message object (or Updates result).

Send a Video

Description

Convenience wrapper to send a video to a target entity.

Usage

send_video(client, entity, file, ...)

Arguments

Value

The sent message object (or Updates result).

Update your name and/or bio

Description

Update your name and/or bio

Usage

update_profile(client, first_name = NULL, last_name = NULL, bio = NULL)

Arguments

Value

The API response.

Update your profile photo

Description

Update your profile photo

Usage

update_profile_photo(client, file, progress_callback = NULL)

Arguments

Value

The API response.

Update your username

Description

Update your username

Usage

update_username(client, username)

Arguments

Value

The API response.