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

خانه › مدیریت پترن

ساخت پترن جدید — وب سرویس پیامک فراز اس ام اس

POST https://api.iranpayamak.com/ws/v1/patterns

کاربرد: ساخت پترن (قالب) جدید با متغیر؛ پیش‌نیازِ ارسال پترن. پس از ساخت باید تأیید شود.

Create a new pattern with API

احراز هویت

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

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

  • text (string) — الزامی
  • description (string) — الزامی — nullable
  • share (integer) — الزامی — boolean
  • website (string) — الزامی
  • category (integer) — الزامی — 1 = otp, 2 = club, 3 = order, 255 = others
  • vars (array) — الزامی

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

  • پترن جدید را اینجا بساز. متغیرها را در vars تعریف و در text با %name% بگذار.
  • پس از ساخت، پترن باید تأیید شود تا قابل ارسال شود.

نمونه بدنه

{
  "text": "test text %var%, %var2%",
  "description": "test desc",
  "share": 1,
  "website": "example.com",
  "category": 1,
  "vars": [
    {
      "var": "var",
      "length": 12,
      "type": "int"
    },
    {
      "var": "var2",
      "length": 12,
      "type": "int"
    }
  ]
}

پاسخ‌ها

  • 201 — Pattern created successfully.

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

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