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

ارسال پیامک با متغیر (شخصی‌سازی‌شده) — وب سرویس پیامک فراز اس ام اس

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

کاربرد: ارسال انبوهِ شخصی‌سازی‌شده؛ متغیرها (مثل نام مخاطب) داخل `%...%` در متن جای می‌گیرند.

Send a message containing variable keywords. The keywords (attributes) must be wrapped inside % signs within the text (E.g: Hello %first_name%)

احراز هویت

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

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

text (string) — الزامی
line_number (string) — الزامی
recipients (array) — الزامی
number_format (string) — اختیاری

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

متغیرها را داخل علامت % در متن بگذار (مثلاً سلام %first_name%).
مقدار متغیرها از ویژگی‌های مخاطبین/دفترتلفن پر می‌شود.
بدون +۹۸؛ number_format را درست بده.

نمونه بدنه

{
  "text": "test %var1% text",
  "line_number": "50002178584000",
  "recipients": [
    {
      "mobile": "09120000000",
      "var1": "value1"
    },
    {
      "mobile": "09130000000",
      "var1": "value2"
    }
  ],
  "number_format": "english"
}

پاسخ‌ها

201 — SMS request is enqueued successfully.

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

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