action telegram_post_stop_poll { label: "post_stopPoll" description: "Use this method to stop a poll which was sent by the bot. On success, the stopped [Poll](https://core.telegram.org/bots/api/#poll) with the final results is returned." provider: telegram method: POST path: "/stopPoll" encoding: form input: { type: "object" required: ["chat_id", "message_id"] properties: { chat_id: { description: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)" type: "object" } message_id: { type: "integer" description: "Identifier of the original message with the poll" } reply_markup: { type: "object" description: "This object represents an [inline keyboard](https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating) that appears right next to the message it belongs to." required: ["inline_keyboard"] properties: { inline_keyboard: { type: "array" description: "Array of button rows, each represented by an Array of [InlineKeyboardButton](https://core.telegram.org/bots/api/#inlinekeyboardbutton) objects" items: { type: "array" items: { type: "object" description: "This object represents one button of an inline keyboard. You **must** use exactly one of the optional fields." required: ["text"] properties: { callback_data: { type: "string" description: "*Optional*. Data to be sent in a [callback query](https://core.telegram.org/bots/api/#callbackquery) to the bot when button is pressed, 1-64 bytes" } callback_game: { description: "A placeholder, currently holds no information. Use [BotFather](https://t.me/botfather) to set up your game." type: "object" } login_url: { type: "object" description: "This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the [Telegram Login Widget](https://core.telegram.org/widgets/login) when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in:\n\nTelegram apps support these buttons as of [version 5.7](https://telegram.org/blog/privacy-discussions-web-bots#meet-seamless-web-bots).\n\nSample bot: [@discussbot](https://t.me/discussbot)" required: ["url"] properties: { bot_username: { type: "string" description: "*Optional*. Username of a bot, which will be used for user authorization. See [Setting up a bot](https://core.telegram.org/widgets/login#setting-up-a-bot) for more details. If not specified, the current bot's username will be assumed. The *url*'s domain must be the same as the domain linked with the bot. See [Linking your domain to the bot](https://core.telegram.org/widgets/login#linking-your-domain-to-the-bot) for more details." } forward_text: { type: "string" description: "*Optional*. New text of the button in forwarded messages." } request_write_access: { type: "boolean" description: "*Optional*. Pass True to request the permission for your bot to send messages to the user." } url: { type: "string" description: "An HTTP URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in [Receiving authorization data](https://core.telegram.org/widgets/login#receiving-authorization-data). \n\n**NOTE:** You **must** always check the hash of the received data to verify the authentication and the integrity of the data as described in [Checking authorization](https://core.telegram.org/widgets/login#checking-authorization)." } } } pay: { type: "boolean" description: "*Optional*. Specify True, to send a [Pay button](https://core.telegram.org/bots/api/#payments). \n\n**NOTE:** This type of button **must** always be the first button in the first row." } switch_inline_query: { type: "string" description: "*Optional*. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. Can be empty, in which case just the bot's username will be inserted. \n\n**Note:** This offers an easy way for users to start using your bot in [inline mode](/bots/inline) when they are currently in a private chat with it. Especially useful when combined with [*switch\\_pm…*](https://core.telegram.org/bots/api/#answerinlinequery) actions – in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen." } switch_inline_query_current_chat: { type: "string" description: "*Optional*. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. Can be empty, in which case only the bot's username will be inserted. \n\nThis offers a quick way for the user to open your bot in inline mode in the same chat – good for selecting something from multiple options." } text: { type: "string" description: "Label text on the button" } url: { type: "string" description: "*Optional*. HTTP or tg:// url to be opened when button is pressed" } } } } } } } } } output: { type: "object" required: ["ok", "result"] properties: { ok: { type: "boolean" } result: { type: "object" description: "This object contains information about a poll." required: ["allows_multiple_answers", "id", "is_anonymous", "is_closed", "options", "question", "total_voter_count", "type"] properties: { allows_multiple_answers: { type: "boolean" description: "True, if the poll allows multiple answers" } close_date: { type: "integer" description: "*Optional*. Point in time (Unix timestamp) when the poll will be automatically closed" } correct_option_id: { type: "integer" description: "*Optional*. 0-based identifier of the correct answer option. Available only for polls in the quiz mode, which are closed, or was sent (not forwarded) by the bot or to the private chat with the bot." } explanation: { type: "string" description: "*Optional*. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters" } explanation_entities: { type: "array" description: "*Optional*. Special entities like usernames, URLs, bot commands, etc. that appear in the *explanation*" items: { type: "object" description: "This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc." required: ["type", "offset", "length"] properties: { language: { type: "string" description: "*Optional*. For “pre” only, the programming language of the entity text" } length: { type: "integer" description: "Length of the entity in UTF-16 code units" } offset: { type: "integer" description: "Offset in UTF-16 code units to the start of the entity" } type: { type: "string" description: "Type of the entity. Can be “mention” (`@username`), “hashtag” (`#hashtag`), “cashtag” (`$USD`), “bot\\_command” (`/start@jobs_bot`), “url” (`https://telegram.org`), “email” (`do-not-reply@telegram.org`), “phone\\_number” (`+1-212-555-0123`), “bold” (**bold text**), “italic” (*italic text*), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text\\_link” (for clickable text URLs), “text\\_mention” (for users [without usernames](https://telegram.org/blog/edit#new-mentions))" enum: ["mention", "hashtag", "cashtag", "bot_command", "url", "email", "phone_number", "bold", "italic", "underline", "strikethrough", "code", "pre", "text_link", "text_mention"] } url: { type: "string" description: "*Optional*. For “text\\_link” only, url that will be opened after user taps on the text" } user: { type: "object" description: "This object represents a Telegram user or bot." required: ["id", "is_bot", "first_name"] properties: { can_join_groups: { type: "boolean" description: "*Optional*. True, if the bot can be invited to groups. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)." } can_read_all_group_messages: { type: "boolean" description: "*Optional*. True, if [privacy mode](https://core.telegram.org/bots#privacy-mode) is disabled for the bot. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)." } first_name: { type: "string" description: "User's or bot's first name" } id: { type: "integer" description: "Unique identifier for this user or bot" } is_bot: { type: "boolean" description: "True, if this user is a bot" } language_code: { type: "string" description: "*Optional*. [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the user's language" } last_name: { type: "string" description: "*Optional*. User's or bot's last name" } supports_inline_queries: { type: "boolean" description: "*Optional*. True, if the bot supports inline queries. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)." } username: { type: "string" description: "*Optional*. User's or bot's username" } } } } } } id: { type: "string" description: "Unique poll identifier" } is_anonymous: { type: "boolean" description: "True, if the poll is anonymous" } is_closed: { type: "boolean" description: "True, if the poll is closed" } open_period: { type: "integer" description: "*Optional*. Amount of time in seconds the poll will be active after creation" } options: { type: "array" description: "List of poll options" items: { type: "object" description: "This object contains information about one answer option in a poll." required: ["text", "voter_count"] properties: { text: { type: "string" description: "Option text, 1-100 characters" } voter_count: { type: "integer" description: "Number of users that voted for this option" } } } } question: { type: "string" description: "Poll question, 1-255 characters" } total_voter_count: { type: "integer" description: "Total number of users that voted in the poll" } type: { type: "string" description: "Poll type, currently can be “regular” or “quiz”" } } } } } }