SendLocationParams

interface

Declaration

interface SendLocationParams

Properties

allow_paid_broadcastproperty#

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.

business_connection_idproperty#

business_connection_id?: string;

Unique identifier of the business connection on behalf of which the message will be sent

chat_idproperty#

chat_id: number | string;

Unique identifier for the target chat or username of the target bot, supergroup or channel in the format

direct_messages_topic_idproperty#

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

disable_notificationproperty#

disable_notification?: boolean;

Sends the message silently. Users will receive a notification with no sound.

headingproperty#

heading?: number;

For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

horizontal_accuracyproperty#

horizontal_accuracy?: number;

The radius of uncertainty for the location, measured in meters; 0-1500

latitudeproperty#

latitude: number;

Latitude of the location

live_periodproperty#

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

longitudeproperty#

longitude: number;

Longitude of the location

message_effect_idproperty#

message_effect_id?: string;

Unique identifier of the message effect to be added to the message; for private chats only

message_thread_idproperty#

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

protect_contentproperty#

protect_content?: boolean;

Protects the contents of the sent message from forwarding and saving

proximity_alert_radiusproperty#

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.

reply_markupproperty#

reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;

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.

reply_parametersproperty#

reply_parameters?: ReplyParameters;

Description of the message to reply to

suggested_post_parametersproperty#

suggested_post_parameters?: SuggestedPostParameters;

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.