ایران ناتیفیکیشن

مخاطبین یک گروه

فهرست اعضای گروه با جست‌وجو و صفحه‌بندی.

GEThttps://api.irnoti.com/v1/phonebook/groups/{id}/contacts
scope: phonebook.read

یا صفحه‌بندی عددی (page/pageSize) یا مکان‌نمایی (take/after). q در نام، شماره و ایمیل جست‌وجو می‌کند.

پارامترها

ناممحلنوعتوضیح
id *مسیرstringشناسهٔ گروه.
qquerystringعبارت جست‌وجو.
pagequeryintegerشمارهٔ صفحه.
pageSizequeryintegerاندازهٔ صفحه.
takequeryintegerتعداد (حالت مکان‌نما).
afterquerystringشناسهٔ آخرین ردیف صفحهٔ قبل.

خطاهای خاص این endpoint

401unauthorizedکلید API نامعتبر یا منقضی است.
403insufficient_scopeکلید API دامنهٔ دسترسی لازم را ندارد.
404not_foundگروه پیدا نشد یا متعلق به شما نیست.

اجرای زنده (محیط تست)

باز کردن در کنسول کامل ←

این endpoint در محیط تست پشتیبانی نمی‌شود؛ برای اجرا، کلید واقعی را در حالت «اجرای واقعی» وارد کنید.

curl -X GET 'https://api.irnoti.com/v1/phonebook/groups/12/contacts?take=2' \
  -H "Authorization: Bearer $IRNOTI_KEY"
پاسخ نمونه200 OK
[
  {
    "id": "801",
    "name": "علی",
    "mobile": "09121234567",
    "optedOut": false
  }
]
مخاطبین یک گروه — مستندات API | ایران ناتیفیکیشن