مرجع API پیام‌رسان‌هاhttps://api.irnoti.com/v1

sendInvoice

متد

از این متد برای ارسال صورتحساب استفاده کنید. در صورت موفقیت، Message ارسال‌شده برگردانده می‌شود.

خروجی: Message

پارامترها

نام	نوع	الزام	توضیحات
chat_id	Integer or String	الزامی	شناسهٔ یکتای گفتگوی هدف یا نام‌کاربری ربات، ابرگروه یا کانال هدف با قالب @username
message_thread_id	Integer	اختیاری	شناسهٔ یکتای رشتهٔ پیام (تاپیک) فروم هدف؛ فقط برای ابرگروه‌های فروم و گفتگوهای خصوصی ربات‌هایی که حالت تاپیک فروم برایشان فعال است.
direct_messages_topic_id	Integer	اختیاری	شناسهٔ تاپیک پیام مستقیم که پیام به آن فرستاده می‌شود؛ اگر پیام به یک گفتگوی پیام مستقیم فرستاده شود الزامی است.
title	String	الزامی	نام محصول؛ ۱ تا ۳۲ نویسه
description	String	الزامی	توضیح محصول؛ ۱ تا ۲۵۵ نویسه
payload	String	الزامی	payload صورتحساب که ربات تعیین می‌کند؛ ۱ تا ۱۲۸ بایت. به کاربر نمایش داده نمی‌شود و برای فرایندهای داخلی شما کاربرد دارد.
provider_token	String	اختیاری	توکن ارائه‌دهندهٔ پرداخت که از @BotFather گرفته می‌شود. برای پرداخت با ستارهٔ تلگرام رشتهٔ خالی بدهید.
currency	String	الزامی	کد سه‌حرفی ارز بر پایهٔ ISO 4217؛ دربارهٔ ارزها بیشتر بخوانید. برای پرداخت با ستارهٔ تلگرام «XTR» بدهید.
prices	Array of LabeledPrice	الزامی	تفکیک قیمت؛ فهرست JSON از اجزا (مثلاً قیمت محصول، مالیات، تخفیف، هزینهٔ ارسال، مالیات ارسال، پاداش و غیره). برای پرداخت با ستارهٔ تلگرام باید دقیقاً یک مورد داشته باشد.
max_tip_amount	Integer	اختیاری	بیشترین مبلغ انعام (tip) پذیرفته‌شده به کوچک‌ترین واحد ارز (عدد صحیح، نه اعشاری). مثلاً برای حداکثر انعام ۱٫۴۵ دلار آمریکا max_tip_amount = 145 بدهید. پارامتر exp را در currencies.json ببینید؛ تعداد ارقام بعد از ممیز هر ارز را نشان می‌دهد (برای بیشتر ارزها ۲). پیش‌فرض ۰. برای پرداخت با ستارهٔ تلگرام پشتیبانی نمی‌شود.
suggested_tip_amounts	Array of Integer	اختیاری	آرایهٔ JSON از مبالغ پیشنهادی انعام به کوچک‌ترین واحد ارز (عدد صحیح، نه اعشاری). حداکثر ۴ مبلغ انعام پیشنهادی می‌توان مشخص کرد. مبالغ پیشنهادی باید مثبت و با ترتیب اکیداً صعودی باشند و از max_tip_amount بیشتر نشوند.
start_parameter	String	اختیاری	پارامتر deep-linking یکتا. اگر خالی بماند، نسخه‌های فورواردشدهٔ پیام ارسالی دکمهٔ پرداخت (Pay) خواهند داشت و چند کاربر می‌توانند با همان صورتحساب مستقیماً از پیام فورواردشده پرداخت کنند. اگر خالی نباشد، نسخه‌های فورواردشدهٔ پیام به‌جای دکمهٔ پرداخت، دکمهٔ URL با لینک عمیق به ربات خواهند داشت و مقدار آن به‌عنوان پارامتر start استفاده می‌شود.
provider_data	String	اختیاری	داده‌های سریالایز‌شده به JSON دربارهٔ صورتحساب که با ارائه‌دهندهٔ پرداخت به اشتراک گذاشته می‌شود. توضیح دقیق فیلدهای موردنیاز را باید ارائه‌دهندهٔ پرداخت بدهد.
photo_url	String	اختیاری	آدرس عکس محصول برای صورتحساب. می‌تواند عکس کالا یا تصویر تبلیغاتی یک خدمت باشد. مردم بیشتر دوست دارند ببینند برای چه چیزی پول می‌دهند.
photo_size	Integer	اختیاری	حجم عکس به بایت
photo_width	Integer	اختیاری	عرض عکس
photo_height	Integer	اختیاری	ارتفاع عکس
need_name	Boolean	اختیاری	اگر برای تکمیل سفارش به نام کامل کاربر نیاز دارید، True بدهید. برای پرداخت با ستارهٔ تلگرام نادیده گرفته می‌شود.
need_phone_number	Boolean	اختیاری	اگر برای تکمیل سفارش به شمارهٔ تلفن کاربر نیاز دارید، True بدهید. برای پرداخت با ستارهٔ تلگرام نادیده گرفته می‌شود.
need_email	Boolean	اختیاری	اگر برای تکمیل سفارش به آدرس ایمیل کاربر نیاز دارید، True بدهید. برای پرداخت با ستارهٔ تلگرام نادیده گرفته می‌شود.
need_shipping_address	Boolean	اختیاری	اگر برای تکمیل سفارش به نشانی ارسال کاربر نیاز دارید، True بدهید. برای پرداخت با ستارهٔ تلگرام نادیده گرفته می‌شود.
send_phone_number_to_provider	Boolean	اختیاری	اگر شمارهٔ تلفن کاربر باید برای ارائه‌دهنده فرستاده شود، True بدهید. برای پرداخت با ستارهٔ تلگرام نادیده گرفته می‌شود.
send_email_to_provider	Boolean	اختیاری	اگر آدرس ایمیل کاربر باید برای ارائه‌دهنده فرستاده شود، True بدهید. برای پرداخت با ستارهٔ تلگرام نادیده گرفته می‌شود.
is_flexible	Boolean	اختیاری	اگر قیمت نهایی به روش ارسال بستگی دارد، True بدهید. برای پرداخت با ستارهٔ تلگرام نادیده گرفته می‌شود.
disable_notification	Boolean	اختیاری	پیام را بی‌صدا می‌فرستد. کاربران اعلانی بدون صدا دریافت می‌کنند.
protect_content	Boolean	اختیاری	محتوای پیام ارسالی را از فوروارد و ذخیره‌شدن محافظت می‌کند.
allow_paid_broadcast	Boolean	اختیاری	برای مجاز شدن ارسال تا ۱۰۰۰ پیام در ثانیه و نادیده‌گرفتن محدودیت‌های ارسال انبوه، با هزینهٔ ۰٫۱ ستارهٔ تلگرام برای هر پیام، True بدهید. ستارهٔ مربوط از موجودی ربات کسر می‌شود.
message_effect_id	String	اختیاری	شناسهٔ یکتای افکتی که به پیام اضافه می‌شود؛ فقط برای گفتگوهای خصوصی
suggested_post_parameters	SuggestedPostParameters	اختیاری	شیء سریالایز‌شده به JSON شامل پارامترهای پست پیشنهادی که باید فرستاده شود؛ فقط برای گفتگوهای پیام مستقیم. اگر پیام در پاسخ به یک پست پیشنهادی دیگر فرستاده شود، آن پست پیشنهادی به‌طور خودکار رد می‌شود.
reply_parameters	ReplyParameters	اختیاری	توضیحات پیامی که به آن پاسخ داده می‌شود.
reply_markup	InlineKeyboardMarkup	اختیاری	شیء سریالایز‌شده به JSON برای کیبورد اینلاین. اگر خالی باشد، یک دکمهٔ «پرداخت قیمت کل» نمایش داده می‌شود. اگر خالی نباشد، اولین دکمه باید دکمهٔ پرداخت (Pay) باشد.