ارسال پیامک شهر و استان

این API به شما امکان ارسال پیام به تمام شماره‌های یک استان، شهرستان یا شهر خاص را می‌دهد.

📍 لینک دسترسی

POST {base_url}/api/send

🧾 هدرهای درخواست

کلید	مقدار
Authorization	توکن یا کلید دسترسی
Content-Type	application/json

📤 بدنه درخواست

{
  "sending_type": "country",
  "from_number": "+98BANK",
  "message": "تست",
  "params": [
    {
      "bank": "all",
      "pre": 938,
      "province_id": 89,
      "county_id": 212,
      "city_id": 82,
      "gender": 0,
      "age_from": 1300,
      "age_to": 1401,
      "mci": {
        "start": 10,
        "size": 100
      },
      "irancell": {
        "start": 1,
        "size": 2
      },
      "other": {
        "start": 2,
        "size": 3
      }
    }
  ],
  "other_recipients": [
    "+989121111111",
    "+989351111111"
  ]
}

📝 پارامترها

پارامتر	نوع	ضروری	توضیحات
sending_type	string	بله	نوع ارسال، باید "country" باشد
from_number	string	بله	شماره فرستنده در فرمت E.164 (مثال: +983000505)
message	string	بله	متن پیامی که میخواهید ارسال نمایید. این متن نباید بیش از 1400 کارکتر یا 20 پارت باشد
params	array	بله	آرایه‌ای از اشیاء شامل تنظیمات استان و شهر و شهرستان
bank	string	بله	نوع بانک اطلاعاتی: "all" برای همه
pre	integer	خیر	پیش‌شماره ای که میخواهید ارسال شما فقط به آن پیش شماره انجام شود
province_id	integer	بله	شناسه استان(قابل بازیابی از لیست استان ها)
county_id	integer	خیر	شناسه شهرستان(قابل بازیابی از لیست شهرستان ها)
city_id	integer	خیر	شناسه شهر(قابل بازیابی از لیست شهرها)
gender	integer	خیر	جنسیت: 0 برای همه، 1 برای مرد، 2 برای زن
age_from	integer	خیر	سال تولد شروع (شمسی)
age_to	integer	خیر	سال تولد پایان (شمسی)
mci	object	خیر	تنظیمات اپراتور همراه اول
irancell	object	خیر	تنظیمات اپراتور ایرانسل
other	object	خیر	تنظیمات سایر اپراتورها
start	integer	خیر	شماره ردیف شروع
size	integer	خیر	تعداد شماره‌های مورد نظر
other_recipients	array	خیر	گیرندگان اضافی در فرمت E.164
send_time	string	خیر	زمان مورد نظر برای ارسال پیام در فرمت YYYY-MM-DD HH:MM:SS. منطقه زمانی UTC است.

📝 تنظیمات اپراتور

هر اپراتور شامل دو پارامتر است:

• start: شماره ردیف شروع (پیش‌فرض: 0)
• size: تعداد شماره‌های مورد نظر (پیش‌فرض: 0)

📝 نکات

• from_number باید سرشماره معتبری باشد که به حساب کاربری شما اختصاص یافته است.
• می‌توانید با تنظیم پارامترهای جنسیت و سن، مخاطبین را فیلتر کنید.
• می‌توانید فقط استان، یا استان و شهرستان، یا هر سه (استان، شهرستان و شهر) را مشخص کنید.
• اگر پارامترهای اپراتور تنظیم نشوند، به همه شماره‌ها ارسال انجام می‌شود.

✅ پاسخ موفق

{
  "data": {
    "message_outbox_ids": [
      1123544244
    ]
  },
  "meta": {
    "status": true,
    "message": "انجام شد",
    "message_parameters": [],
    "message_code": "200-1"
  }
}

❌ پاسخ خطا — منطقه نامعتبر (422)

{
  "data": null,
  "meta": {
    "status": false,
    "message": "منطقه انتخابی نامعتبر است",
    "message_parameters": [],
    "message_code": "400-2",
    "errors": {
      "province_id": [
        "منطقه انتخابی نامعتبر است"
      ]
    }
  }
}

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

curl --location '{base_url}/api/send' \
--header 'Content-Type: application/json' \
--header 'Authorization: API TOKEN' \
--data '{
    "sending_type": "country",
    "from_number": "+98BANK",
    "message": "تست",
    "params": [
        {
            "bank": "all",
            "province_id": 89,
            "gender": 0,
            "mci": {
                "start": 10,
                "size": 100
            }
        }
    ]
}'