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

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

این API به شما امکان دریافت فهرست جنسیت‌ها را می‌دهد که می‌تواند برای فیلتر کردن گیرندگان بر اساس جنسیت در ارسال شهر و استان استفاده شود.

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

GET {base_url}/api/send/banks/genders

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

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

✅ پاسخ موفق​

{
  "data": [
    {
      "id": 1,
      "name": "مرد"
    },
    {
      "id": 2,
      "name": "زن"
    },
    {
      "id": 3,
      "name": "سازمانی- حقوقی"
    }
  ],
  "meta": {
    "status": true,
    "message": "انجام شد",
    "message_parameters": [],
    "message_code": "200-1"
  }
}

📝 نکات​

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

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

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

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

curl --location '{base_url}/api/send/banks/genders' \
--header 'Authorization: API TOKEN'