stopMessageLiveLocation

Description

Use this method to stop updating a live location message before live_period expires. On success, if the message was sent by the bot, the sent Message is returned, otherwise True is returned.

Arguments

Name Type Description
chat_id Optional[Union[int, str]] Optional. Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
message_id Optional[int] Optional. Required if inline_message_id is not specified. Identifier of the message with live location to stop
inline_message_id Optional[str] Optional. Required if chat_id and message_id are not specified. Identifier of the inline message
reply_markup Optional[InlineKeyboardMarkup] Optional. A JSON-serialized object for a new inline keyboard.

Response

Type: Union[Message, bool]

Description: On success, if the message was sent by the bot, the sent Message is returned, otherwise True is returned.

Usage

As bot method

result: Union[Message, bool] = await bot.stop_message_live_location(...)

Method as object

Imports:

  • from aiogram.methods import StopMessageLiveLocation
  • from aiogram.api.methods import StopMessageLiveLocation
  • from aiogram.api.methods.stop_message_live_location import StopMessageLiveLocation

In handlers with current bot

result: Union[Message, bool] = await StopMessageLiveLocation(...)

With specific bot

result: Union[Message, bool] = await bot(StopMessageLiveLocation(...))

As reply into Webhook in handler

return StopMessageLiveLocation(...)