Telegram Bot API

sendWidget

دسته‌بندی: ویجت‌ها · Bot API 10.5 · مستندات رسمی

تاریخچه نسخه‌ها: اضافه‌شده در Bot API 10.4

پیامی حاوی ویجت HTML ارسال می‌کند (Bot API 10.4).

مقدار بازگشتی: در صورت موفقیت، Message برمی‌گرداند.

پارامترها

پارامترنوعالزامیتوضیحات
chat_idInteger or Stringبلهشناسه چت یا @username
message_thread_idIntegerاختیاریشناسه تاپیک انجمن
htmlStringبلهکد HTML ویجت: 1-32768 بایت، حداکثر 4096 بایت پس از فشرده‌سازی zlib
widthIntegerاختیاریعرض ویجت به پیکسل منطقی (برای عرض کامل پیام خالی بگذارید)
heightIntegerاختیاریارتفاع ویجت به پیکسل منطقی، 50-600 (برای تطبیق با محتوا خالی بگذارید)
public_dataStringاختیاریوضعیت عمومی ویجت (public_data)، 0-1024 بایت — هر جا ویجت نمایش داده شود قابل مشاهده است
chat_dataStringاختیاریوضعیت ویجت در این چت (chat_data)، 0-1024 بایت
captionStringاختیاریکپشن (0-1024)
parse_modeStringاختیاریHTML، Markdown یا MarkdownV2
caption_entitiesArray of MessageEntityاختیاریآرایه JSON از نوع MessageEntity برای کپشن
show_caption_above_mediaBooleanاختیارینمایش کپشن بالای ویجت
allow_queriesBooleanاختیاریاجازه به ویجت برای ارسال کوئری به ربات (widget_query)
is_sharedBooleanاختیاریایجاد ویجت اشتراکی — می‌توان آن را دوباره با sendSharedWidget ارسال کرد
disable_notificationBooleanاختیاریارسال بی‌صدا
protect_contentBooleanاختیاریمحافظت از محتوا
allow_paid_broadcastBooleanاختیاریاجازه ارسال انبوه پولی
message_effect_idStringاختیاریشناسه افکت پیام
reply_parametersReplyParametersاختیاریآبجکت JSON از نوع ReplyParameters
reply_markupInlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReplyاختیاریآبجکت JSON از نوع InlineKeyboardMarkup / ReplyKeyboardMarkup / ReplyKeyboardRemove / ForceReply

توضیحات پارامترها خلاصه‌اند؛ متن کامل را در مستندات رسمی ببینید.

نمونه درخواست

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

راهنمای گام‌به‌گام: ویجت تلگرام چیست؟ HTML تعاملی داخل پیام‌های ربات