فراز اس ام اس مستندات وب‌سرویس

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

Send Postal Code SMS — وب سرویس پیامک فراز اس ام اس

POST https://api.iranpayamak.com/ws/v1/sms/postal/send

احراز هویت

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

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

  • text (string) — الزامی
  • number_format (string) — الزامی
  • line_id (integer) — الزامی
  • 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.
  • filters (array) — الزامی

نمونه بدنه

{
  "filters": [
    {
      "postal_code": "12345",
      "gender_id": 1,
      "age_from": 1305,
      "age_to": 1310,
      "number_prefix": "912",
      "operator": "mci",
      "row_from": 0,
      "row_count": 50
    }
  ],
  "text": "message text",
  "line_id": 12,
  "number_format": "english",
  "schedule": "2026-04-01T10:00:00Z"
}

پاسخ‌ها

  • 401

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

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