آموزش API ارسال نوتیفیکیشن خصوصی
در مقاله قبل در مورد راهنمای وب سرویس پوش نوتیفیکیشن و وب سرویس ارسال گروهی پوش نوتیفیکیشن توضیح دادیم در این مقاله قصد داریم در مورد وب سرویس ارسال نوتیفیکیشن خصوصی صحبت کنیم.
ارسال به یک کاربر به خصوص (notifyUser)
در این متد (notifyUser) شما می‌توانید پوش‌نوتیفیکیشن به یک کاربر (userId) ارسال کنید.
ساختار درخواست
لینک پایه: https://sandbox.push.adpdigital.com/api/push/notifyUser
نمونه cURL:
curl -X POST \
“https://sandbox.push.adpdigital.com/api/push/notifyUser?access_token=<ACCESS_TOKEN>” \
-H “accept: application/json” \
-H “Content-Type: application/json” \
-d “@payload.json”
پارامترها
| پارامترها | توضیح | نوع مقدار | مثال |
| userId * | شناسه کاربری | string | userTest |
پارامترهای اعلان (Notification)
| پارامترها | توضیح | نوع مقدار | مثال |
| title * | عنوان اعلان | string | ثبت درخواست |
| body | متن اعلان | string | سفارش شما ثبت شد |
| groupId | برای گروه‌بندی شخصی اعلان‌ها | string | news |
| icon | تصویر اعلان | string | نام تصویر |
| sound | صدای اعلان (به فرمت صدا دقت داشته باشید) | string | نام صدا |
| clickUrl | لینک هنگام کلیک | string | لینک |
| ledColor | تنظیم رنگ led (فقط اندروید) | string | کد رنگ HEX |
| smallIcon | آیکون کوچک اعلان (فقط اندروید) | string | نام آیکون |
| (id (action | شناسه اکشن | string | check |
| (title (action | عنوان اکشن | string | status |
| (options (action | رفتار اکشن (فقط آی‌او‌اس) | number | 1 |
| (icon (action | نام آیکون در فولدر drawable (فقط اندروید) | string | نام آیکون |
| mediaType | نوع رسانه | string | jpeg |
| mediaUrl | لینک رسانه | string | لینک |
| contentAvailable | برای انجام یک آپدیت بی‌صدا در بک‌گراند یا فورگراند مقدار 1 را بگذارید | boolean | 1 |
| mutableContent | برای پشتیبانی از اعلان چندرسانه‌ای مقدار 1 را حتما قرار دهید | boolean | 1 |
| category | شناسه اعلان برای ذخیره آن | string | delivery |
نکته : نماد * در جدول پارامترها به معنی الزامی بودن پارامتر است و بدون آن درخواست شما صورت نمی‌گیرد.
نکته : در پارامترهای اعلان، پارامتر options یا همان رفتار اکشن (فقط در آی‌او‌اس) می‌توانید عدد ۱ برای اکشن Authentication Required (اکشن در صورت قفل نبودن دستگاه اجرا می‌شود)، ۲ برای اکشن Destructive (اکشن تسک مخرب انجام می‌دهد)، ۴ برای اکشن Foreground (اکشن موجب باز شدن اپ در فورگراند می‌شود) و جمع این اعداد را برای ترکیب آن‌ها با هم قرار دهید.
پاسخ
پاسخ درخواست‌های ارسال پیام به صورت تعداد دستگاه‌هایی که پیام به آن‌ها ارسال می‌شود، می‌باشد.
{
“count”: number
}
مثال
به مثال زیر از متد notifyUser توجه کنید:
درخواست
به عنوان مثال می‌خواهید یک پوش‌نوتیفیکیشن برای اعلام ثبت موفق سفارش به یک کاربر ارسال کنید.
curl -X POST \
“https://sandbox.push.adpdigital.com/api/push/notifyUser/989335******” \
-H “accept: application/json” \
-H “Content-Type: application/json” \
-d “{ \”title\”: \”ثبت موفق\”, \”body\”: \”سفارش شما با موفقیت ثبت شد.\”}”
پاسخ
درخواست شما با موفقیت انجام شد و کمپین شما به ۲ دستگاه (count : 2) ارسال شد.
{
“count”: 2
}
پس از ارسال موفقیت آمیز می‌توانید در پنل بخش پیام‌ها آمار ارسال و تحویلتان را مشاهده کنید.
نکته : برای تست کردن این عمل می‌توانید به این لینک مراجعه کنید.