معرفی API

به مستندات API سرویس Mizban SMS خوش آمدید. این API برای ارسال پیامک و ایمیل طراحی شده است و امکان یکپارچه‌سازی سرویس‌های ارتباطی را با نرم‌افزارهای شما فراهم می‌کند.

قابلیت جدید: سیستم پترن هوشمند

سرویس ما اکنون از سیستم پترن هوشمند پشتیبانی می‌کند که به شما امکان می‌دهد:

  • پارامتر pattern_code را اختیاری ارسال کنید
  • پترن پیش‌فرض برای هر کاربر تعریف کنید
  • انتخاب خودکار پترن بر اساس تنظیمات def
  • سه‌لایه پشتیبان: پارامتر → دیتابیس → سورس

مزایای استفاده از API

  • ارسال پیامک و ایمیل با چند خط کد
  • پشتیبانی از الگوهای متنوع پیامکی
  • امکان ارسال انبوه
  • امنیت بالا با استفاده از API Key
  • پاسخگویی سریع و uptime بالا
  • جدید: سیستم پترن هوشمند

وضعیت سرویس

همه سرویس‌ها فعال هستند

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

سرویس پیامک
وضعیت: فعال
سرویس ایمیل
وضعیت: فعال

API ارسال پیامک NEW

GET
https://web.sms-bot.ir/api/v1/sendsms

برای ارسال پیامک، از endpoint فوق با متد GET استفاده کنید.

نکته مهم درباره pattern_code

پارامتر pattern_code اکنون اختیاری است. اگر این پارامتر را ارسال نکنید، سیستم به طور خودکار از پترن پیش‌فرض شما استفاده خواهد کرد.

پارامترهای ورودی

نام فیلد نوع داده شرح اجباری
apikey string کلید API کاربر بله
type string نوع درخواست (send) بله
phone integer شماره تلفن دریافت‌کننده بله
pattern_code string کد الگوی پیامک (اختیاری) خیر
value integer مقدار متغیرهای الگو (حداکثر 6 رقم) بله
book string کد الگوی دفترچه تلفن خیر

نمونه درخواست‌ها

درخواست با pattern_code
https://web.sms-bot.ir/api/v1/sendsms/?type=send&apikey=xxxxxxxxxxxxx&phone=09123456789&pattern_code=abc123&value=123456
درخواست بدون pattern_code (استفاده از پترن پیش‌فرض)
https://web.sms-bot.ir/api/v1/sendsms/?type=send&apikey=xxxxxxxxxxxxx&phone=09123456789&value=123456

پاسخ موفق

{ "status_code": 200, "comment": "success!", "office_name": "دفتر1", "phone_saved": true, "message_id": "123456789", "pattern_used": "abc123", "pattern_source": "parameter", "pattern_source_fa": "پارامتر", "pattern_reason": "def=off & parameter sent" }

API دریافت موجودی

GET
https://web.sms-bot.ir/balance.php

برای دریافت موجودی حساب خود، از endpoint فوق استفاده کنید.

پارامترهای ورودی

نام فیلد نوع داده شرح اجباری
apikey string کلید API کاربر بله

نمونه درخواست

درخواست API
https://web.sms-bot.ir/balance.php?apikey=xxxxxxxxxxxxx

پاسخ موفق

{ "status_code": 200, "balance": 150000, "currency": "تومان" }

API ارسال ایمیل

GET
https://web.sms-bot.ir/api/v1/sendemail

برای ارسال ایمیل، از endpoint فوق با متد GET استفاده کنید.

پارامترهای ورودی

نام فیلد نوع داده شرح اجباری
apikey string کلید API کاربر بله
email string آدرس ایمیل دریافت‌کننده بله
template_code string کد قالب ایمیل بله
subject string موضوع ایمیل خیر
variables JSON متغیرهای قالب ایمیل خیر

نمونه درخواست

درخواست API
https://web.sms-bot.ir/api/v1/sendemail/[email protected]&template_code=12345&subject=Test Email

پاسخ موفق

{ "status": "success", "message": "ایمیل با موفقیت ارسال شد" }

سوالات متداول

چگونه API Key دریافت کنم؟

برای دریافت API Key، به ربات تلگرامی SmSMizbanBoT مراجعه کنید و پس از ثبت نام، API Key شما ایجاد خواهد شد.

def چیست و چگونه کار می‌کند؟

def یک تنظیم است که نحوه انتخاب پترن را کنترل می‌کند:

  • def='on': همیشه از پترن پیش‌فرض دیتابیس استفاده می‌شود (پارامتر pattern_code نادیده گرفته می‌شود)
  • def='off': اگر پارامتر pattern_code ارسال شود، از آن استفاده می‌شود. در غیر این صورت از پترن پیش‌فرض دیتابیس استفاده می‌شود.
آیا می‌توانم بدون ارسال pattern_code پیامک بفرستم؟

بله! اگر پترن پیش‌فرضی در دیتابیس تنظیم کرده باشید، می‌توانید بدون ارسال پارامتر pattern_code پیامک ارسال کنید. سیستم به طور خودکار از پترن پیش‌فرض شما استفاده خواهد کرد.

محدودیت میزان ارسال پیامک چیست؟

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

اگر def='on' باشد و پترن پیش‌فرض خالی باشد چه می‌شود؟

در این حالت، سیستم از پترن سراسری 2y65xxxxxxxx4500 استفاده خواهد کرد. این پترن به عنوان پشتیبان نهایی عمل می‌کند.

پشتیبانی

برای دریافت پشتیبانی، می‌توانید از طریق راه‌های زیر با ما در تماس باشید:

پشتیبانی تلگرام

@RaoneSUP

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

[email protected]

ساعات پاسخگویی: شنبه تا پنجشنبه، از ساعت ۹ صبح تا ۵ بعدازظهر