مستندات پوشفا

ارسال تکی پوش نوتیفیکیشن

ارسال پوش نوتیفیکیشن به یک توکن مشخص با امکان دریافت گزارش تحویل، گزارش کلیک و دکمه‌های عملیاتی.

POST
https://pushfa.com/api/webservices/send-single-message
📥 دانلود کالکشن Postman

کاربرد

برای ارسال نوتیفیکیشن به یک کاربر خاص با توکن مشخص استفاده کنید. امکان درخواست گزارش تحویل، گزارش کلیک و تعریف دکمه‌های عملیاتی وجود دارد.

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

پارامتر مقدار اجباری
fcm_token توکن FCM گیرنده نوتیفیکیشن بله
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_id Collapse ID Pro Collapse ID — رشته متنی حداکثر ۱۰۰ کاراکتر برای جایگزینی اعلان قبلی با اعلان جدید دارای همان شناسه. خیر - فقط Pro
additional_data Additional Data (JSON) Pro 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 ساعت) خیر

نمونه درخواست

curl -X POST https://pushfa.com/api/webservices/send-single-message \
  -H "Content-Type: application/json" \
  -d '{
    "fcm_token": "USER_FCM_TOKEN",
    "api_public_key": "YOUR_PUBLIC_KEY",
    "api_private_key": "YOUR_PRIVATE_KEY",
    "title": "عنوان نوتیفیکیشن",
    "body": "متن نوتیفیکیشن",
    "link_url": "https://example.com",
    "silent": true,
    "collapse_id": "order_42",
    "additional_data": { "order_id": 42, "type": "order_update" },
    "sendTime": "current"
  }'

ساختار پاسخ موفق

{
  "status": "success",
  "data": {
    "notification_id": "uuid-of-message-receptor"
  }
}