خانه › ارسال پیامک

ارسال پیامک به بانک شماره — وب سرویس پیامک فراز اس ام اس

POST https://api.iranpayamak.com/ws/v1/sms/bank

کاربرد: ارسال هدفمند به «بانک شماره» (شماره‌های آماده بر اساس صنف/منطقه) بدون اینکه دفترتلفن داشته باشی.

احراز هویت

این سرویس به هدر Api-Key نیاز دارد — کلید را از پنل فراز اس ام اس بگیرید. نام هدر حساس به حروف بزرگ و کوچک است و کلید نباید در query string برود.

فیلدهای درخواست

text (string) — الزامی
recipients (array) — اختیاری
line_number (string) — الزامی
number_format (string) — الزامی
schedule (string) — اختیاری — Optional. Omit it or send null to send immediately. A future "YYYY-MM-DD HH:MM:SS" schedules the send — the message is accepted and its cost is reserved at submit time, and it is delivered at that moment, not now. A past date is rejected with a validation error.

نکات مهم این سرویس

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

نمونه بدنه

{
  "text": "test message",
  "recipients": [
    {
      "bank_id": 1,
      "limit": 50,
      "offset": 0
    },
    {
      "bank_id": 5,
      "limit": 100,
      "offset": 50
    }
  ],
  "line_number": "98123123",
  "number_format": "english",
  "schedule": "2026-03-20T10:00:00Z"
}

پاسخ‌ها

201 — SMS request is enqueued successfully.

سرویس‌های مرتبط در دستهٔ «ارسال پیامک»

همه‌ی وب‌سرویس‌های فراز اس ام اس · llms.txt · OpenAPI