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

ارسال پوش

پوش را به همهٔ دستگاه‌ها، یک موضوع، شناسه‌ها، موبایل‌ها، گروه دفترچه یا یک بخش‌بندی می‌فرستد.

POSThttps://api.irnoti.com/v1/sdk-apps/{id}/send
scope: broker.write

دقیقاً با یکی از حالت‌های target مخاطب را مشخص کنید: - all: true همهٔ دستگاه‌ها - topic - externalIds یا deviceIds (تا ۱۰۰۰) - phones (موبایل‌هایی که کاربر در اپ معرفی کرده) - groupId گروه دفترچه - segment ترکیب شرط‌ها: platform، locale، appVersion، tags، activeWithinDays، identified، country، city، near {lat, lon, radiusKm}، performed (رویداد گزارش‌شده) **امکانات:** زمان‌بندی (sendAt، حداکثر ۳۰ روز)، ساعت محلی هر دستگاه (sendLocal.time)، ساعت سکوت (quietHours)، آزمون A/B (variants با سهم درصدی) و پیامک جایگزین برای دستگاه‌های ناموفق (smsFallback.text). **پیام:** title، body، image، url/deepLink، data و … طبق ساختار پیام SDK. سقف ۶۰ درخواست در دقیقه.

پارامترها

ناممحلنوعتوضیح
id *مسیرstringشناسهٔ اپ.
message *بدنهobjectمحتوای پوش (عنوان، متن، تصویر، لینک، داده).
target *بدنهobjectمخاطب (بالا).
sendAtبدنهstring (ISO 8601)ارسال بعداً (حداکثر ۳۰ روز).
sendLocalبدنهobject{ time: "HH:MM" } ارسال با ساعت محلی هر دستگاه؛ همراه sendAt نمی‌آید.
quietHoursبدنهobject{ from, to } (HH:MM) بازهٔ سکوت؛ ممکن است از نیمه‌شب بگذرد.
variantsبدنهobject[]تا ۳ نسخه: { message, percent }؛ جمع درصدها ≤۹۹.
smsFallbackبدنهobject{ text } پیامک جایگزین (فقط اپ شخصی).

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

401unauthorizedکلید API نامعتبر یا منقضی است.
403insufficient_scopeکلید API دامنهٔ دسترسی لازم را ندارد.
400validation_errorورودی نامعتبر است (جزئیات در پاسخ).
404not_foundاپ پیدا نشد یا متعلق به شما نیست.
429rate_limitedتعداد درخواست از سقف مجاز بیشتر شد؛ پس از زمان Retry-After دوباره تلاش کنید.

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

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

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

curl -X POST 'https://api.irnoti.com/v1/sdk-apps/8/send' \
  -H "Authorization: Bearer $IRNOTI_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "target": {
    "segment": {
      "platform": "android",
      "activeWithinDays": 30
    }
  },
  "message": {
    "url": "https://shop.example.com/offer",
    "body": "تا فردا ۳۰٪ تخفیف",
    "title": "تخفیف ویژه"
  }
}'
پاسخ نمونه200 OK
{
  "status": "queued",
  "targeted": 1320,
  "messageId": "msg_901",
  "messageIds": [
    "msg_901"
  ]
}
ارسال پوش — مستندات API | ایران ناتیفیکیشن