peyk.platforms.telegram.methods.stop_message_live_location

async peyk.platforms.telegram.methods.stop_message_live_location(self, *, chat_id: int | str | None = None, message_id: int | None = None, inline_message_id: str | None = None, reply_markup: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Mapping[str, object] | None = None) → Message | bool[source]

Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.

Parameters:

  • chat_id – Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.

  • message_id – Required if inline_message_id is not specified. Identifier of the message with live location to stop.

  • inline_message_id – Required if chat_id and message_id are not specified. Identifier of the inline message.

  • reply_markup – A JSON-serialized object for a new inline keyboard

Returns:

Result returned by Telegram on successful execution.

Return type:

Union[Message, bool]