mirror of
https://github.com/aiogram/aiogram.git
synced 2025-12-13 18:43:53 +00:00
cf2980a9c1
* Added full support of Bot API * Added full support of Bot API * Fixed tests * Added changelog * Bump version
145 lines
8.3 KiB
JSON
145 lines
8.3 KiB
JSON
{
|
|
"meta": {},
|
|
"group": {
|
|
"title": "Available methods",
|
|
"anchor": "available-methods"
|
|
},
|
|
"object": {
|
|
"anchor": "sendlocation",
|
|
"name": "sendLocation",
|
|
"description": "Use this method to send point on the map. On success, the sent Message is returned.",
|
|
"html_description": "<p>Use this method to send point on the map. On success, the sent <a href=\"#message\">Message</a> is returned.</p>",
|
|
"rst_description": "Use this method to send point on the map. On success, the sent :class:`aiogram.types.message.Message` is returned.",
|
|
"annotations": [
|
|
{
|
|
"type": "String",
|
|
"required": false,
|
|
"description": "Unique identifier of the business connection on behalf of which the message will be sent",
|
|
"html_description": "<td>Unique identifier of the business connection on behalf of which the message will be sent</td>",
|
|
"rst_description": "Unique identifier of the business connection on behalf of which the message will be sent\n",
|
|
"name": "business_connection_id"
|
|
},
|
|
{
|
|
"type": "Integer or String",
|
|
"required": true,
|
|
"description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
|
|
"html_description": "<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
|
|
"rst_description": "Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
|
|
"name": "chat_id"
|
|
},
|
|
{
|
|
"type": "Integer",
|
|
"required": false,
|
|
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
|
"html_description": "<td>Unique identifier for the target message thread (topic) of the forum; for forum supergroups only</td>",
|
|
"rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
|
|
"name": "message_thread_id"
|
|
},
|
|
{
|
|
"type": "Float",
|
|
"required": true,
|
|
"description": "Latitude of the location",
|
|
"html_description": "<td>Latitude of the location</td>",
|
|
"rst_description": "Latitude of the location\n",
|
|
"name": "latitude"
|
|
},
|
|
{
|
|
"type": "Float",
|
|
"required": true,
|
|
"description": "Longitude of the location",
|
|
"html_description": "<td>Longitude of the location</td>",
|
|
"rst_description": "Longitude of the location\n",
|
|
"name": "longitude"
|
|
},
|
|
{
|
|
"type": "Float",
|
|
"required": false,
|
|
"description": "The radius of uncertainty for the location, measured in meters; 0-1500",
|
|
"html_description": "<td>The radius of uncertainty for the location, measured in meters; 0-1500</td>",
|
|
"rst_description": "The radius of uncertainty for the location, measured in meters; 0-1500\n",
|
|
"name": "horizontal_accuracy"
|
|
},
|
|
{
|
|
"type": "Integer",
|
|
"required": false,
|
|
"description": "Period in seconds during which the location will be updated (see Live Locations, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.",
|
|
"html_description": "<td>Period in seconds during which the location will be updated (see <a href=\"https://telegram.org/blog/live-locations\">Live Locations</a>, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.</td>",
|
|
"rst_description": "Period in seconds during which the location will be updated (see `Live Locations <https://telegram.org/blog/live-locations>`_, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.\n",
|
|
"name": "live_period"
|
|
},
|
|
{
|
|
"type": "Integer",
|
|
"required": false,
|
|
"description": "For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.",
|
|
"html_description": "<td>For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.</td>",
|
|
"rst_description": "For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.\n",
|
|
"name": "heading"
|
|
},
|
|
{
|
|
"type": "Integer",
|
|
"required": false,
|
|
"description": "For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.",
|
|
"html_description": "<td>For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.</td>",
|
|
"rst_description": "For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.\n",
|
|
"name": "proximity_alert_radius"
|
|
},
|
|
{
|
|
"type": "Boolean",
|
|
"required": false,
|
|
"description": "Sends the message silently. Users will receive a notification with no sound.",
|
|
"html_description": "<td>Sends the message <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
|
|
"rst_description": "Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
|
|
"name": "disable_notification"
|
|
},
|
|
{
|
|
"type": "Boolean",
|
|
"required": false,
|
|
"description": "Protects the contents of the sent message from forwarding and saving",
|
|
"html_description": "<td>Protects the contents of the sent message from forwarding and saving</td>",
|
|
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
|
|
"name": "protect_content"
|
|
},
|
|
{
|
|
"type": "ReplyParameters",
|
|
"required": false,
|
|
"description": "Description of the message to reply to",
|
|
"html_description": "<td>Description of the message to reply to</td>",
|
|
"rst_description": "Description of the message to reply to\n",
|
|
"name": "reply_parameters"
|
|
},
|
|
{
|
|
"type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
|
|
"required": false,
|
|
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
|
|
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
|
|
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
|
|
"name": "reply_markup"
|
|
},
|
|
{
|
|
"type": "Boolean",
|
|
"required": false,
|
|
"description": "Pass True if the message should be sent even if the specified replied-to message is not found",
|
|
"html_description": "<td>Pass <em>True</em> if the message should be sent even if the specified replied-to message is not found</td>",
|
|
"rst_description": "Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n",
|
|
"name": "allow_sending_without_reply",
|
|
"deprecated": {
|
|
"version": "7.0",
|
|
"release_date": "2023-12-29"
|
|
}
|
|
},
|
|
{
|
|
"type": "Integer",
|
|
"required": false,
|
|
"description": "If the message is a reply, ID of the original message",
|
|
"html_description": "<td>If the message is a reply, ID of the original message</td>",
|
|
"rst_description": "If the message is a reply, ID of the original message\n",
|
|
"name": "reply_to_message_id",
|
|
"deprecated": {
|
|
"version": "7.0",
|
|
"release_date": "2023-12-29"
|
|
}
|
|
}
|
|
],
|
|
"category": "methods"
|
|
}
|
|
}
|