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

ساخت مخاطب

یک مخاطب با جزئیات کامل می‌سازد و می‌تواند هم‌زمان به گروه‌ها اضافه کند.

POSThttps://api.irnoti.com/v1/phonebook/contacts
scope: phonebook.write

حداقل یکی از mobile یا email لازم است. birth را شمسی بدهید (YYYY/MM/DD یا MM/DD) و در پایگاه داده میلادی ذخیره می‌شود. fields تا ۱۲ فیلد دلخواه (کلید ≤۴۰، مقدار ≤۲۰۰ نویسه).

پارامترها

ناممحلنوعتوضیح
mobileبدنهstringشمارهٔ موبایل.
emailبدنهstringایمیل.
nameبدنهstringنام.
lastNameبدنهstringنام خانوادگی.
companyبدنهstringشرکت.
cityبدنهstringشهر.
noteبدنهstringیادداشت.
birthبدنهstringتولد شمسی.
fieldsبدنهobjectفیلدهای دلخواه.
groupIdsبدنهstring[]گروه‌هایی که مخاطب به آن‌ها اضافه شود (حداکثر ۵۰).
optedOutبدنهbooleanلغو عضویت از ارسال‌ها.

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

401unauthorizedکلید API نامعتبر یا منقضی است.
403insufficient_scopeکلید API دامنهٔ دسترسی لازم را ندارد.
400validation_errorورودی نامعتبر است (جزئیات در پاسخ).

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

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

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

curl -X POST 'https://api.irnoti.com/v1/phonebook/contacts' \
  -H "Authorization: Bearer $IRNOTI_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "علی",
  "birth": "1370/05/12",
  "mobile": "09121234567",
  "groupIds": [
    "12"
  ],
  "lastName": "رضایی"
}'
پاسخ نمونه200 OK
{
  "id": "801",
  "name": "علی",
  "mobile": "09121234567"
}
ساخت مخاطب — مستندات API | ایران ناتیفیکیشن