توسعه‌دهندگان

API باران پیام؛ پیامک را به محصول خود متصل کنید

وب‌سرویس REST، احراز هویت با APIKey، ارسال OTP/پترن و دریافت وضعیت تحویل — آماده اتصال به سایت، اپلیکیشن و نرم‌افزار سازمانی.

امکانات

آنچه از API دریافت می‌کنید

REST API

ارسال، مدیریت مخاطب و کمپین از طریق درخواست‌های HTTP.

APIKey

کلید دسترسی برای احراز هویت ساده و امن سرویس‌ها.

OTP

ارسال کد تأیید یکبار‌مصرف برای ورود و ثبت‌نام.

Pattern

تعریف پترن برای پیامک‌های خدماتی و اعتبارسنجی.

Delivery

دریافت وضعیت تحویل پیام برای گزارش‌گیری دقیق.

Webhooks

دریافت رویدادها و پیام‌های دریافتی به‌صورت خودکار.

Authentication

مدیریت سطوح دسترسی و توکن برای تیم و سرویس‌ها.

Examples

نمونه‌های آماده برای شروع سریع‌تر پروژه.

شروع با یک درخواست ساده

ساختار زیر صرفاً «نمونه درخواست» برای نمایش ظاهر کار است و مشخصات فنی رسمی API محسوب نمی‌شود. برای مستندات دقیق به پنل کاربری و راهنمای توسعه‌دهندگان مراجعه کنید.

پاسخ‌ها به‌صورت JSON بازگردانده می‌شوند
احراز هویت از طریق هدر Authorization انجام می‌شود
برای ارسال انبوه، شماره‌ها را در آرایه to قرار دهید

دریافت APIKey آموزش اتصال

send-sms.example.json

POST /api/v1/sms/send
Authorization: Bearer YOUR_APIKEY
Content-Type: application/json

{
  "to": ["09xxxxxxxxx"],
  "message": "کد تایید شما: 483921",
  "pattern": "otp-verify"
}

response.example.json

{
  "status": "success",
  "messageId": "bp-20260914-483921",
  "credited": false
}

نمونه درخواست — مشخصات فنی رسمی نیست

مسیر اتصال

چهار گام تا فعال‌سازی

ساخت اکانت

پنل رایگان یا حرفه‌ای خود را فعال کنید.

دریافت APIKey

از بخش تنظیمات، کلید دسترسی بسازید.

پیاده‌سازی

نمونه درخواست را در محصول خود استفاده کنید.

پایش

وضعیت تحویل را از گزارش‌ها دنبال کنید.

سؤال فنی دارید؟

تیم پشتیبانی باران پیام در کنار شماست.

تماس با پشتیبانی