وب سرویس(اتصال به سایت و اپلیکیشن)

نمونه کد و پلاگین ها

• 
  مستندات وب سرویس

• 
  GetCredit

  این متد برای دریافت میزان اعتبارکاربر بکارمی رود

  پارامتر های ورودی
  نام پارامتر	نوع پارامتر	توضیحات
  userName	string	نام کاربری مربوط به حساب شما در سامانه
  password	string	رمز عبور مربوط به حساب شما در سامانه
  مقدار بازگشتی
  	decimal	میزان اعتبار کاربر به پیامک می باشد مقدار اعتبار صفر یا عددی برزگتر از صفر می باشد در غیر اینصورت : 1 - : نام کاربری و رمز عبور صحیح نمی باشد 2 - : کاربر غیرفعال می باشد

  GetInboxCount

  این متد جهت دریافت تعداد پیامهای دریافتی بکارمی رود

  پارامتر های ورودی
  نام پارامتر	نوع پارامتر	توضیحات
  userName	string	نام کاربری مربوط به حساب شما در سامانه
  password	string	رمز عبور مربوط به حساب شما در سامانه
  isRead	bool	مقدار true برای پیامهای خوانده شده مقدار false برای پیامهای خوانده نشده
  مقدار بازگشتی
  	int	اگر نام کاربری و رمز عبور صحیح باشد مقدار برگشتی یک عدد می باشد که بر اساس پارامتر isRead بیانگر تعداد پیامها دریافتی می باشد 1 - : نام کاربری و رمز عبور صحیح نمی باشد

  SendSMS

  از این متد جهت ارسال پیامک به یک تا حداکثر 100 شماره بکارمی رود

  پارامتر های ورودی
  نام پارامتر	نوع پارامتر	توضیحات
  userName	string	نام کاربری مربوط به حساب شما در سامانه
  password	string	رمز عبور مربوط به حساب شما در سامانه
  fromNumber	string	شماره فرستنده
  toNumbers	[] string	آرایه ای از شماره موبایل های گیرندگان می باشد حداکثر 100 شماره در هر بار فراخوانی
  messageContent	string	متن پیامک
  isFlash	bool	تعیین میکند آیا پیامک به صورت فلش ارسال گردد یا خیر
  ref recId	[] int	هر خانه آرایه یک عدد یکتا به ازای هر گیرنده تولید می کند، این کد یکتا برای دریافت وضعیت تحویل کاربر دارد
  ref status	[] byte	هر خانه آرایه عدد 0 یا 1 بوده به ازای هر گیرنده تولید می شود، 1 به معنی ارسال شده و 0 ارسال نشده
  مقدار بازگشتی
  	int	0 : ارسال با موفقیت انجام شد 1 : نام کاربر یا کلمه عبور نامعتبر می باشد 2 : کاربر مسدود شده است 3 : شماره فرستنده نامعتبر است 4 :محدودیت در ارسال روزانه 5 : تعداد گیرندگان حداکثر 100 شماره می باشد 6 : خط فرسنتده غیرفعال است 7 : متن پیامک شامل کلمات فیلتر شده است 8 : اعتبار کافی نیست 9 : سامانه در حال بروز رسانی می باشد 10 : وب سرویس غیرفعال است

  SendBatchSms

  از این متد جهت ارسال پیامک به یک تا حداکثر 100 شماره به کار می رود.

  پارامتر های ورودی
  نام پارامتر	نوع پارامتر	توضیحات
  userName	string	نام کاربری مربوط به حساب شما در سامانه
  password	string	رمز عبور مربوط به حساب شما در سامانه
  fromNumber	string	شماره فرستنده
  toNumbers	[] string	آرایه ای از شماره موبایل های گیرندگان می باشد حداکثر 100 شماره در هر بار فراخوانی
  messageContent	string	متن پیامک
  isFlash	bool	تعیین میکند آیاپیامک بصورت فلش ارسال گردد یا خیر
  out batchSmsId	int	شناسه ارسال گروهی
  مقدار بازگشتی
  	int	0 : ارسال با موفقیت انجام شد 1 : نام کاربر یا کلمه عبور نامعتبر می باشد 2 : کاربر مسدود شده است 3 : شماره فرستنده نامعتبر است 4 :محدودیت در ارسال روزانه 5 : تعداد گیرندگان حداکثر 100 شماره می باشد 6 : خط فرسنتده غیرفعال است 7 : متن پیامک شامل کلمات فیلتر شده است 8 : اعتبار کافی نیست 9 : سامانه در حال بروز رسانی می باشد 10 : وب سرویس غیرفعال است

  GetBatchDelivery

  از این متد جهت دریافت وضعیت تحویل پیامک ارسال شده بکار می رود که با متد SendBatchSms ارسال انجام شده است

  پارامتر های ورودی
  نام پارامتر	نوع پارامتر	توضیحات
  userName	string	نام کاربری مربوط به حساب شما در سامانه
  password	string	رمز عبور مربوط به حساب شما در سامانه
  batchSmsId	int	شناسه ارسال با متد SendBatchSms
  numbers	[] string	آرایه ای از شماره موبایل های گیرندگان می باشد
  deliveryStatus	[] int	آرایه ی از وضعیت تحویل متناظر با آرایه شماره موبایل ها می باشد ترجمه مقدار وضعیت تحویل: 5 - : برای گرفتن گزارش تحویل حداقل یک دقیقه بعد از ارسال اقدام نمایید 4 - : به علت اینکه پیام در صف ارسال مخابرات می باشد، امکان گرفتن گزارش تحویل وجود ندارد 3 - : به علت اینکه مهلت یک هفته ای گرفتن گزارش پایان یافته است، امکان گرفتن گزارش تحویل وجود ندارد 2 - : پیام با این کد وجود ندارد (batchSmsId نامعتبر است) 1 - : خطا در ارتباط با سرویس دهنده 0 : ارسال شده به مخابرات 1 : رسیده به گوشی 2 : نرسیده به گوشی 3 : خطای مخابراتی 4 : خطای نامشخص 5 : رسیده به مخابرات 6 : نرسیده به مخابرات 7 : مسدود شده توسط مقصد 8 : نامشخص 9 : مخابرات پیام را مردود اعلام کرد 1 : کنسل شده توسط اپراتور 11 : ارسال نشده
  index	int	اندیس مربوط به ردیف پیام ارسالی، توجه مقدار اندیس از 1 شروع می شود.
  count	int	تعداد رکورد درخواستی، حداکثر 100
  مقدار بازگشتی
  	int	1 - : نام کاربری و رمز عبور صحیح نمی باشد 2 - : ارسال با مقدار شناسه batchSmsId وجود ندارد

  GetMessages

  از این متد جهت دریافت پیامک های دریافتی یا ارسالی استفاده می شود

  پارامتر های ورودی
  نام پارامتر	نوع پارامتر	توضیحات
  userName	string	نام کاربری مربوط به حساب شما در سامانه
  password	string	رمز عبور مربوط به حساب شما در سامانه
  messageType	int	مشخص کننده نوع پیامک است، اگر 1 باشد پیامک های دریافتی و اگر 2 باشد پیامک های ارسالی را مشخص می کند
  fromNumbers	[] string	آرایه ی از شماره های فرستنده می باشد مانند : 10002188
  index	int	اندیس مربوط به ردیف پیام های دریافتی، توجه مقدار اندیس از 1 شروع می شود
  count	int	تعداد رکورد درخواستی، حداکثر 1000
  مقدار بازگشتی
  	[] MessageInfo	آرایه ی از نوع MessageInfo

  GetDelivery

  این متد جهت دریافت وضعیت تحویل پیامک ارسال شده بکارمی رود

  پارامتر های ورودی
  نام پارامتر	نوع پارامتر	توضیحات
  userName	string	نام کاربری مربوط به حساب شما در سامانه
  password	string	رمز عبور مربوط به حساب شما در سامانه
  recId	long	شناسه پیامک ارسال شده
  مقدار بازگشتی
  	int	وضعیت تحویل پیامک می باشد ترجمه مقدار وضعیت تحویل: 5 - : برای گرفتن گزارش تحویل حداقل یک دقیقه بعد از ارسال اقدام نمایید 4 - : به علت اینکه پیام در صف ارسال مخابرات می باشد، امکان گرفتن گزارش تحویل وجود ندارد 3 - : به علت اینکه مهلت یک هفته ای گرفتن گزارش پایان یافته است، امکان گرفتن گزارش تحویل وجود ندارد 2 - : پیام با این کد وجود ندارد (batchSmsId نامعتبر است) 1 - : خطا در ارتباط با سرویس دهنده 0 : ارسال شده به مخابرات 1 : رسیده به گوشی 2 : نرسیده به گوشی 3 : خطای مخابراتی 4 : خطای نامشخص 5 : رسیده به مخابرات 6 : نرسیده به مخابرات 7 : مسدود شده توسط مقصد 8 : نامشخص 9 : مخابرات پیام را مردود اعالم کرد 10 : کنسل شده توسط اپراتور 11 : ارسال نشده