داده‌پردازان ارتباطات صدرا

پنل کاربری

5 - مدیریت پیام‌های زمان‌بندی‌شده

دریافت لیست پیام‌های زمان‌بندی‌شده

دریافت لیست پیام‌هایی که برای ارسال در آینده برنامه‌ریزی شده‌اند.

آدرس:/panel/webservice/scheduledList

متد:GET

فراخوانی درخواست:

هدر:

نمونه	توضیحات	نوع	نام پارامتر
Basic c21zUGFuZWxDbGdcaW52AC	توکن دریافتی در لاگین	اجباری	Authorization

نمونه درخواست:

آدرس:https://www.Address.com/panel/webservice/scheduledList

توضیحات:

توضیحات	نوع	نوع	نام پارامتر
شناسه سرور	اختیاری	String	serverId*
شناسه مشتری	اختیاری	String	customerId*
تاریخ شروع (فرمت yyyy-MM-dd HH:mm:ss)	اختیاری	String	from*
تاریخ پایان (فرمت yyyy-MM-dd HH:mm:ss)	اختیاری	String	to*
شماره صفحه (شروع از 0)	اختیاری	Long	page
تعداد رکوردها در هر صفحه(پیشفرض 10)	اختیاری	Long	size

دریافت پاسخ:

بدنه:

{
   "totalItem": TOTAL_ITEM,
   "totalPages": TOTAL_PAGES,
   "currentPage": CURRENT_PAGE,
   "scheduledMessages": [
      {
         "serverId": "SERVER_ID",
         "customerId": "CUSTOMER_ID",
         "sendDate": "SEND_DATE",
         "recipient": "RECIPIENT",
         "message": "MESSAGE",
         "totalPrice": TOTAL_PRICE,
         "parts": PARTS
      }	
   ]
}

توضیحات:

نمونه	نوع	نام پارامتر
تعداد کل رکوردها	Long	totalItem
تعداد کل صفحات	Long	totalPages
شماره صفحه کنونی	Long	currentPage
شناسه سرور	String	serverId
شناسه مشتری	String	customerId
زمان ارسال(فرمت yyyy-MM-dd HH:mm:ss)	String	sendDate
شماره گیرنده	String	recipient
متن پیام	String	message
هزینه پیام	Long	totalPrice
تعداد پارت پیام	Long	parts

نکات:

فرستادن یکی از مقادیر from، to، customerId و یا serverId در فراخوانی این متد اجباری است.

لغو پیام زمان‌بندی‌شده

لغو پیام‌های زمان‌بندی‌شده قبل از ارسال.

آدرس:panel/webservice/cancelScheduled

متد:POST

فراخوانی درخواست:

هدر:

نمونه	توضیحات	نوع	نام پارامتر
Basic c21zUGFuZWxDbGdcaW52AC	توکن دریافتی در لاگین	اجباری	Authorization

نمونه درخواست:

{
  "serverId": "SERVER_ID",
  "cancelMessage": "CANCEL_MESSAGE"
}

توضیحات:

توضیحات	نوع	نوع	نام پارامتر
شناسه سرور	اجباری	String	serverId
دلیل لغو	اختیاری	String	cancelMessage*

دریافت پاسخ:

بدنه:

{
   "serverId": "SERVER_ID",
   "recipient": "RECIPIENT",
   "status": STATUS
}

توضیحات:

نمونه	نوع	نام پارامتر
شناسه سرور	String	serverId
شماره گیرنده	String	recipient
وضعیت درخواست	Boolean	status