# پیام‌رسان

> پیام‌رسان یک سامانهٔ فارسی و راست‌چین برای مدیریت یکپارچهٔ ارسال پیامک است. کسب‌وکارها حساب SMS.ir یا MSGway خود را به پیام‌رسان متصل می‌کنند و با یک API، درخواست‌های پیامک نرم‌افزارشان را ارسال و پیگیری می‌کنند.

شعار برند: «یک اتصال، تمام پیام‌های شما.» مخاطبان محصول، کسب‌وکارها و تیم‌های توسعه‌ای هستند که برای وب‌سایت، اپلیکیشن یا نرم‌افزار خود به ارسال کد ورود و اعلان‌های پیامکی نیاز دارند.

پیام‌رسان واسط ارتباط نرم‌افزار مشتری با حساب پیامکی اوست. SMS.ir و MSGway تأمین‌کننده‌های مستقل هستند؛ هزینهٔ پیامک از حساب مشتری نزد تأمین‌کننده کسر می‌شود.

روند استفاده: ثبت‌نام، فعال‌سازی حساب توسط مدیر، ثبت کلید API تأمین‌کننده و تنظیمات اتصال، ساخت توکن اختصاصی نرم‌افزار و ارسال درخواست به API پیام‌رسان. کلید تأمین‌کننده برای ارتباط پیام‌رسان با سرویس پیامکی است؛ توکن پیام‌رسان برای ارتباط نرم‌افزار مشتری با این محصول است.

امکانات نسخهٔ فعلی:
- اتصال اختصاصی SMS.ir و MSGway برای هر مشتری و تعیین تأمین‌کنندهٔ پیش‌فرض.
- ساخت توکن‌های جداگانه با تاریخ انقضا و اتصال مجاز، و لغو مستقل هر توکن.
- ثبت شناسه و پارامترهای قالب‌های تأییدشده و ارسال پیامک آزمایشی واقعی از پنل.
- مشاهدهٔ گزارش درخواست‌ها، روند ارسال و استعلام گزارش تأمین‌کننده.
- نقش‌های مدیر، اپراتور و مشتری؛ مدیر می‌تواند برای پشتیبانی وارد حساب مشتری شود و به حساب خود برگردد.
- ارسال از طریق `POST /api/v1/messages` با احراز هویت Bearer و پشتیبانی از `Idempotency-Key` برای مدیریت درخواست‌های تکراری.

محدودهٔ امکانات: ارسال متن آزاد و قالبی، مشاهدهٔ اعتبار و خطوط برای SMS.ir پشتیبانی می‌شود. MSGway برای ارسال قالبی استفاده می‌شود و موجودی آن از پنل اصلی تأمین‌کننده مشاهده می‌شود. قالب‌ها در پیام‌رسان به‌صورت محلی ثبت می‌شوند؛ دریافت خودکار فهرست قالب‌ها یا ایجاد و تأیید قالب در تأمین‌کننده جزو امکانات فعلی نیست. وضعیت «پذیرفته‌شده» به معنی پذیرش درخواست توسط تأمین‌کننده است، نه تأیید تحویل پیامک به گوشی. تعرفهٔ اشتراک، SLA و تضمین زمان تحویل در لندینگ فعلی اعلام نشده‌اند.

## معرفی و راهنمای محصول

- [صفحهٔ اصلی](/): معرفی رسمی پیام‌رسان و مسیر اتصال نرم‌افزار به تأمین‌کننده.
- [امکانات](/#features): امکانات پنل و مدیریت ارسال.
- [نحوهٔ کار](/#how-it-works): مراحل اتصال حساب و ساخت توکن.
- [راهنمای توسعه‌دهندگان](/#developers): نمونهٔ درخواست ارسال قالبی و توضیح ارتباط API.
- [سوالات متداول](/#faq): تفاوت کلیدها، فعال‌سازی حساب، قالب‌ها و گزارش تحویل.

## مستندات فنی

- [OpenAPI](/openapi.json): ساختار ماشین‌خوان مسیرها، مدل‌های درخواست و پاسخ و احراز هویت API.
- [مستندات تعاملی API](/docs): مرور و بررسی قرارداد API.

## Optional

- [ورود به پنل](/panel): ورود به حساب؛ اطلاعات عملیاتی مشتریان نیازمند احراز هویت است.
- [ثبت‌نام](/panel?mode=register): ساخت حساب مشتری؛ فعال‌سازی دسترسی ارسال توسط مدیر انجام می‌شود.