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

لیست شماره‌های دفترچه تلفن

این API به شما امکان دریافت فهرستی از تمام شماره‌های دفترچه تلفن را می‌دهد.

📍 نقطه پایانی

GET {base_url}/api/phonebooks/numbers/contact-list

🧾 هدرها

کلیدمقدار
AuthorizationYOUR_TOKEN_HERE
Content-Typeapplication/json

📝 پارامترها

پارامترنوعالزامیتوضیحات
from_created_atstringخیرزمان برای فیلتر کردن شماره‌هایی که بعد از این تاریخ ایجاد شده‌اند. فرمت: Unix timestamp (ثانیه از epoch).
numberstringخیرشماره تلفن برای فیلتر. فرمت: E.164 (مثال: +989121234568).
phonebook_titlestringخیرعنوان دفترچه تلفن برای فیلتر.
phonebook_idstringخیرشناسه دفترچه تلفن برای فیلتر.
pageintegerخیرشماره صفحه برای صفحه‌بندی (پیش‌فرض 1)
per_pageintegerخیرتعداد مدخل‌ها در هر صفحه (پیش‌فرض 10، حداکثر 1000)

✅ پاسخ موفق

{
"data": [
{
"id": 1233,
"phonebook_id": 123456,
"pre": "",
"name": "",
"email": "",
"number": "+989123456788",
"created_at": "2025-04-19T11:11:41+00:00",
"updated_at": "2025-04-19T11:12:51+00:00",
"phonebook_title": "تست 3532"
},
{
"id": 1234,
"phonebook_id": 123456,
"pre": "",
"name": "",
"email": "",
"number": "+989123456789",
"created_at": "2025-04-19T11:11:41+00:00",
"updated_at": "2025-04-19T11:12:51+00:00",
"phonebook_title": "تست 3532"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "{base_url}/api/phonebooks/numbers/contact-list",
"per_page": 10,
"to": 2,
"total": 2,
"status": true,
"message": "انجام شد",
"message_code": "200-1"
}
}

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

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

🧪 مثال درخواست

curl --location '{base_url}/api/phonebooks/numbers/contact-list' \
--header 'Content-Type: application/json' \
--header 'Authorization: API TOKEN'