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

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

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

POST
https://pushfa.com/api/webservices/send-single-message
دانلود کالکشن Postman وب‌سرویس‌ها

کاربرد

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

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

پارامتر مقدار اجباری
fcm_token توکن گیرنده پیام بله
api_public_key شناسه عمومی سرویس بله
api_private_key شناسه خصوصی سرویس بله
title عنوان پوش نوتیفیکیشن بله
body توضیحات پوش نوتیفیکیشن بله
link_url لینک اصلی پوش نوتیفیکیشن خیر
image_url آدرس تصویر ضمیمه پوش نوتیفیکیشن خیر
btn_left[title] عنوان دکمه سمت چپ اجباری در صورت مقدار داشتن پارامترهای دکمه چپ
btn_left[url] لینک دکمه سمت چپ اجباری در صورت مقدار داشتن پارامترهای دکمه چپ
btn_right[title] عنوان دکمه سمت راست اجباری در صورت مقدار داشتن پارامترهای دکمه راست
btn_right[url] لینک دکمه سمت راست اجباری در صورت مقدار داشتن پارامترهای دکمه راست
get_delivery_status درخواست گزارش تحویل. در ارسال تکی مقدار 1/0 و در ارسال گروهی گزارش‌دار مقدار true/false پذیرفته می‌شود خیر
webhook_url سرویس بومرنگ: اگر گزارش تحویل را درخواست داده باشید، در صورت عدم تحویل نوتیفیکیشن، نتیجه به این آدرس ارسال می‌شود خیر
get_click_status درخواست گزارش کلیک روی پیام. در ارسال تکی مقدار 1/0 و در ارسال گروهی گزارش‌دار مقدار true/false پذیرفته می‌شود خیر
sendTime اگر پیام باید اکنون ارسال شود مقدار current و اگر زمان‌بندی شده است مقدار delay وارد شود بله
time اگر sendTime برابر delay باشد زمان ارسال را با فرمت Y-m-d H:i وارد کنید بله اگر sendTime برابر delay باشد
ttl عمر نوتیفیکیشن به ثانیه. در برخی وب‌سرویس‌ها در صورت عدم ورود، پیش‌فرض 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",
    "sendTime": "current"
  }'

لینک‌های مرتبط