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

ارسال به شماره‌های بانک

پیام را برای `count` شمارهٔ فیلترشده از بانک می‌فرستد؛ کارمزد بانک و هزینهٔ پیامک با هم کسر می‌شود.

POSThttps://api.irnoti.com/v1/number-banks/send
scope: sms.send

اگر ارسال پس از کسر کارمزد ردّ شود، کارمزد بازگردانده می‌شود. گیرندگان فهرست مسدودی/لغو عضویت حذف می‌شوند. نیاز به احراز هویت کامل. **فیلدهای پاسخ:** batchId، count، smsPrice و fee (ریال، رشته) و replayed.

پارامترها

ناممحلنوعتوضیح
bankId *بدنهstringشناسهٔ بانک.
count *بدنهintegerتعداد شمارهٔ هدف.
filtersبدنهobject{ operator?: mci|irancell|rightel|other, province?, city?, tag? }؛ همهٔ شروط با هم اعمال می‌شود.
lineId *بدنهstringخط فرستنده.
text *بدنهstringمتن پیام.
Idempotency-Keyهدرstringکلید یکتا (حداکثر ۱۰۰ نویسه). ارسال دوباره با همان کلید، کار تکراری نمی‌سازد و نتیجهٔ قبلی را برمی‌گرداند.

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

401unauthorizedکلید API نامعتبر یا منقضی است.
403insufficient_scopeکلید API دامنهٔ دسترسی لازم را ندارد.
400validation_errorورودی نامعتبر است (جزئیات در پاسخ).
402insufficient_balanceاعتبار کافی نیست.
404not_foundبانک پیدا نشد یا متعلق به شما نیست.

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

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

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

curl -X POST 'https://api.irnoti.com/v1/number-banks/send' \
  -H "Authorization: Bearer $IRNOTI_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: nb-77' \
  -d '{
  "text": "سلام، تخفیف ویژه!",
  "count": 1000,
  "bankId": "3",
  "lineId": "1",
  "filters": {
    "operator": "mci"
  }
}'
پاسخ نمونه200 OK
{
  "fee": "20000",
  "count": 1000,
  "batchId": "940",
  "replayed": false,
  "smsPrice": "980000"
}
ارسال به شماره‌های بانک — مستندات API | ایران ناتیفیکیشن