ارسال با شناسه سفارشی (شناسه سفارشی (Custom Alias))

کاربرد

اگر با addAlias مشترکین را برچسب‌گذاری کرده‌اید، می‌توانید پیام را به همه مشترکینی که برچسب label برابر یکی از مقادیر values داشته باشند بفرستید. به‌شکل هوشمندانه، پیام فقط به بهترین دستگاه این شناسه ارسال می‌شود؛ بنابراین پیام تنها به یک دستگاه خواهد رسید.

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

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

curl -X POST https://pushfa.com/api/webservices/send-via-alias \
  -H "Content-Type: application/json" \
  -d '{
    "api_public_key": "YOUR_PUBLIC_KEY",
    "api_private_key": "YOUR_PRIVATE_KEY",
    "label": "crm_id",
    "values": ["CRM-123", "CRM-456"],
    "smart_targeting": true,
    "title": "پیام برای مشتریان خاص",
    "body": "{name:کاربر} عزیز، سفارش {custom_alias:order_id:شما} آماده است.",
    "use_brackets": true,
    "send_time": "current"
  }'

شرط اختیاری آخرین بازدید (last_visit)

با پارامتر اختیاری last_visit پیام فقط برای مخاطبانی ارسال می‌شود که روز آخرین بازدیدشان از سایت یا اپ (به وقت تهران) با شرط شما بخواند. نمونه زیر فقط برای کسانی ارسال می‌شود که امروز بازدید داشته‌اند. شرط برای هر دستگاه جداگانه بررسی می‌شود و مقدارهایی از values که هیچ دستگاه واجد شرطی ندارند، با کد LAST_VISIT_CONDITION_NOT_MET در rejected_recipients برمی‌گردند. smart_targeting بهترین دستگاه را از میان دستگاه‌های واجد شرط انتخاب می‌کند و با only_last_device شرط روی همان آخرین دستگاه بررسی می‌شود.

{
  "api_public_key": "YOUR_PUBLIC_KEY",
  "api_private_key": "YOUR_PRIVATE_KEY",
  "label": "crm_id",
  "values": ["CRM-123", "CRM-456"],
  "title": "پیشنهاد امروز",
  "body": "ویژه کاربرانی که امروز به ما سر زده‌اند",
  "last_visit": { "operator": ">=", "date": "today" },
  "send_time": "current"
}

خطاها و کدهای پاسخ

خطاهای عمومی مانند INVALID_API_KEYS، VALIDATION_ERROR و INSUFFICIENT_BALANCE در همه وب‌سرویس‌های ارسال مشترک‌اند. مقدارهایی از values که مشترکی ندارند یا مشترک فعال ندارند، با CUSTOM_ALIAS_NOT_FOUND یا NO_ACTIVE_PUSH_SUBSCRIPTION در data.rejected_recipients برمی‌گردند و اگر هیچ مقداری قابل ارسال نباشد، درخواست با کد مشترک مقدارها یا NO_VALID_RECIPIENTS رد می‌شود. اگر هیچ دستگاهی با فیلترها مطابقت نداشته باشد یا همه به سقف ارسال رسیده باشند، کل درخواست با NO_MATCHING_DEVICE یا FREQUENCY_CAP_REACHED رد می‌شود. اگر only_last_device را بدون smart_targeting بفرستید و ثبت آخرین بازدید سرویس خاموش باشد، خطای LAST_VISIT_TRACKING_DISABLED برمی‌گردد. اگر شرط اختیاری last_visit را بفرستید، LAST_VISIT_TRACKING_DISABLED و LAST_VISIT_CONDITION_NOT_MET هم ممکن است برگردند. معنی هر کد و اینکه چه زمانی باید توکن یا شناسه را حذف کنید در صفحه خطاها آمده است.