Namespaces
	broadcast

	polling

	webhooks

Classes
class	BaseTelegramBotEntity

class	TelegramNotificationService

Functions
io.BytesIO	_read_file_as_bytesio (str file_path)

bool	async_setup (HomeAssistant hass, ConfigType config)

Bot	initialize_bot (HomeAssistant hass, dict p_config)

def	load_data (hass, url=None, filepath=None, username=None, password=None, authentication=None, num_retries=5, verify_ssl=None)

Variables
	_LOGGER = logging.getLogger(__name__)

string	ATTR_ALLOWS_MULTIPLE_ANSWERS = "allows_multiple_answers"

string	ATTR_ANSWERS = "answers"

string	ATTR_ARGS = "args"

string	ATTR_AUTHENTICATION = "authentication"

string	ATTR_CALLBACK_QUERY = "callback_query"

string	ATTR_CALLBACK_QUERY_ID = "callback_query_id"

string	ATTR_CAPTION = "caption"

string	ATTR_CHANNEL_POST = "channel_post"

string	ATTR_CHAT_ID = "chat_id"

string	ATTR_CHAT_INSTANCE = "chat_instance"

string	ATTR_DATA = "data"

string	ATTR_DATE = "date"

string	ATTR_DISABLE_NOTIF = "disable_notification"

string	ATTR_DISABLE_WEB_PREV = "disable_web_page_preview"

string	ATTR_EDITED_MSG = "edited_message"

string	ATTR_FILE = "file"

string	ATTR_FROM_FIRST = "from_first"

string	ATTR_FROM_LAST = "from_last"

string	ATTR_IS_ANONYMOUS = "is_anonymous"

string	ATTR_KEYBOARD = "keyboard"

string	ATTR_KEYBOARD_INLINE = "inline_keyboard"

string	ATTR_MESSAGE = "message"

string	ATTR_MESSAGE_TAG = "message_tag"

string	ATTR_MESSAGE_THREAD_ID = "message_thread_id"

string	ATTR_MESSAGEID = "message_id"

string	ATTR_MSG = "message"

string	ATTR_MSGID = "id"

string	ATTR_ONE_TIME_KEYBOARD = "one_time_keyboard"

string	ATTR_OPEN_PERIOD = "open_period"

string	ATTR_OPTIONS = "options"

string	ATTR_PARSER = "parse_mode"

string	ATTR_PASSWORD = "password"

string	ATTR_QUESTION = "question"

string	ATTR_REPLY_TO_MSGID = "reply_to_message_id"

string	ATTR_REPLYMARKUP = "reply_markup"

string	ATTR_RESIZE_KEYBOARD = "resize_keyboard"

string	ATTR_SHOW_ALERT = "show_alert"

string	ATTR_STICKER_ID = "sticker_id"

string	ATTR_TARGET = "target"

string	ATTR_TEXT = "text"

string	ATTR_TIMEOUT = "timeout"

string	ATTR_TITLE = "title"

string	ATTR_URL = "url"

string	ATTR_USER_ID = "user_id"

string	ATTR_USERNAME = "username"

string	ATTR_VERIFY_SSL = "verify_ssl"

	BASE_SERVICE_SCHEMA

string	CONF_ALLOWED_CHAT_IDS = "allowed_chat_ids"

string	CONF_PROXY_PARAMS = "proxy_params"

string	CONF_PROXY_URL = "proxy_url"

string	CONF_TRUSTED_NETWORKS = "trusted_networks"

	CONFIG_SCHEMA

list	DEFAULT_TRUSTED_NETWORKS = [ip_network("149.154.160.0/20"), ip_network("91.108.4.0/22")]

string	DOMAIN = "telegram_bot"

string	EVENT_TELEGRAM_CALLBACK = "telegram_callback"

string	EVENT_TELEGRAM_COMMAND = "telegram_command"

string	EVENT_TELEGRAM_SENT = "telegram_sent"

string	EVENT_TELEGRAM_TEXT = "telegram_text"

string	PARSER_HTML = "html"

string	PARSER_MD = "markdown"

string	PARSER_MD2 = "markdownv2"

string	PARSER_PLAIN_TEXT = "plain_text"

string	SERVICE_ANSWER_CALLBACK_QUERY = "answer_callback_query"

string	SERVICE_DELETE_MESSAGE = "delete_message"

string	SERVICE_EDIT_CAPTION = "edit_caption"

string	SERVICE_EDIT_MESSAGE = "edit_message"

string	SERVICE_EDIT_REPLYMARKUP = "edit_replymarkup"

string	SERVICE_LEAVE_CHAT = "leave_chat"

dictionary	SERVICE_MAP

	SERVICE_SCHEMA_ANSWER_CALLBACK_QUERY

	SERVICE_SCHEMA_DELETE_MESSAGE

	SERVICE_SCHEMA_EDIT_CAPTION

	SERVICE_SCHEMA_EDIT_MESSAGE

	SERVICE_SCHEMA_EDIT_REPLYMARKUP

	SERVICE_SCHEMA_LEAVE_CHAT = vol.Schema({vol.Required(ATTR_CHAT_ID): vol.Coerce(int)})

	SERVICE_SCHEMA_SEND_FILE

	SERVICE_SCHEMA_SEND_LOCATION

	SERVICE_SCHEMA_SEND_MESSAGE

	SERVICE_SCHEMA_SEND_POLL

	SERVICE_SCHEMA_SEND_STICKER

string	SERVICE_SEND_ANIMATION = "send_animation"

string	SERVICE_SEND_DOCUMENT = "send_document"

string	SERVICE_SEND_LOCATION = "send_location"

string	SERVICE_SEND_MESSAGE = "send_message"

string	SERVICE_SEND_PHOTO = "send_photo"

string	SERVICE_SEND_POLL = "send_poll"

string	SERVICE_SEND_STICKER = "send_sticker"

string	SERVICE_SEND_VIDEO = "send_video"

string	SERVICE_SEND_VOICE = "send_voice"

Detailed Description

Support to send and receive Telegram messages.

Function Documentation

◆ _read_file_as_bytesio()

io.BytesIO homeassistant.components.telegram_bot._read_file_as_bytesio ( str file_path )

private

Read a file and return it as a BytesIO object.

Definition at line 288 of file __init__.py.

◆ async_setup()

bool homeassistant.components.telegram_bot.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up the Telegram bot component.

Definition at line 368 of file __init__.py.

◆ initialize_bot()

Bot homeassistant.components.telegram_bot.initialize_bot	(	HomeAssistant	hass,
		dict	p_config
	)

Initialize telegram bot with proxy support.

Definition at line 444 of file __init__.py.

◆ load_data()

def homeassistant.components.telegram_bot.load_data	(	hass,
		url = `None`,
		filepath = `None`,
		username = `None`,
		password = `None`,
		authentication = `None`,
		num_retries = `5`,
		verify_ssl = `None`
	)

Load data into ByteIO/File container from a source.

Definition at line 296 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.telegram_bot._LOGGER = logging.getLogger(__name__)

private

Definition at line 45 of file __init__.py.

◆ ATTR_ALLOWS_MULTIPLE_ANSWERS

string homeassistant.components.telegram_bot.ATTR_ALLOWS_MULTIPLE_ANSWERS = "allows_multiple_answers"

Definition at line 92 of file __init__.py.

◆ ATTR_ANSWERS

string homeassistant.components.telegram_bot.ATTR_ANSWERS = "answers"

Definition at line 89 of file __init__.py.

◆ ATTR_ARGS

string homeassistant.components.telegram_bot.ATTR_ARGS = "args"

Definition at line 51 of file __init__.py.

◆ ATTR_AUTHENTICATION

string homeassistant.components.telegram_bot.ATTR_AUTHENTICATION = "authentication"

Definition at line 52 of file __init__.py.

◆ ATTR_CALLBACK_QUERY

string homeassistant.components.telegram_bot.ATTR_CALLBACK_QUERY = "callback_query"

Definition at line 53 of file __init__.py.

◆ ATTR_CALLBACK_QUERY_ID

string homeassistant.components.telegram_bot.ATTR_CALLBACK_QUERY_ID = "callback_query_id"

Definition at line 54 of file __init__.py.

◆ ATTR_CAPTION

string homeassistant.components.telegram_bot.ATTR_CAPTION = "caption"

Definition at line 55 of file __init__.py.

◆ ATTR_CHANNEL_POST

string homeassistant.components.telegram_bot.ATTR_CHANNEL_POST = "channel_post"

Definition at line 86 of file __init__.py.

◆ ATTR_CHAT_ID

string homeassistant.components.telegram_bot.ATTR_CHAT_ID = "chat_id"

Definition at line 56 of file __init__.py.

◆ ATTR_CHAT_INSTANCE

string homeassistant.components.telegram_bot.ATTR_CHAT_INSTANCE = "chat_instance"

Definition at line 57 of file __init__.py.

◆ ATTR_DATA

string homeassistant.components.telegram_bot.ATTR_DATA = "data"

Definition at line 47 of file __init__.py.

◆ ATTR_DATE

string homeassistant.components.telegram_bot.ATTR_DATE = "date"

Definition at line 58 of file __init__.py.

◆ ATTR_DISABLE_NOTIF

string homeassistant.components.telegram_bot.ATTR_DISABLE_NOTIF = "disable_notification"

Definition at line 59 of file __init__.py.

◆ ATTR_DISABLE_WEB_PREV

string homeassistant.components.telegram_bot.ATTR_DISABLE_WEB_PREV = "disable_web_page_preview"

Definition at line 60 of file __init__.py.

◆ ATTR_EDITED_MSG

string homeassistant.components.telegram_bot.ATTR_EDITED_MSG = "edited_message"

Definition at line 61 of file __init__.py.

◆ ATTR_FILE

string homeassistant.components.telegram_bot.ATTR_FILE = "file"

Definition at line 62 of file __init__.py.

◆ ATTR_FROM_FIRST

string homeassistant.components.telegram_bot.ATTR_FROM_FIRST = "from_first"

Definition at line 63 of file __init__.py.

◆ ATTR_FROM_LAST

string homeassistant.components.telegram_bot.ATTR_FROM_LAST = "from_last"

Definition at line 64 of file __init__.py.

◆ ATTR_IS_ANONYMOUS

string homeassistant.components.telegram_bot.ATTR_IS_ANONYMOUS = "is_anonymous"

Definition at line 91 of file __init__.py.

◆ ATTR_KEYBOARD

string homeassistant.components.telegram_bot.ATTR_KEYBOARD = "keyboard"

Definition at line 65 of file __init__.py.

◆ ATTR_KEYBOARD_INLINE

string homeassistant.components.telegram_bot.ATTR_KEYBOARD_INLINE = "inline_keyboard"

Definition at line 68 of file __init__.py.

◆ ATTR_MESSAGE

string homeassistant.components.telegram_bot.ATTR_MESSAGE = "message"

Definition at line 48 of file __init__.py.

◆ ATTR_MESSAGE_TAG

string homeassistant.components.telegram_bot.ATTR_MESSAGE_TAG = "message_tag"

Definition at line 85 of file __init__.py.

◆ ATTR_MESSAGE_THREAD_ID

string homeassistant.components.telegram_bot.ATTR_MESSAGE_THREAD_ID = "message_thread_id"

Definition at line 93 of file __init__.py.

◆ ATTR_MESSAGEID

string homeassistant.components.telegram_bot.ATTR_MESSAGEID = "message_id"

Definition at line 69 of file __init__.py.

◆ ATTR_MSG

string homeassistant.components.telegram_bot.ATTR_MSG = "message"

Definition at line 70 of file __init__.py.

◆ ATTR_MSGID

string homeassistant.components.telegram_bot.ATTR_MSGID = "id"

Definition at line 71 of file __init__.py.

◆ ATTR_ONE_TIME_KEYBOARD

string homeassistant.components.telegram_bot.ATTR_ONE_TIME_KEYBOARD = "one_time_keyboard"

Definition at line 67 of file __init__.py.

◆ ATTR_OPEN_PERIOD

string homeassistant.components.telegram_bot.ATTR_OPEN_PERIOD = "open_period"

Definition at line 90 of file __init__.py.

◆ ATTR_OPTIONS

string homeassistant.components.telegram_bot.ATTR_OPTIONS = "options"

Definition at line 88 of file __init__.py.

◆ ATTR_PARSER

string homeassistant.components.telegram_bot.ATTR_PARSER = "parse_mode"

Definition at line 72 of file __init__.py.

◆ ATTR_PASSWORD

string homeassistant.components.telegram_bot.ATTR_PASSWORD = "password"

Definition at line 73 of file __init__.py.

◆ ATTR_QUESTION

string homeassistant.components.telegram_bot.ATTR_QUESTION = "question"

Definition at line 87 of file __init__.py.

◆ ATTR_REPLY_TO_MSGID

string homeassistant.components.telegram_bot.ATTR_REPLY_TO_MSGID = "reply_to_message_id"

Definition at line 74 of file __init__.py.

◆ ATTR_REPLYMARKUP

string homeassistant.components.telegram_bot.ATTR_REPLYMARKUP = "reply_markup"

Definition at line 75 of file __init__.py.

◆ ATTR_RESIZE_KEYBOARD

string homeassistant.components.telegram_bot.ATTR_RESIZE_KEYBOARD = "resize_keyboard"

Definition at line 66 of file __init__.py.

◆ ATTR_SHOW_ALERT

string homeassistant.components.telegram_bot.ATTR_SHOW_ALERT = "show_alert"

Definition at line 76 of file __init__.py.

◆ ATTR_STICKER_ID

string homeassistant.components.telegram_bot.ATTR_STICKER_ID = "sticker_id"

Definition at line 77 of file __init__.py.

◆ ATTR_TARGET

string homeassistant.components.telegram_bot.ATTR_TARGET = "target"

Definition at line 78 of file __init__.py.

◆ ATTR_TEXT

string homeassistant.components.telegram_bot.ATTR_TEXT = "text"

Definition at line 79 of file __init__.py.

◆ ATTR_TIMEOUT

string homeassistant.components.telegram_bot.ATTR_TIMEOUT = "timeout"

Definition at line 84 of file __init__.py.

◆ ATTR_TITLE

string homeassistant.components.telegram_bot.ATTR_TITLE = "title"

Definition at line 49 of file __init__.py.

◆ ATTR_URL

string homeassistant.components.telegram_bot.ATTR_URL = "url"

Definition at line 80 of file __init__.py.

◆ ATTR_USER_ID

string homeassistant.components.telegram_bot.ATTR_USER_ID = "user_id"

Definition at line 81 of file __init__.py.

◆ ATTR_USERNAME

string homeassistant.components.telegram_bot.ATTR_USERNAME = "username"

Definition at line 82 of file __init__.py.

◆ ATTR_VERIFY_SSL

string homeassistant.components.telegram_bot.ATTR_VERIFY_SSL = "verify_ssl"

Definition at line 83 of file __init__.py.

◆ BASE_SERVICE_SCHEMA

homeassistant.components.telegram_bot.BASE_SERVICE_SCHEMA

Initial value:

 =  vol.Schema(
     {
         vol.Optional(ATTR_TARGET): vol.All(cv.ensure_list, [vol.Coerce(int)]),
         vol.Optional(ATTR_PARSER): cv.string,
         vol.Optional(ATTR_DISABLE_NOTIF): cv.boolean,
         vol.Optional(ATTR_DISABLE_WEB_PREV): cv.boolean,
         vol.Optional(ATTR_RESIZE_KEYBOARD): cv.boolean,
         vol.Optional(ATTR_ONE_TIME_KEYBOARD): cv.boolean,
         vol.Optional(ATTR_KEYBOARD): vol.All(cv.ensure_list, [cv.string]),
         vol.Optional(ATTR_KEYBOARD_INLINE): cv.ensure_list,
         vol.Optional(ATTR_TIMEOUT): cv.positive_int,
         vol.Optional(ATTR_MESSAGE_TAG): cv.string,
     },
     extra=vol.ALLOW_EXTRA,
 )

Definition at line 160 of file __init__.py.

◆ CONF_ALLOWED_CHAT_IDS

string homeassistant.components.telegram_bot.CONF_ALLOWED_CHAT_IDS = "allowed_chat_ids"

Definition at line 95 of file __init__.py.

◆ CONF_PROXY_PARAMS

string homeassistant.components.telegram_bot.CONF_PROXY_PARAMS = "proxy_params"

Definition at line 97 of file __init__.py.

◆ CONF_PROXY_URL

string homeassistant.components.telegram_bot.CONF_PROXY_URL = "proxy_url"

Definition at line 96 of file __init__.py.

◆ CONF_TRUSTED_NETWORKS

string homeassistant.components.telegram_bot.CONF_TRUSTED_NETWORKS = "trusted_networks"

Definition at line 98 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.telegram_bot.CONFIG_SCHEMA

Initial value:

 =  vol.Schema(
     {
         DOMAIN: vol.All(
             cv.ensure_list,
             [
                 vol.Schema(
                     {
                         vol.Required(CONF_PLATFORM): vol.In(
                             ("broadcast", "polling", "webhooks")
                         ),
                         vol.Required(CONF_API_KEY): cv.string,
                         vol.Required(CONF_ALLOWED_CHAT_IDS): vol.All(
                             cv.ensure_list, [vol.Coerce(int)]
                         ),
                         vol.Optional(ATTR_PARSER, default=PARSER_MD): cv.string,
                         vol.Optional(CONF_PROXY_URL): cv.string,
                         vol.Optional(CONF_PROXY_PARAMS): dict,
                         # webhooks
                         vol.Optional(CONF_URL): cv.url,
                         vol.Optional(
                             CONF_TRUSTED_NETWORKS, default=DEFAULT_TRUSTED_NETWORKS
                         ): vol.All(cv.ensure_list, [ip_network]),
                     }
                 )
             ],
         )
     },
     extra=vol.ALLOW_EXTRA,
 )

Definition at line 130 of file __init__.py.

◆ DEFAULT_TRUSTED_NETWORKS

list homeassistant.components.telegram_bot.DEFAULT_TRUSTED_NETWORKS = [ip_network("149.154.160.0/20"), ip_network("91.108.4.0/22")]

Definition at line 128 of file __init__.py.

◆ DOMAIN

string homeassistant.components.telegram_bot.DOMAIN = "telegram_bot"

Definition at line 100 of file __init__.py.

◆ EVENT_TELEGRAM_CALLBACK

string homeassistant.components.telegram_bot.EVENT_TELEGRAM_CALLBACK = "telegram_callback"

Definition at line 118 of file __init__.py.

◆ EVENT_TELEGRAM_COMMAND

string homeassistant.components.telegram_bot.EVENT_TELEGRAM_COMMAND = "telegram_command"

Definition at line 119 of file __init__.py.

◆ EVENT_TELEGRAM_SENT

string homeassistant.components.telegram_bot.EVENT_TELEGRAM_SENT = "telegram_sent"

Definition at line 121 of file __init__.py.

◆ EVENT_TELEGRAM_TEXT

string homeassistant.components.telegram_bot.EVENT_TELEGRAM_TEXT = "telegram_text"

Definition at line 120 of file __init__.py.

◆ PARSER_HTML

string homeassistant.components.telegram_bot.PARSER_HTML = "html"

Definition at line 123 of file __init__.py.

◆ PARSER_MD

string homeassistant.components.telegram_bot.PARSER_MD = "markdown"

Definition at line 124 of file __init__.py.

◆ PARSER_MD2

string homeassistant.components.telegram_bot.PARSER_MD2 = "markdownv2"

Definition at line 125 of file __init__.py.

◆ PARSER_PLAIN_TEXT

string homeassistant.components.telegram_bot.PARSER_PLAIN_TEXT = "plain_text"

Definition at line 126 of file __init__.py.

◆ SERVICE_ANSWER_CALLBACK_QUERY

string homeassistant.components.telegram_bot.SERVICE_ANSWER_CALLBACK_QUERY = "answer_callback_query"

Definition at line 114 of file __init__.py.

◆ SERVICE_DELETE_MESSAGE

string homeassistant.components.telegram_bot.SERVICE_DELETE_MESSAGE = "delete_message"

Definition at line 115 of file __init__.py.

◆ SERVICE_EDIT_CAPTION

string homeassistant.components.telegram_bot.SERVICE_EDIT_CAPTION = "edit_caption"

Definition at line 112 of file __init__.py.

◆ SERVICE_EDIT_MESSAGE

string homeassistant.components.telegram_bot.SERVICE_EDIT_MESSAGE = "edit_message"

Definition at line 111 of file __init__.py.

◆ SERVICE_EDIT_REPLYMARKUP

string homeassistant.components.telegram_bot.SERVICE_EDIT_REPLYMARKUP = "edit_replymarkup"

Definition at line 113 of file __init__.py.

◆ SERVICE_LEAVE_CHAT

string homeassistant.components.telegram_bot.SERVICE_LEAVE_CHAT = "leave_chat"

Definition at line 116 of file __init__.py.

◆ SERVICE_MAP

dictionary homeassistant.components.telegram_bot.SERVICE_MAP

Initial value:

 =  {
     SERVICE_SEND_MESSAGE: SERVICE_SCHEMA_SEND_MESSAGE,
     SERVICE_SEND_PHOTO: SERVICE_SCHEMA_SEND_FILE,
     SERVICE_SEND_STICKER: SERVICE_SCHEMA_SEND_STICKER,
     SERVICE_SEND_ANIMATION: SERVICE_SCHEMA_SEND_FILE,
     SERVICE_SEND_VIDEO: SERVICE_SCHEMA_SEND_FILE,
     SERVICE_SEND_VOICE: SERVICE_SCHEMA_SEND_FILE,
     SERVICE_SEND_DOCUMENT: SERVICE_SCHEMA_SEND_FILE,
     SERVICE_SEND_LOCATION: SERVICE_SCHEMA_SEND_LOCATION,
     SERVICE_SEND_POLL: SERVICE_SCHEMA_SEND_POLL,
     SERVICE_EDIT_MESSAGE: SERVICE_SCHEMA_EDIT_MESSAGE,
     SERVICE_EDIT_CAPTION: SERVICE_SCHEMA_EDIT_CAPTION,
     SERVICE_EDIT_REPLYMARKUP: SERVICE_SCHEMA_EDIT_REPLYMARKUP,
     SERVICE_ANSWER_CALLBACK_QUERY: SERVICE_SCHEMA_ANSWER_CALLBACK_QUERY,
     SERVICE_DELETE_MESSAGE: SERVICE_SCHEMA_DELETE_MESSAGE,
     SERVICE_LEAVE_CHAT: SERVICE_SCHEMA_LEAVE_CHAT,
 }

Definition at line 269 of file __init__.py.

◆ SERVICE_SCHEMA_ANSWER_CALLBACK_QUERY

homeassistant.components.telegram_bot.SERVICE_SCHEMA_ANSWER_CALLBACK_QUERY

Initial value:

 =  vol.Schema(
     {
         vol.Required(ATTR_MESSAGE): cv.string,
         vol.Required(ATTR_CALLBACK_QUERY_ID): vol.Coerce(int),
         vol.Optional(ATTR_SHOW_ALERT): cv.boolean,
     },
     extra=vol.ALLOW_EXTRA,
 )

Definition at line 248 of file __init__.py.

◆ SERVICE_SCHEMA_DELETE_MESSAGE

homeassistant.components.telegram_bot.SERVICE_SCHEMA_DELETE_MESSAGE

Initial value:

 =  vol.Schema(
     {
         vol.Required(ATTR_CHAT_ID): vol.Coerce(int),
         vol.Required(ATTR_MESSAGEID): vol.Any(
             cv.positive_int, vol.All(cv.string, "last")
         ),
     },
     extra=vol.ALLOW_EXTRA,
 )

Definition at line 257 of file __init__.py.

◆ SERVICE_SCHEMA_EDIT_CAPTION

homeassistant.components.telegram_bot.SERVICE_SCHEMA_EDIT_CAPTION

Initial value:

 =  vol.Schema(
     {
         vol.Required(ATTR_MESSAGEID): vol.Any(
             cv.positive_int, vol.All(cv.string, "last")
         ),
         vol.Required(ATTR_CHAT_ID): vol.Coerce(int),
         vol.Required(ATTR_CAPTION): cv.string,
         vol.Optional(ATTR_KEYBOARD_INLINE): cv.ensure_list,
     },
     extra=vol.ALLOW_EXTRA,
 )

Definition at line 225 of file __init__.py.

◆ SERVICE_SCHEMA_EDIT_MESSAGE

homeassistant.components.telegram_bot.SERVICE_SCHEMA_EDIT_MESSAGE

Initial value:

 =  SERVICE_SCHEMA_SEND_MESSAGE.extend(
     {
         vol.Required(ATTR_MESSAGEID): vol.Any(
             cv.positive_int, vol.All(cv.string, "last")
         ),
         vol.Required(ATTR_CHAT_ID): vol.Coerce(int),
     }
 )

Definition at line 216 of file __init__.py.

◆ SERVICE_SCHEMA_EDIT_REPLYMARKUP

homeassistant.components.telegram_bot.SERVICE_SCHEMA_EDIT_REPLYMARKUP

Initial value:

 =  vol.Schema(
     {
         vol.Required(ATTR_MESSAGEID): vol.Any(
             cv.positive_int, vol.All(cv.string, "last")
         ),
         vol.Required(ATTR_CHAT_ID): vol.Coerce(int),
         vol.Required(ATTR_KEYBOARD_INLINE): cv.ensure_list,
     },
     extra=vol.ALLOW_EXTRA,
 )

Definition at line 237 of file __init__.py.

◆ SERVICE_SCHEMA_LEAVE_CHAT

homeassistant.components.telegram_bot.SERVICE_SCHEMA_LEAVE_CHAT = vol.Schema({vol.Required(ATTR_CHAT_ID): vol.Coerce(int)})

Definition at line 267 of file __init__.py.

◆ SERVICE_SCHEMA_SEND_FILE

homeassistant.components.telegram_bot.SERVICE_SCHEMA_SEND_FILE

Initial value:

 =  BASE_SERVICE_SCHEMA.extend(
     {
         vol.Optional(ATTR_URL): cv.string,
         vol.Optional(ATTR_FILE): cv.string,
         vol.Optional(ATTR_CAPTION): cv.string,
         vol.Optional(ATTR_USERNAME): cv.string,
         vol.Optional(ATTR_PASSWORD): cv.string,
         vol.Optional(ATTR_AUTHENTICATION): cv.string,
         vol.Optional(ATTR_VERIFY_SSL): cv.boolean,
     }
 )

Definition at line 180 of file __init__.py.

◆ SERVICE_SCHEMA_SEND_LOCATION

homeassistant.components.telegram_bot.SERVICE_SCHEMA_SEND_LOCATION

Initial value:

 =  BASE_SERVICE_SCHEMA.extend(
     {
         vol.Required(ATTR_LONGITUDE): cv.string,
         vol.Required(ATTR_LATITUDE): cv.string,
     }
 )

Definition at line 196 of file __init__.py.

◆ SERVICE_SCHEMA_SEND_MESSAGE

homeassistant.components.telegram_bot.SERVICE_SCHEMA_SEND_MESSAGE

Initial value:

 =  BASE_SERVICE_SCHEMA.extend(
     {vol.Required(ATTR_MESSAGE): cv.string, vol.Optional(ATTR_TITLE): cv.string}
 )

Definition at line 176 of file __init__.py.

◆ SERVICE_SCHEMA_SEND_POLL

homeassistant.components.telegram_bot.SERVICE_SCHEMA_SEND_POLL

Initial value:

 =  vol.Schema(
     {
         vol.Optional(ATTR_TARGET): vol.All(cv.ensure_list, [vol.Coerce(int)]),
         vol.Required(ATTR_QUESTION): cv.string,
         vol.Required(ATTR_OPTIONS): vol.All(cv.ensure_list, [cv.string]),
         vol.Optional(ATTR_OPEN_PERIOD): cv.positive_int,
         vol.Optional(ATTR_IS_ANONYMOUS, default=True): cv.boolean,
         vol.Optional(ATTR_ALLOWS_MULTIPLE_ANSWERS, default=False): cv.boolean,
         vol.Optional(ATTR_DISABLE_NOTIF): cv.boolean,
         vol.Optional(ATTR_TIMEOUT): cv.positive_int,
     }
 )

Definition at line 203 of file __init__.py.

◆ SERVICE_SCHEMA_SEND_STICKER

homeassistant.components.telegram_bot.SERVICE_SCHEMA_SEND_STICKER

Initial value:

 =  SERVICE_SCHEMA_SEND_FILE.extend(
     {vol.Optional(ATTR_STICKER_ID): cv.string}
 )

Definition at line 192 of file __init__.py.

◆ SERVICE_SEND_ANIMATION

string homeassistant.components.telegram_bot.SERVICE_SEND_ANIMATION = "send_animation"

Definition at line 105 of file __init__.py.

◆ SERVICE_SEND_DOCUMENT

string homeassistant.components.telegram_bot.SERVICE_SEND_DOCUMENT = "send_document"

Definition at line 108 of file __init__.py.

◆ SERVICE_SEND_LOCATION

string homeassistant.components.telegram_bot.SERVICE_SEND_LOCATION = "send_location"

Definition at line 109 of file __init__.py.

◆ SERVICE_SEND_MESSAGE

string homeassistant.components.telegram_bot.SERVICE_SEND_MESSAGE = "send_message"

Definition at line 102 of file __init__.py.

◆ SERVICE_SEND_PHOTO

string homeassistant.components.telegram_bot.SERVICE_SEND_PHOTO = "send_photo"

Definition at line 103 of file __init__.py.

◆ SERVICE_SEND_POLL

string homeassistant.components.telegram_bot.SERVICE_SEND_POLL = "send_poll"

Definition at line 110 of file __init__.py.

◆ SERVICE_SEND_STICKER

string homeassistant.components.telegram_bot.SERVICE_SEND_STICKER = "send_sticker"

Definition at line 104 of file __init__.py.

◆ SERVICE_SEND_VIDEO

string homeassistant.components.telegram_bot.SERVICE_SEND_VIDEO = "send_video"

Definition at line 106 of file __init__.py.

◆ SERVICE_SEND_VOICE

string homeassistant.components.telegram_bot.SERVICE_SEND_VOICE = "send_voice"

Definition at line 107 of file __init__.py.

Home Assistant Unofficial Reference 2024.12.1

Namespaces

Classes

Functions

Variables

Detailed Description

Function Documentation

◆ _read_file_as_bytesio()

◆ async_setup()

◆ initialize_bot()

◆ load_data()

Variable Documentation

◆ _LOGGER

◆ ATTR_ALLOWS_MULTIPLE_ANSWERS

◆ ATTR_ANSWERS

◆ ATTR_ARGS

◆ ATTR_AUTHENTICATION

◆ ATTR_CALLBACK_QUERY

◆ ATTR_CALLBACK_QUERY_ID

◆ ATTR_CAPTION

◆ ATTR_CHANNEL_POST

◆ ATTR_CHAT_ID

◆ ATTR_CHAT_INSTANCE

◆ ATTR_DATA

◆ ATTR_DATE

◆ ATTR_DISABLE_NOTIF

◆ ATTR_DISABLE_WEB_PREV

◆ ATTR_EDITED_MSG

◆ ATTR_FILE

◆ ATTR_FROM_FIRST

◆ ATTR_FROM_LAST

◆ ATTR_IS_ANONYMOUS

◆ ATTR_KEYBOARD

◆ ATTR_KEYBOARD_INLINE

◆ ATTR_MESSAGE

◆ ATTR_MESSAGE_TAG

◆ ATTR_MESSAGE_THREAD_ID

◆ ATTR_MESSAGEID

◆ ATTR_MSG

◆ ATTR_MSGID

◆ ATTR_ONE_TIME_KEYBOARD

◆ ATTR_OPEN_PERIOD

◆ ATTR_OPTIONS

◆ ATTR_PARSER

◆ ATTR_PASSWORD

◆ ATTR_QUESTION

◆ ATTR_REPLY_TO_MSGID

◆ ATTR_REPLYMARKUP

◆ ATTR_RESIZE_KEYBOARD

◆ ATTR_SHOW_ALERT

◆ ATTR_STICKER_ID

◆ ATTR_TARGET

◆ ATTR_TEXT

◆ ATTR_TIMEOUT

◆ ATTR_TITLE

◆ ATTR_URL

◆ ATTR_USER_ID

◆ ATTR_USERNAME

◆ ATTR_VERIFY_SSL

◆ BASE_SERVICE_SCHEMA

◆ CONF_ALLOWED_CHAT_IDS

◆ CONF_PROXY_PARAMS

◆ CONF_PROXY_URL

◆ CONF_TRUSTED_NETWORKS

◆ CONFIG_SCHEMA

◆ DEFAULT_TRUSTED_NETWORKS

◆ DOMAIN

◆ EVENT_TELEGRAM_CALLBACK

◆ EVENT_TELEGRAM_COMMAND

◆ EVENT_TELEGRAM_SENT

◆ EVENT_TELEGRAM_TEXT

◆ PARSER_HTML

◆ PARSER_MD

◆ PARSER_MD2

◆ PARSER_PLAIN_TEXT

◆ SERVICE_ANSWER_CALLBACK_QUERY

◆ SERVICE_DELETE_MESSAGE

◆ SERVICE_EDIT_CAPTION

◆ SERVICE_EDIT_MESSAGE

◆ SERVICE_EDIT_REPLYMARKUP

◆ SERVICE_LEAVE_CHAT