Telegram Bot API

sendWidget

Categoria: Widgets · Bot API 10.5 · Documentação oficial

Histórico de versões: Adicionado na Bot API 10.4

Envia uma mensagem com um widget HTML (Bot API 10.4).

Retorno: Em caso de sucesso, retorna Message.

Parâmetros

ParâmetroTipoObrigatórioDescrição
chat_idInteger or StringSimChat ID ou @username
message_thread_idIntegerOpcionalID do tópico do fórum
htmlStringSimCódigo HTML do widget: 1-32768 bytes, no máximo 4096 bytes após compressão zlib
widthIntegerOpcionalLargura do widget em pixels lógicos (omita para usar a largura total da mensagem)
heightIntegerOpcionalAltura do widget em pixels lógicos, 50-600 (omita para ajustar ao conteúdo)
public_dataStringOpcionalEstado público do widget (public_data), 0-1024 bytes — visível em todos os lugares onde o widget é exibido
chat_dataStringOpcionalEstado do widget neste chat (chat_data), 0-1024 bytes
captionStringOpcionalLegenda (0-1024)
parse_modeStringOpcionalHTML, Markdown, MarkdownV2
caption_entitiesArray of MessageEntityOpcionalArray JSON de MessageEntity para a legenda
show_caption_above_mediaBooleanOpcionalMostrar legenda acima do widget
allow_queriesBooleanOpcionalPermitir que o widget envie consultas ao bot (widget_query)
is_sharedBooleanOpcionalCriar um widget compartilhado — pode ser reenviado com sendSharedWidget
disable_notificationBooleanOpcionalEnviar sem som
protect_contentBooleanOpcionalProteger conteúdo
allow_paid_broadcastBooleanOpcionalPermitir transmissão paga
message_effect_idStringOpcionalID do efeito da mensagem
reply_parametersReplyParametersOpcionalObjeto JSON ReplyParameters
reply_markupInlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReplyOpcionalObjeto JSON: InlineKeyboardMarkup / ReplyKeyboardMarkup / ReplyKeyboardRemove / ForceReply

As descrições dos parâmetros são resumos concisos; consulte a documentação oficial para ver o texto completo.

Exemplo de requisição

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());

Guia passo a passo: Widgets do Telegram: blocos HTML interativos dentro das mensagens do bot