مقدمه

مستند حاضر براي استفاده آن دسته از برنامه نویسانی طراحی شده است که می خواهند از سرویس RestFul سامانه پیامک لیمو اس ام اس استفاده نمایند. در این راهنما روش ها و دستورات مورد نیاز برنامه نویسان در هنگام استفاده از سرویس RestFul شرح داده شده است . سرویس RestFul به دلیل سادگی پیاده سازي و حمایت از تمامی زبانهاي برنامه نویسی از جمله محبوب ترین روش هاي مورد استفاده جهت ارسال پیام از طریق نرم افزار می باشد

شروع به کار

برای شروع کار با وب سرویس ابتدا نیاز است که در سامانه احراز هویت را انجام دهید. برای این کار لازم است ابتدا مدارک خود را ارسال و منتظر تایید مدارک از طرف کارشناسان باشید که در صورت موفقیت آمیز بودن و تایید مدارک ، کد دسترسی به شما نمایش داده خواهد شد که با استفاده از کد دسترسی می توانید از وب سرویس ها استفاده نمایید .

متد ارسال پیام

این وب سرویس برای ارسال پیام به یک یا چند شخص و به صورت زمانبندی استفاده می شود .

https://api.limosms.com/api/sendsms Post
پارامتر ورودی
ردیف نام پارامتر نوع توضیحات
1 SenderNumber string شماره خط ارسال کننده پیام
2 Message string متن پیامک
3 MobileNumber [ ] string زمان ارسال پیام ( در صورت خالی بودن پیام در لحظه ارسال می‌شود )
4 SendToBlocksNumber boolean ارسال به شماره های بلاک شده
5 SendTimeSpan double زمان ارسال پیام ( در صورت خالی بودن پیام در لحظه ارسال می‌شود )
پارامتر خروجی
ردیف نام پارامتر نوع توضیحات
1 Success boolean نتیجه ارسال پیام
2 Message string توضیحات ارسال پیام
3 MessageId [ ] string شناسه پیام ها برای دریافت وضعیت ارسال
نمونه کد
متد ارسال پیام متناظر

این وب سرویس برای ارسال پیام متناظر به صورت زمانبندی استفاده می شود

https://api.limosms.com/api/sendpeertopeersms Post
پارامتر ورودی
ردیف نام پارامتر نوع توضیحات
1 SenderNumber string شماره خط ارسال کننده پیام
2 Message [ ] string متن پیام ها
3 MobileNumber [ ] string زمان ارسال پیام ( در صورت خالی بودن پیام در لحظه ارسال می‌شود )
4 SendToBlocksNumber boolean ارسال به شماره های بلاک شده
5 SendTimeSpan double زمان ارسال پیام ( در صورت خالی بودن پیام در لحظه ارسال می‌شود )
پارامتر خروجی
ردیف نام پارامتر نوع توضیحات
1 Success boolean نتیجه ارسال پیام
2 Message string توضیحات ارسال پیام
3 MessageId [ ] string شناسه پیام ها برای دریافت وضعیت ارسال
نمونه کد
متد ارسال پترن (الگو)

در ارسال پیامک وب سرویس از طریق پترن شما متن کلی پیامک را مشخص می‌کنید و فقط در بعضی از موارد که نیاز است متغیر قرار می‌دهید، بنابراین کلیت متن شما ثابت است و یک مرتبه واحد مانیتورینگ متن پیامک را تایید می‌کند در صورتی که متن پیامک تبلیغاتی نباشد یک کد الگو در اختیار شما قرار می‌گیرد زمانی که شما از طریق این الگو پیامک ارسال می‌کنید بدون تایید ناظر انسانی پیامک ارسال می‌شود و پیامک ارسال شده در کمتر از 5 ثانیه به دست مخاطب می‌رسد.

https://api.limosms.com/api/sendpatternmessage Post
پارامتر ورودی
ردیف نام پارامتر نوع توضیحات
1 OtpId Long شناسه متن پیام
2 ReplaceToken [ ] string متن های جایگذین
3 MobileNumber string شناسه متن پیام
پارامتر خروجی
ردیف نام پارامتر نوع توضیحات
1 Success boolean نتیجه ارسال پیام
2 Message string توضیحات ارسال پیام
نمونه کد
متد احراز هویت

در ارسال پیامک احراز هویت از طریق api شما باید شماره موبایل را وارد کنید تا کد برای شماره مربوطه ارسال گردد . همچنین می توانید فوتری هم برای پیام ارسال کد مشخص و ارسال کنید

https://api.limosms.com/api/sendcode Post
پارامتر ورودی
ردیف نام پارامتر نوع توضیحات
1 Mobile string شماره موبایل دریافت کننده کد
2 Footer string متن فوتر در پیام
پارامتر خروجی
ردیف نام پارامتر نوع توضیحات
1 Success boolean نتیجه ارسال پیام
2 Message string توضیحات ارسال پیام
نمونه کد
متد دریافت وضعیت احراز هویت

برای چک کردن احراز هویت شماره موبایل کاربر از طریق api شما باید شماره موبایل و کد وارد شده توسط کاربر خود را ارسال کنید تا بررسی ها انجام و نتیجه به شما نمایش داده شود

https://api.limosms.com/api/checkcode Post
پارامتر ورودی
ردیف نام پارامتر نوع توضیحات
1 Mobile string شماره موبایل دریافت کننده کد
2 Code string کد وارد شده توسط کاربر
پارامتر خروجی
ردیف نام پارامتر نوع توضیحات
1 Success boolean نتیجه احراز هویت
2 Message string توضیحات
نمونه کد
متد دریافت پیام های دریافتی

این وب سرویس برای دریافت پیام های دریافتی ارسال شده به خط اختصاصی شما استفاده می شود. توجه : در هر درخواست حداکثر 100 تا پیام برگشت داده می شود

https://api.limosms.com/api/getreceivedmessage Post
پارامتر ورودی
ردیف نام پارامتر نوع توضیحات
1 Number string شماره ی اختصاصی
2 Page int شماره صفحه
3 Size int تعداد
پارامتر خروجی
ردیف نام پارامتر نوع توضیحات
1 Success boolean نتیجه ارسال پیام
2 Message string توضیحات ارسال پیام
3 Result [ ] Object لیست پیام ها
نمونه کد
متد دریافت وضعیت ارسال

این وب سرویس برای دریافت وضعیت ارسال پیام ها استفاده می شود. توجه : در هر درخواست حداکثر 100 تا وضعیت برگشت داده می شود

https://api.limosms.com/api/getstatus Post
پارامتر ورودی
ردیف نام پارامتر نوع توضیحات
1 MessageId [ ] string شناسه پیام های ارسالی
پارامتر خروجی
ردیف نام پارامتر نوع توضیحات
1 Success boolean نتیجه ارسال پیام
2 Message string توضیحات ارسال پیام
3 Data [ ] Object لیست وضعیت پیام ها
نمونه کد
متد دریافت اطلاعات پروفایل

این وب سرویس برای دریافت اطلاعات میزان شارژ و جدول تعرفه می باشد

https://api.limosms.com/api/getcurrentcredit Post
پارامتر خروجی
ردیف نام پارامتر نوع توضیحات
1 Success boolean نتیجه احراز هویت
2 Message string توضیحات
3 Result Object اطلاعات پروفایل
نمونه کد
متد ارسال OTP صوتی

این وب سرویس برای ارسال کد اعتبار سنجی OTP بصورت تماس تلفنی مورد استفاده قرار می گیرد .

https://api.limosms.com/api/SendOTPVoice Post
پارامتر ورودی
ردیف نام پارامتر نوع توضیحات
1 PhoneNumber string شماره خط دریافت کننده پیام
2 GenerateCode string کد اعتبارسنجی (اختیاری)
پارامتر خروجی
ردیف نام پارامتر نوع توضیحات
1 Success boolean نتیجه ارسال پیام
2 Message string توضیحات ارسال پیام
3 GenerateCode string کد تولید شده درصورت اختیاری بودن کد اعتبارسنجی
نمونه کد
لغو پیام تکی زمانبندی شده

این وبسرویس برای حذف پیام تکی زمانبندی شده استفاده می شود

https://api.limosms.com/api/CancelUserOneMessage Post
پارامتر ورودی
ردیف نام پارامتر نوع توضیحات
1 Id long آیدی پیام
پارامتر خروجی
ردیف نام پارامتر نوع توضیحات
1 Success boolean نتیجه ارسال پیام
2 Message string توضیحات ارسال پیام
نمونه کد
;