خدمات و سرویس‌ها

ارسال پیام

با استفاده از متد Sms/Send در وب‌سرویس پیامک systempanel.ir، می‌توانید پیامک‌ها را به صورت تکی یا گروهی و مطابق استاندارد REST ارسال کنید. هر درخواست قادر است پیام‌ها را به حداکثر 100 گیرنده برساند و پاسخ سرویس شامل داده‌های سیستمی و وضعیت موفقیت عملیات خواهد بود.

متد Sms/Send به‌صورت نظیر به نظیر (one-to-one) فراخوانی می‌شود و به شما امکان می‌دهد متن و شماره فرستنده اختصاصی را برای هر گیرنده مشخص نمایید.

آدرس وب سرویس :

HTTP
https://api.systempanel.ir/sms/send

متد Sms/Send در وب‌سرویس systempanel.ir امکان ارسال پیامک به صورت فردی یا گروهی با جزئیات اختصاصی برای هر گیرنده را فراهم می‌کند.

پارامترهای ورودی

پارامترهای ورودی ( Request Body )
این متد یک آرایه از اشیاء را می‌پذیرد. هر شیء در این آرایه نشان‌دهنده یک پیام مجزا است.

پارامترنوع دادهاجباریتوضیحاتمثال
senderStringشماره فرستنده90002009
receiverStringشماره گیرنده09123456789
messageStringمتن پیاممتن آزمایشی

در نظر داشته باشید در صورتی که بدنه درخواست شامل تنها یک پیام باشد, پیام با اولیت بالاتری ارسال خواهد شد.

نمونه بدنه پارامترهای ورودی درخواست ارسال پیامک به صورت تکی

JSON
[
  {
    "sender": "90002009", 
    "receiver": "09123456789", 
    "message": "متن آزمایشی اول"
  }
]

نمونه بدنه پارامترهای ورودی درخواست ارسال پیام به صورت گروهی

JSON
[
  {
    "sender": "90002009", 
    "receiver": "09123456700", 
    "message": "متن آزمایشی اول"
  },
  {
    "sender": "50003004", 
    "receiver": "09123456701", 
    "message": "متن آزمایشی دوم"
  },
  {
    "sender": "10009090", 
    "receiver": "09123456702", 
    "message": "متن آزمایشی سوم"
  },
  {
    "sender": "90002009", 
    "receiver": "09123456703", 
    "message": "متن آزمایشی چهارم"
  }
]

پارامترهای خروجی

بدنه اصلی پاسخ ( Root Object )
این جدول پارامترهای سطح اول خروجی را نشان می‌دهد.

پارامترنوع دادهتوضیحات
statusIntegerکد وضعیت درخواست
messageStringمتن وضعیت درخواست
dataObjectشامل پاسخ داده و پارامترهای ورودی می‌باشد

جزئیات داده‌ها ( Data Object )
این بخش خلاصه‌ای از وضعیت کل درخواست ( هزینه درخواست, مجموع پیام‌ها, تعداد پیام‌های موفق, ناموفق و … ) را ارائه می‌دهد.

پارامترنوع دادهتوضیحات
costIntegerهزینه کل کسر شده برای این درخواست
totalIntegerتعداد کل رکوردهای ارسالی در این درخواست
failedIntegerتعداد پیام‌هایی که با خطا مواجه شده‌اند
successIntegerتعداد پیام‌هایی که با موفقیت ارسال شده‌اند
entriesObjectشامل لیست تفکیک شده پیام‌های موفق و ناموفق

بررسی ورودی‌ها ( Entries Object )
در این بخش، خروجی به دو آرایه اصلی تقسیم می‌شود.

پارامترنوع دادهتوضیحات
successObjectلیستی از اشیاء (Objects) مربوط به پیام‌های موفق
failedObjectلیستی از اشیاء (Objects) مربوط به پیام‌های ناموفق

جزئیات هر پیام ( Message Object )
این پارامترها در داخل آرایه‌ی success یا failed قرار دارند و جزئیات دقیق هر پیام را نمایش می‌دهند.

پارامترنوع دادهتوضیحات
indexIntegerشماره ردیف پیام در لیست ارسالی ( شروع از 0 )
statusIntegerکد وضعیت اختصاصی برای این ردیف / پیام
status_messageStringشرح وضعیت اختصاصی برای این ردیف / پیام
senderStringشماره فرستنده پیام
sender_providerStringاپراتور ارسال کننده پیام
receiverStringشماره گیرنده پیام
receiver_operatorStringاپراتور گیرنده پیام
message_idStringشناسه منحصربه‌فرد پیام در سامانه ( برای پیگیری‌های بعدی )
message_typeStringنوع پیام ( برای پیام‌های فارسی fa و انگلیسی en )
message_partIntegerتعداد پارت پیام
message_lengthIntegerتعداد کاراکترهای متن پیام
message_costIntegerهزینه ارسال این پیام
messageStringمتن پیام

نمونه بدنه خروجی درخواست ( شامل پیام موفق و ناموفق )

JSON
{
  "status": 200,
  "message": "عملیات با موفقیت انجام شد",
  "data": {
    "cost": 3600,
    "total": 4,
    "failed": 2,
    "success": 2,
    "entries": {
      "success": [
        {
          "index": 0,
          "status": 200,
          "status_message": "عملیات با موفقیت انجام شد",
          "sender": "7123456789",
          "sender_provider": "telecom",
          "receiver": "09123456001",
          "receiver_operator": "mci",
          "message_id": "126856725354614784",
          "message_type": "fa",
          "message_part": 1,
          "message_length": 21,
          "message_cost": 1800,
          "message": "متن ازمایشی اول لغو11"
        },
        {
          "index": 1,
          "status": 200,
          "status_message": "عملیات با موفقیت انجام شد",
          "sender": "7123456789",
          "sender_provider": "telecom",
          "receiver": "09301234567",
          "receiver_operator": "irancel",
          "message_id": "126856725358809088",
          "message_type": "fa",
          "message_part": 1,
          "message_length": 21,
          "message_cost": 1800,
          "message": "متن ازمایشی دوم لغو11"
        }
      ],
      "failed": [
        {
          "status": 1015,
          "status_message": "شماره فرستنده به این کلید API اختصاص داده نشده است",
          "sender": "90002009",
          "receiver": "09123456003",
          "message": "متن ازمایشی سوم لغو11",
          "index": 2
        },
        {
          "status": 1016,
          "status_message": "درچ عبارت لغو11 در متن پیام الزامیست",
          "sender": "7143452846",
          "receiver": "09123456004",
          "message": "متن ازمایشی چهارم",
          "index": 3
        }
      ]
    }
  }
}

نویسنده
admin
Modification