پرش به مطلب اصلی

دریافت شهرستان‌ها

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

📍 لینک دسترسی​

GET {base_url}/api/send/banks/counties?province_id={province_id}

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

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

📝 پارامترها​

پارامترنوعضروریتوضیحات
province_idintegerبلهشناسه استان برای دریافت شهرستان‌های آن

✅ پاسخ موفق​

{
  "data": [
    {
      "id": 147,
      "name": "بیرجند"
    },
    {
      "id": 246,
      "name": "نامشخص"
    },
    {
      "id": 884,
      "name": "طبس"
    },
    {
      "id": 901,
      "name": "قائنات"
    },
    {
      "id": 990,
      "name": "بشرویه"
    },
    {
      "id": 1026,
      "name": "خوسف"
    },
    {
      "id": 1031,
      "name": "درمیان"
    },
    {
      "id": 1053,
      "name": "زیرکوه"
    },
    {
      "id": 1056,
      "name": "سرایان"
    },
    {
      "id": 1058,
      "name": "سربیشه"
    },
    {
      "id": 1080,
      "name": "فردوس"
    },
    {
      "id": 1110,
      "name": "نهبندان"
    }
  ],
  "meta": {
    "status": true,
    "message": "انجام شد",
    "message_parameters": [],
    "message_code": "200-1"
  }
}

📝 نکات​

  • پارامتر province_id اجباری است و باید شناسه معتبر استان باشد.
  • فهرست شهرستان‌های استان انتخابی بازگردانده می‌شود.
  • شناسه شهرستان‌ها برای استفاده در API ارسال پیامک شهر و استان مورد نیاز است.

❌ پاسخ خطا — توکن نامعتبر یا منقضی شده (401)​

{
  "data": null,
  "meta": {
    "status": false,
    "message": "اطلاعات وارد شده صحیح نمی باشد",
    "message_parameters": [],
    "message_code": "400-1",
    "errors": {}
  }
}

❌ پاسخ خطا — استان یافت نشد (404)​

{
  "data": null,
  "meta": {
    "status": false,
    "message": "استان یافت نشد",
    "message_parameters": [],
    "message_code": "404-1",
    "errors": {}
  }
}

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

curl --location '{base_url}/api/send/banks/counties?province_id=89' \
--header 'Authorization: API TOKEN'