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

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

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

PUT https://api.iranpayamak.com/ws/v1/patterns/{code}

کاربرد: ویرایش متن یا متغیرهای یک پترن موجود (ممکن است نیاز به تأیید مجدد داشته باشد).

احراز هویت

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

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

  • text (string) — الزامی
  • description (string) — اختیاری
  • shared (boolean) — الزامی
  • website (string) — الزامی
  • attributes (array) — اختیاری

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

  • ویرایش یک پترن موجود با code. ویرایش ممکن است نیاز به تأیید مجدد داشته باشد.

نمونه بدنه

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

پاسخ‌ها

  • 201 — Pattern created successfully.

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

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