پیوندهای بله
با پیوندهای ble.ir می‌توانید کاربر را مستقیم به بخشی از بله ببرید: گفتگو با یک کاربر یا
بازو، یک پیام مشخص، پیش‌نمایش یک گروه، مینی‌اپ یک بازو یا صفحهٔ اشتراک‌گذاری. وقتی کاربر در
کلاینت بله روی این پیوندها می‌زند، بخش موردنظر در خود بله باز می‌شود.
در متن پیام‌ها می‌توانید پیوند را با https:// یا بدون آن بنویسید؛ برای مثال https://ble.ir/botfather
و ble.ir/botfather هر دو کار می‌کنند. مقدار پارامترهای query را
URL-encode (opens in a new tab) کنید.
پیوند نام کاربری
https://ble.ir/<username>گفتگو با کاربر، بازو، گروه یا کانالی را باز می‌کند که نام کاربری عمومی username را دارد.
| نام | اختیاری | توضیحات |
|---|---|---|
username | الزامی | نام کاربری عمومی، بدون @. فقط شامل حروف لاتین، عدد و _ است. |
نمونه:
https://ble.ir/botfatherپیوند پیام
https://ble.ir/<username>/<message_id>/<date>
https://ble.ir/post/<group_id>/<message_id>/<date>گفتگو را باز می‌کند و به پیام مشخص‌شده می‌رود.
- قالب اول برای پیام‌های گروه‌ها و کانال‌هایی است که نام کاربری عمومی دارند.
- قالب دوم برای پیام‌های گروه‌ها و کانال‌های بدون نام کاربری است و فقط برای اعضای همان گروه یا کانال باز می‌شود.
message_id و date با هم یک پیام را مشخص می‌کنند. این پیوندها را خودتان نسازید؛ آن‌ها را با
گزینهٔ کپی پیوند در منوی پیام، از کلاینت بله بردارید.
پیوند دعوت
https://ble.ir/join/<token>پیش‌نمایش یک گروه یا کانال را نشان می‌دهد تا کاربر بتواند عضو آن شود. با این پیوند می‌توانید کاربران را به گروه‌ها و کانال‌های بدون نام کاربری هم دعوت کنید.
| نام | اختیاری | توضیحات |
|---|---|---|
token | الزامی | شناسهٔ پیوند دعوت گروه یا کانال |
مدیران گروه یا کانال این پیوند را از تنظیمات آن دریافت می‌کنند. بازوها هم با متدهای createChatInviteLink، exportChatInviteLink و revokeChatInviteLink پیوند دعوت می‌سازند یا باطل می‌کنند.
پیوند شروع بازو
https://ble.ir/<bot_username>?start=<parameter>گفتگو با بازو را باز می‌کند و پیام /start <parameter> را برای بازو می‌فرستد. اگر parameter
خالی باشد، فقط /start فرستاده می‌شود.
| نام | اختیاری | توضیحات |
|---|---|---|
bot_username | الزامی | نام کاربری بازو |
parameter | اختیاری | مقداری که بعد از /start فرستاده می‌شود |
از این پارامتر برای شناختن منبع ورود کاربر، مانند یک کمپین یا یک پیوند معرفی، یا برای باز کردن
بخش مشخصی از بازو استفاده کنید. بازو این مقدار را در متن پیام /start دریافت می‌کند.
نمونه:
https://ble.ir/sample_bot?start=campaign_42با این پیوند، پیام /start campaign_42 برای بازوی sample_bot فرستاده می‌شود. توضیحات بیشتر در
پیوندهای بازو.
پیوند مینی‌اپ
https://ble.ir/<bot_username>?startapp
https://ble.ir/<bot_username>?startapp=<start_param>
https://ble.ir/<bot_username>?startapp=<start_param>&mode=<mode>مینی‌اپ اصلی بازو را مستقیم باز می‌کند؛ کاربر لازم نیست گفتگو با بازو را شروع کرده باشد.
| نام | اختیاری | توضیحات |
|---|---|---|
bot_username | الزامی | نام کاربری بازو |
start_param | اختیاری | مقداری که به مینی‌اپ داده می‌شود. مینی‌اپ آن را در پارامتر tgWebAppStartParam و در start_param از initData می‌خواند. |
mode | اختیاری | fullscreen برای نمایش تمام‌صفحه یا compact برای نمایش در ابعاد کوچک‌تر |
نمونه:
https://ble.ir/sample_miniapp_bot?startapp=order_1024&mode=compactپیوند اشتراک‌گذاری
https://ble.ir/share?url=<url>&text=<text>فهرست گفتگوهای کاربر را باز می‌کند. پس از انتخاب یک گفتگو، url و text در کادر نوشتن پیام آن
گفتگو قرار می‌گیرند و کاربر می‌تواند پیش از ارسال، آن‌ها را ویرایش کند. پیام بدون تأیید کاربر
فرستاده نمی‌شود.
| نام | اختیاری | توضیحات |
|---|---|---|
url | اختیاری | نشانی‌ای که به اشتراک گذاشته می‌شود |
text | اختیاری | متنی که بعد از نشانی قرار می‌گیرد |
قالب https://ble.ir/share/url?url=<url>&text=<text> هم پذیرفته می‌شود و همین رفتار را دارد.
از این پیوند برای ساختن دکمهٔ «اشتراک‌گذاری در بله» در وب‌سایت خود استفاده کنید:
<a href="https://ble.ir/share?url=https%3A%2F%2Fdocs.bale.ai&text=%D9%85%D8%B3%D8%AA%D9%86%D8%AF%D8%A7%D8%AA%20%D8%A8%D9%84%D9%87">
اشتراک‌گذاری در بله
</a>برای ساختن پیوند در کد، مقدارها را encode کنید:
const shareLink =
"https://ble.ir/share?" +
new URLSearchParams({ url: "https://docs.bale.ai", text: "مستندات بله" });