Telegram Bot API

sendWidget

Categoría: Widgets · Bot API 10.5 · Documentación oficial

Historial de versiones: Agregado en la Bot API 10.4

Envía un mensaje con un widget HTML (Bot API 10.4).

Devuelve: Si la llamada tiene éxito, devuelve Message.

Parámetros

ParámetroTipoObligatorioDescripción
chat_idInteger or StringSíID del chat o @username
message_thread_idIntegerOpcionalID del tema del foro
htmlStringSíCódigo HTML del widget: 1-32768 bytes, máximo 4096 bytes tras la compresión zlib
widthIntegerOpcionalAncho del widget en píxeles lógicos (omitir para ocupar todo el ancho del mensaje)
heightIntegerOpcionalAlto del widget en píxeles lógicos, 50-600 (omitir para ajustarse al contenido)
public_dataStringOpcionalEstado público del widget (public_data), 0-1024 bytes — visible dondequiera que se muestre el widget
chat_dataStringOpcionalEstado del widget en este chat (chat_data), 0-1024 bytes
captionStringOpcionalLeyenda (0-1024)
parse_modeStringOpcionalHTML, Markdown o MarkdownV2
caption_entitiesArray of MessageEntityOpcionalArray JSON de MessageEntity para la leyenda
show_caption_above_mediaBooleanOpcionalMostrar la leyenda encima del widget
allow_queriesBooleanOpcionalPermitir que el widget envíe consultas al bot (widget_query)
is_sharedBooleanOpcionalCrear un widget compartido — se puede volver a enviar con sendSharedWidget
disable_notificationBooleanOpcionalEnviar sin sonido
protect_contentBooleanOpcionalProteger el contenido
allow_paid_broadcastBooleanOpcionalPermitir difusión de pago
message_effect_idStringOpcionalID del efecto del mensaje
reply_parametersReplyParametersOpcionalObjeto JSON ReplyParameters
reply_markupInlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReplyOpcionalObjeto JSON: InlineKeyboardMarkup / ReplyKeyboardMarkup / ReplyKeyboardRemove / ForceReply

Las descripciones de los parámetros son resúmenes breves; consulta la documentación oficial para ver el texto completo.

Ejemplo de solicitud

curl

curl -s -X POST "https://api.telegram.org/bot$TOKEN/sendWidget" \
  -H "Content-Type: application/json" \
  -d '{
  "chat_id": 123456789,
  "html": "<h3>Order #1042</h3><p>2 × Margherita</p><button>Track the order</button>"
}'

Python

import requests

TOKEN = "123456789:AAEexampleTokenReplaceWithYours"
resp = requests.post(
    f"https://api.telegram.org/bot{TOKEN}/sendWidget",
    json={
        "chat_id": 123456789,
        "html": "<h3>Order #1042</h3><p>2 × Margherita</p><button>Track the order</button>"
    },
    timeout=30,
)
print(resp.json())

JavaScript

const TOKEN = "123456789:AAEexampleTokenReplaceWithYours";
const res = await fetch(`https://api.telegram.org/bot${TOKEN}/sendWidget`, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    "chat_id": 123456789,
    "html": "<h3>Order #1042</h3><p>2 × Margherita</p><button>Track the order</button>"
  }),
});
console.log(await res.json());

Guía paso a paso: Widgets de Telegram: HTML interactivo dentro de los mensajes de tu bot