ارسال گروهی با گزارش
ارسال گروهی پوش نوتیفیکیشن با ردیابی تحویل و کلیک — مناسب کمپینهای مهم که نیاز به تحلیل دارند.
POST
https://pushfa.com/api/webservices/send-group-message
کاربرد
وقتی لازم است وضعیت تحویل، کلیک و لیست گیرندگان کمپین را پیگیری کنید از این API استفاده کنید. از پنل پوشفا میتوانید گزارش کامل هر کمپین را مشاهده کنید.
پارامترهای ورودی
| پارامتر | مقدار | اجباری |
|---|---|---|
| fcm_tokens[] | آرایه توکنهای گیرندگان — در صورت استفاده از topic نباید ارسال شود | اجباری اگر topic وجود نداشته باشد |
| topic | شناسه تاپیک مقصد؛ برای ارسال به همه کاربران مقدار all را وارد کنید | اجباری اگر fcm_tokens وجود نداشته باشد |
| 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 ساعت) | خیر |
نمونه درخواست
curl -X POST https://pushfa.com/api/webservices/send-group-message \
-H "Content-Type: application/json" \
-d '{
"api_public_key": "YOUR_PUBLIC_KEY",
"api_private_key": "YOUR_PRIVATE_KEY",
"topic": "all",
"title": "عنوان کمپین",
"body": "متن کمپین",
"silent": false,
"collapse_id": "campaign_summer_sale",
"additional_data": { "campaign": "summer_sale" },
"get_delivery_status": true,
"get_click_status": true,
"sendTime": "current"
}'