sendVenue()

Use this method to send information about a venue. On success, the sent Message is returned.

parameters

parameter	type	required	description
`business_connection_id`	string	optional	Unique identifier of the business connection on behalf of which the message will be sent
`chat_id`	number \| string	required	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format `@username`
`message_thread_id`	number	optional	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
`direct_messages_topic_id`	number	optional	Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
`latitude`	number	required	Latitude of the venue
`longitude`	number	required	Longitude of the venue
`title`	string	required	Name of the venue
`address`	string	required	Address of the venue
`foursquare_id`	string	optional	Foursquare identifier of the venue
`foursquare_type`	string	optional	Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
`google_place_id`	string	optional	Google Places identifier of the venue
`google_place_type`	string	optional	Google Places type of the venue. (See supported types.)
`disable_notification`	boolean	optional	Sends the message silently. Users will receive a notification with no sound.
`protect_content`	boolean	optional	Protects the contents of the sent message from forwarding and saving
`allow_paid_broadcast`	boolean	optional	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.
`message_effect_id`	string	optional	Unique identifier of the message effect to be added to the message; for private chats only
`suggested_post_parameters`	SuggestedPostParameters	optional	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.
`reply_parameters`	ReplyParameters	optional	Description of the message to reply to
`reply_markup`	InlineKeyboardMarkup \| ReplyKeyboardMarkup \| ReplyKeyboardRemove \| ForceReply	optional	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.

returns

Message

usage in yaebal

not (yet) hard-typed on Api — call it through the generic .call<T>() escape hatch documented in @yaebal/types.

bot.ts

import type { Message, SendVenueParams } from "@yaebal/types";

await bot.api.call<Message>("sendVenue", {
  chat_id: 123456789,
  latitude: 1,
  longitude: 1,
  title: "...",
  address: "...",
} satisfies SendVenueParams);

context shortcut

also available as ctx.sendVenue() on 16 context types — see @yaebal/contexts.

context shortcut

/** Use this method to send information about a venue. On success, the sent [Message](https://core.telegram.org/bots/api/#message) is returned. */
ctx.sendVenue(params: Omit<SendVenueParams, "chat_id">)

official Bot API docs: https://core.telegram.org/bots/api/#sendvenue