GramIO API Reference / gramio/dist / SendLocationParams
Interface: SendLocationParams
Defined in: @gramio/types/out/params.d.ts:1112
Params object for sendLocation method
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
allow_paid_broadcast? | boolean | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | @gramio/types/out/params.d.ts:1164 |
business_connection_id? | string | Unique identifier of the business connection on behalf of which the message will be sent | @gramio/types/out/params.d.ts:1116 |
chat_id | string | number | Unique identifier for the target chat or username of the target channel (in the format @channelusername) | @gramio/types/out/params.d.ts:1120 |
direct_messages_topic_id? | number | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | @gramio/types/out/params.d.ts:1128 |
disable_notification? | boolean | Sends the message silently. Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:1156 |
heading? | number | For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. | @gramio/types/out/params.d.ts:1148 |
horizontal_accuracy? | number | The radius of uncertainty for the location, measured in meters; 0-1500 | @gramio/types/out/params.d.ts:1140 |
latitude | number | Latitude of the location | @gramio/types/out/params.d.ts:1132 |
live_period? | number | 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. | @gramio/types/out/params.d.ts:1144 |
longitude | number | Longitude of the location | @gramio/types/out/params.d.ts:1136 |
message_effect_id? | string | Unique identifier of the message effect to be added to the message; for private chats only | @gramio/types/out/params.d.ts:1168 |
message_thread_id? | number | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:1124 |
protect_content? | boolean | Protects the contents of the sent message from forwarding and saving | @gramio/types/out/params.d.ts:1160 |
proximity_alert_radius? | number | For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. | @gramio/types/out/params.d.ts:1152 |
reply_markup? | TelegramInlineKeyboardMarkup | TelegramReplyKeyboardMarkup | TelegramReplyKeyboardRemove | TelegramForceReply | { toJSON: TelegramInlineKeyboardMarkup; } | { toJSON: TelegramReplyKeyboardMarkup; } | { toJSON: TelegramReplyKeyboardRemove; } | { toJSON: TelegramForceReply; } | 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 | @gramio/types/out/params.d.ts:1180 |
reply_parameters? | TelegramReplyParameters | Description of the message to reply to | @gramio/types/out/params.d.ts:1176 |
suggested_post_parameters? | TelegramSuggestedPostParameters | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | @gramio/types/out/params.d.ts:1172 |