ایران ناتیفیکیشن

ارسال با لینک کوتاه ردیابی‌شده

پیامک حاوی لینک کوتاه یکتا برای هر گیرنده؛ کلیک‌ها شمارش می‌شود و می‌توانید آزمون A/B بگیرید.

POSThttps://api.irnoti.com/v1/link-tracker/send
scope: sms.send

متن باید جای لینک را با {link} نشان دهد. برای هر گیرنده یک کد ۸ نویسه‌ای ساخته می‌شود و https://…/l/{code} پس از ثبت کلیک به url هدایت می‌کند. **آزمون A/B:** تا دو نسخهٔ دیگر در variants بدهید. بخشی از مخاطبان (holdoutPercent، ۱۰ تا ۷۰) نگه داشته می‌شود؛ پس از decideAfterMinutes (۱۵ تا ۱۰٬۰۸۰ دقیقه) نسخه‌ای که کلیک بیشتری گرفته برای بقیه ارسال می‌شود. با POST /link-tracker/holdouts/{id}/send-now می‌توانید زودتر تصمیم بگیرید. نیاز به احراز هویت کامل حساب و امکان «لینک‌ساز» در گروه کاربری شما دارد. سقف ۶۰ درخواست در دقیقه.

پارامترها

ناممحلنوعتوضیح
lineId *بدنهstringشناسهٔ خط فرستنده.
text *بدنهstringمتن پیام (حداکثر ۹۰۰ نویسه) با {link}.
url *بدنهstringنشانی مقصد (http/https، حداکثر ۵۰۰ نویسه).
variantsبدنهstring[]تا ۲ نسخهٔ دیگرِ متن برای آزمون A/B.
holdoutPercentبدنهintegerدرصد مخاطبانِ نگه‌داشته برای ارسال برندهٔ آزمون (۱۰ تا ۷۰).
decideAfterMinutesبدنهintegerپس از چند دقیقه برنده تعیین شود (۱۵ تا ۱۰٬۰۸۰).
toبدنهstring[]شماره‌های گیرنده (حداکثر ۱۰٬۰۰۰).
groupIdsبدنهstring[]گروه‌های دفترچه تلفن. حداقل یکی از to یا groupIds الزامی است.

خطاهای خاص این endpoint

401unauthorizedکلید API نامعتبر یا منقضی است.
403insufficient_scopeکلید API دامنهٔ دسترسی لازم را ندارد.
400validation_errorورودی نامعتبر است (جزئیات در پاسخ).
402insufficient_balanceاعتبار کافی نیست.
403feature_lockedامکان لینک‌ساز برای گروه کاربری شما فعال نیست یا احراز هویت کامل نشده است.
429rate_limitedتعداد درخواست از سقف مجاز بیشتر شد؛ پس از زمان Retry-After دوباره تلاش کنید.

اجرای زنده (محیط تست)

باز کردن در کنسول کامل ←

این endpoint در محیط تست پشتیبانی نمی‌شود؛ برای اجرا، کلید واقعی را در حالت «اجرای واقعی» وارد کنید.

curl -X POST 'https://api.irnoti.com/v1/link-tracker/send' \
  -H "Authorization: Bearer $IRNOTI_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "to": [
    "09121234567"
  ],
  "url": "https://shop.example.com/offer",
  "text": "تخفیف ویژه: {link}",
  "lineId": "1",
  "variants": [
    "فقط امروز! {link}"
  ],
  "holdoutPercent": 30,
  "decideAfterMinutes": 120
}'
پاسخ نمونه200 OK
{
  "count": 1,
  "batchId": "930",
  "holdout": 0,
  "totalPrice": "980"
}
ارسال با لینک کوتاه ردیابی‌شده — مستندات API | ایران ناتیفیکیشن