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

خانه › دفترتلفن و مخاطبین

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

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

کاربرد: افزودن یک مخاطبِ تکی به دفترتلفن.

احراز هویت

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

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

  • phone_book_id (integer) — الزامی
  • phone_book_data_id (integer) — اختیاری
  • prefix (string) — اختیاری
  • mobile (string) — الزامی
  • name (string) — اختیاری
  • attributes (array) — اختیاری

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

  • یک مخاطب جدید به دفترتلفن اضافه می‌کند.

نمونه بدنه

{
  "phone_book_id": 33,
  "phone_book_data_id": 1,
  "prefix": "man",
  "mobile": "09123456781",
  "name": "test name",
  "attributes": [
    {
      "attribute_id": 5,
      "value": "1378/01/24"
    },
    {
      "attribute_id": 8,
      "value": "Tehran"
    }
  ]
}

پاسخ‌ها

  • 200 — Success

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

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