پوشفا

ارسال با شناسه مستعار (Alias)

ارسال نوتیفیکیشن به کاربران از طریق Alias ثبت‌شده بدون نیاز به مدیریت مستقیم توکن‌ها.

POST
https://pushfa.com/api/webservices/send-via-user-alias-id
دانلود کالکشن Postman

کاربرد

وقتی با setUserAliasID شناسه کاربر را در پوشفا ثبت کرده‌اید، می‌توانید به جای توکن از همان شناسه برای ارسال استفاده کنید. به همه دستگاه‌های کاربر پیام می‌رسد.

پارامترهای ورودی

پارامترمقداراجباری
alias شناسه مستعار کاربر (مقدار ثبت‌شده با setUserAliasID) بله
only_last_device اگر true باشد، فقط به آخرین دستگاهی که کاربر از آن استفاده کرده ارسال می‌شود. اولویت‌بندی بر اساس visit_at و در صورت برابری، updated_at (جدیدتر = برتر). پیش‌فرض: false خیر
device محدودیت دستگاه: mobile | desktop | all خیر
api_public_key کلید عمومی سرویس پوشفا بله
api_private_key کلید خصوصی سرویس پوشفا بله
title عنوان پوش نوتیفیکیشن بله
body متن اصلی پوش نوتیفیکیشن بله
link_url لینک مقصد پس از کلیک روی نوتیفیکیشن (مثال: https://example.com) خیر
image_url آدرس تصویر ضمیمه نوتیفیکیشن خیر
btn_left[title] عنوان دکمه سمت چپ اجباری اگر دکمه چپ تعریف شود
btn_left[url] لینک دکمه سمت چپ (مثال: https://example.com) اجباری اگر دکمه چپ تعریف شود
btn_right[title] عنوان دکمه سمت راست اجباری اگر دکمه راست تعریف شود
btn_right[url] لینک دکمه سمت راست (مثال: https://example.com) اجباری اگر دکمه راست تعریف شود
silentپوش بی‌صدا boolean — اگر true باشد نوتیفیکیشن بدون صدا و بدون لرزش نمایش داده می‌شود. خود اعلان همچنان نمایش داده می‌شود. خیر
collapse_idCollapse IDPro Collapse ID — رشته متنی حداکثر ۱۰۰ کاراکتر برای جایگزینی اعلان قبلی با اعلان جدید دارای همان شناسه. خیر - فقط Pro
additional_dataAdditional DataPro Additional Data (JSON) — شیء JSON دلخواه که همراه پیام ارسال می‌شود و در SDK/Service Worker قابل خواندن است. خیر - فقط Pro
get_delivery_status درخواست گزارش تحویل (مقدار 1/0 در ارسال تکی یا true/false در ارسال گروهی) خیر
webhook_url آدرس وب‌هوک بومرنگ — در صورت عدم تحویل، نتیجه به این آدرس ارسال می‌شود خیر
get_click_status درخواست گزارش کلیک (مقدار 1/0 در ارسال تکی یا true/false در ارسال گروهی) خیر
sendTime زمان ارسال؛ مقدار current برای ارسال فوری و delay برای زمان‌بندی‌شده بله
time زمان ارسال با فرمت Y-m-d H:i — فقط اگر sendTime برابر delay باشد اجباری اگر sendTime = delay
ttl عمر نوتیفیکیشن به ثانیه (پیش‌فرض 86400 = 24 ساعت) خیر