');">

مستندات وب سرویس

راهنمای کامل استفاده از API سامانه برای برنامه‌نویسان

مقدمه

وب سرویس سامانه پیامکی پیام رسان به شما امکان می‌دهد تا از طریق API، پیامک ارسال کنید، موجودی حساب را بررسی کنید، گزارشات را دریافت کنید و بسیاری از امکانات دیگر را به صورت خودکار انجام دهید.

دریافت API Key

پس از ثبت نام و ورود به پنل، می‌توانید از بخش تنظیمات، API Key خود را دریافت کنید.

                            API Key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
                        

ارسال پیامک

برای ارسال پیامک از طریق API:

POST /api/send-sms
Headers:
  Authorization: Bearer YOUR_API_KEY
  Content-Type: application/json

Body:
{
  "phone": "09123456789",
  "message": "متن پیامک",
  "sender": "5000"
}

بررسی موجودی

برای بررسی موجودی حساب:

GET /api/balance
Headers:
  Authorization: Bearer YOUR_API_KEY

دریافت گزارش

برای دریافت گزارش ارسال‌ها:

GET /api/reports?from=2024-01-01&to=2024-01-31
Headers:
  Authorization: Bearer YOUR_API_KEY

آزمایشگاه API

برای تست API قبل از استفاده در پروژه خود، می‌توانید از آزمایشگاه API استفاده کنید.

رفتن به آزمایشگاه