وب سرویس اس ام اس
کامل ترین وب سرویس ارسال پیامک
توسط وب سرویس سامانه پیامکی سیناپردازش شما قادر خواهید بود وب سایت و یا نرم افزار خود را با استفاده از چند خط کد نویسی به پنل اس ام اس سیناپردازش متصل کنید و عملیاتی از قبیل ارسال و دریافت اس ام اس را با توجه به سایت و نرم افزار خود به صورت دلخواه مدیریت کنید.
وب سرویس و Api سامانه پیامکی سیناپردازش
نمونه کدهای وب سرویس پیامکی سامانه پیامکی سیناپردازش ویژه برنامه نویسان و توسعه دهندگان نرم افزار
وب سرویس پیامکی زبان #C
وب سرویس پیامکی DotNetCore
وب سرویس پیامکی زبان Delphi
وب سرویس پیامکی زبان Php
ماژول ارسال و دریافت پیامک WordPress
ماژول ارسال و دریافت پیامک WooCommerce
ماژول ارسال و دریافت پیامک WHMCS
وب سرویس ارسال و دریافت پیامک پایتون
ارسال پیامک از طریق متد get,post
ارسال پیامک با متد Get
برای ارسال از طریق متد Get از فرمت زیر استفاده نمایید
https://sms.sinapardazesh.ir/SMSInOutBox/SendSms?username=نام کاربری&password=کلمه عبور&from=شماره فرستنده&to=شماره گیرنده&text=متن پیامک
مثال :
https://sms.sinapardazesh.ir/SMSInOutBox/SendSms?username=admin&password=123&from=1000…&to=0936…&text=سلام دوستان
ارسال پیامک با متد Post
برای ارسال از طریق متد Post از فرمت زیر استفاده نمایید
مقادیر UserName, Password, From, To, Message باید در قالب تگ فرم یا json به آدرس ذیل submit شوند
راهنمای استفاده از وب سرویس پیامکی
نمونه کدهای وب سرویس پیامکی سامانه پیامکی سیناپردازش ویژه برنامه نویسان و توسعه دهندگان نرم افزار
GetCredit
این متد برای دریافت میزان اعتبارکاربر بکارمی رود
| پارامتر های ورودی | ||
|---|---|---|
| نام پارامتر | نوع پارامتر | توضیحات |
| userName | string | نام کاربری مربوط به حساب شما در سامانه |
| password | string | رمز عبور مربوط به حساب شما در سامانه |
| مقدار بازگشتی : | ||
| decimal | میزان اعتبار کاربر به پیامک می باشد مقدار اعتبار صفر یا عددی برزگتر از صفر می باشد در غیر اینصورت : ۱ – : نام کاربری و رمز عبور صحیح نمی باشد ۲ – : کاربر غیرفعال می باشد |
GetInboxCount
این متد جهت دریافت تعداد پیامهای دریافتی بکارمی رود
| پارامتر های ورودی | ||
|---|---|---|
| نام پارامتر | نوع پارامتر | توضیحات |
| userName | string | نام کاربری مربوط به حساب شما در سامانه |
| password | string | رمز عبور مربوط به حساب شما در سامانه |
| isRead | bool | مقدار true برای پیامهای خوانده شده مقدار false برای پیامهای خوانده نشده |
| مقدار بازگشتی : | ||
| int | اگر نام کاربری و رمز عبور صحیح باشد مقدار برگشتی یک عدد می باشد که بر اساس پارامتر isRead بیانگر تعداد پیامها دریافتی می باشد ۱ – : نام کاربری و رمز عبور صحیح نمی باشد |
SendSMS
از این متد جهت ارسال پیامک به یک تا حداکثر ۱۰۰ شماره بکارمی رود
| پارامتر های ورودی | ||
|---|---|---|
| نام پارامتر | نوع پارامتر | توضیحات |
| userName | string | نام کاربری مربوط به حساب شما در سامانه |
| password | string | رمز عبور مربوط به حساب شما در سامانه |
| fromNumber | string | شماره فرستنده |
| toNumbers | [] string | آرایه ای از شماره موبایل های گیرندگان می باشد حداکثر ۱۰۰ شماره در هر بار فراخوانی |
| messageContent | string | متن پیامک |
| isFlash | bool | تعیین میکند آیا پیامک به صورت فلش ارسال گردد یا خیر |
| ref recId | [] int | هر خانه آرایه یک عدد یکتا به ازای هر گیرنده تولید می کند، این کد یکتا برای دریافت وضعیت تحویل کاربر دارد |
| ref status | [] byte | هر خانه آرایه عدد ۰ یا ۱ بوده به ازای هر گیرنده تولید می شود، ۱ به معنی ارسال شده و ۰ ارسال نشده |
| مقدار بازگشتی : | ||
| int | ۰ : ارسال با موفقیت انجام شد ۱ : نام کاربر یا کلمه عبور نامعتبر می باشد ۲ : کاربر مسدود شده است ۳ : شماره فرستنده نامعتبر است ۴ :محدودیت در ارسال روزانه ۵ : تعداد گیرندگان حداکثر ۱۰۰ شماره می باشد ۶ : خط فرسنتده غیرفعال است ۷ : متن پیامک شامل کلمات فیلتر شده است ۸ : اعتبار کافی نیست ۹ : سامانه در حال بروز رسانی می باشد ۱۰ : وب سرویس غیرفعال است |
SendBatchSms
از این متد جهت ارسال پیامک به یک تا حداکثر ۱۰۰ شماره به کار می رود.
| پارامتر های ورودی | ||
|---|---|---|
| نام پارامتر | نوع پارامتر | توضیحات |
| userName | string | نام کاربری مربوط به حساب شما در سامانه |
| password | string | رمز عبور مربوط به حساب شما در سامانه |
| fromNumber | string | شماره فرستنده |
| toNumbers | [] string | آرایه ای از شماره موبایل های گیرندگان می باشد حداکثر ۱۰۰ شماره در هر بار فراخوانی |
| messageContent | string | متن پیامک |
| isFlash | bool | تعیین میکند آیاپیامک بصورت فلش ارسال گردد یا خیر |
| out batchSmsId | int | شناسه ارسال گروهی |
| مقدار بازگشتی : | ||
| int | ۰ : ارسال با موفقیت انجام شد ۱ : نام کاربر یا کلمه عبور نامعتبر می باشد ۲ : کاربر مسدود شده است ۳ : شماره فرستنده نامعتبر است ۴ :محدودیت در ارسال روزانه ۵ : تعداد گیرندگان حداکثر ۱۰۰ شماره می باشد ۶ : خط فرسنتده غیرفعال است ۷ : متن پیامک شامل کلمات فیلتر شده است ۸ : اعتبار کافی نیست ۹ : سامانه در حال بروز رسانی می باشد ۱۰ : وب سرویس غیرفعال است |
GetBatchDelivery
از این متد جهت دریافت وضعیت تحویل پیامک ارسال شده بکار می رود که با متد SendBatchSms ارسال انجام شده است
| پارامتر های ورودی | ||
|---|---|---|
| نام پارامتر | نوع پارامتر | توضیحات |
| userName | string | نام کاربری مربوط به حساب شما در سامانه |
| password | string | رمز عبور مربوط به حساب شما در سامانه |
| batchSmsId | int | شناسه ارسال با متد SendBatchSms |
| numbers | [] string | آرایه ای از شماره موبایل های گیرندگان می باشد |
| deliveryStatus | [] int | آرایه ی از وضعیت تحویل متناظر با آرایه شماره موبایل ها می باشد ترجمه مقدار وضعیت تحویل: ۵ – : برای گرفتن گزارش تحویل حداقل یک دقیقه بعد از ارسال اقدام نمایید ۴ – : به علت اینکه پیام در صف ارسال مخابرات می باشد، امکان گرفتن گزارش تحویل وجود ندارد ۳ – : به علت اینکه مهلت یک هفته ای گرفتن گزارش پایان یافته است، امکان گرفتن گزارش تحویل وجود ندارد ۲ – : پیام با این کد وجود ندارد (batchSmsId نامعتبر است) ۱ – : خطا در ارتباط با سرویس دهنده ۰ : ارسال شده به مخابرات ۱ : رسیده به گوشی ۲ : نرسیده به گوشی ۳ : خطای مخابراتی ۴ : خطای نامشخص ۵ : رسیده به مخابرات ۶ : نرسیده به مخابرات ۷ : مسدود شده توسط مقصد ۸ : نامشخص ۹ : مخابرات پیام را مردود اعالم کرد ۱ : کنسل شده توسط اپراتور ۱۱ : ارسال نشده |
| index | int | اندیس مربوط به ردیف پیام ارسالی، توجه مقدار اندیس از ۱ شروع می شود. |
| count | int | تعداد رکورد درخواستی، حداکثر ۱۰۰ |
| مقدار بازگشتی : | ||
| int | ۱ – : نام کاربری و رمز عبور صحیح نمی باشد ۲ – : ارسال با مقدار شناسه batchSmsId وجود ندارد |
GetMessages
از این متد جهت دریافت پیامک های دریافتی یا ارسالی استفاده می شود
| پارامتر های ورودی | ||
|---|---|---|
| نام پارامتر | نوع پارامتر | توضیحات |
| userName | string | نام کاربری مربوط به حساب شما در سامانه |
| password | string | رمز عبور مربوط به حساب شما در سامانه |
| messageType | int | مشخص کننده نوع پیامک است، اگر ۱ باشد پیامک های دریافتی و اگر ۲ باشد پیامک های ارسالی را مشخص می کند |
| fromNumbers | [] string | آرایه ی از شماره های فرستنده می باشد مانند : ۱۰۰۰۲۱۸۸ |
| index | int | اندیس مربوط به ردیف پیام های دریافتی، توجه مقدار اندیس از ۱ شروع می شود |
| count | int | تعداد رکورد درخواستی، حداکثر ۱۰۰۰ |
| مقدار بازگشتی : | ||
| [] MessageInfo | آرایه ی از نوع MessageInfo |
GetDelivery
این متد جهت دریافت وضعیت تحویل پیامک ارسال شده بکارمی رود
| پارامتر های ورودی | ||
|---|---|---|
| نام پارامتر | نوع پارامتر | توضیحات |
| userName | string | نام کاربری مربوط به حساب شما در سامانه |
| password | string | رمز عبور مربوط به حساب شما در سامانه |
| recId | long | شناسه پیامک ارسال شده |
| مقدار بازگشتی : | ||
| int | وضعیت تحویل پیامک می باشد ترجمه مقدار وضعیت تحویل: ۵ – : برای گرفتن گزارش تحویل حداقل یک دقیقه بعد از ارسال اقدام نمایید ۴ – : به علت اینکه پیام در صف ارسال مخابرات می باشد، امکان گرفتن گزارش تحویل وجود ندارد ۳ – : به علت اینکه مهلت یک هفته ای گرفتن گزارش پایان یافته است، امکان گرفتن گزارش تحویل وجود ندارد ۲ – : پیام با این کد وجود ندارد (batchSmsId نامعتبر است) ۱ – : خطا در ارتباط با سرویس دهنده ۰ : ارسال شده به مخابرات ۱ : رسیده به گوشی ۲ : نرسیده به گوشی ۳ : خطای مخابراتی ۴ : خطای نامشخص ۵ : رسیده به مخابرات ۶ : نرسیده به مخابرات ۷ : مسدود شده توسط مقصد ۸ : نامشخص ۹ : مخابرات پیام را مردود اعالم کرد ۱ : کنسل شده توسط اپراتور ۱۱ : ارسال نشده |
NumberIsInTelecomBlacklist
این متد جهت چک کردن شماره مسدود شده توسط مخابرات بکار می رود
| پارامتر های ورودی | ||
|---|---|---|
| نام پارامتر | نوع پارامتر | توضیحات |
| userName | string | نام کاربری مربوط به حساب شما در سامانه |
| password | string | رمز عبور مربوط به حساب شما در سامانه |
| number | string | شماره همراه |
| مقدار بازگشتی : | ||
| int | ۱ – : نام کاربری و رمز عبور صحیح نمی باشد ۲ – : کاربر غیرفعال می باشد ۳ – : شماره همراه مشخص نشده است ۰ : شماره آزاد است ۱ : شماره در لیست سیاه مخابرات است |
ExtractTelecomBlacklistNumbers
این متد جهت چک کردن شماره مسدود شده توسط مخابرات تا حداکثر ۱۰۰۰ شماره بکارمی رود
| پارامتر های ورودی | ||
|---|---|---|
| نام پارامتر | نوع پارامتر | توضیحات |
| userName | string | نام کاربری مربوط به حساب شما در سامانه |
| password | string | رمز عبور مربوط به حساب شما در سامانه |
| numbers | [] string | آرایه ای از شماره های همراه می باشد حداکثر ۱۰۰۰ شماره در هر بار فراخوانی |
| out blacklistNumbers | [] string | شماره های مسدود شده |
| مقدار بازگشتی : | ||
| int | ۱ – : نام کاربری و رمز عبور صحیح نمی باشد ۲ – : کاربر غیرفعال می باشد ۳ – : آرایه ی شماره های همراه خالی می باشد ۴ – : تعداد شماره ها حداکثر ۱۰۰۰ شماره می باشد ۰ : عملیات با موفقیت انجام شد |
SendSmsLikeToLike
از این متد جهت ارسال پیامک با متن متفاوت به یک تا حداکثر ۱۰۰ شماره به کار می رود.
| پارامتر های ورودی | ||
|---|---|---|
| نام پارامتر | نوع پارامتر | توضیحات |
| userName | string | نام کاربری مربوط به حساب شما در سامانه |
| password | string | رمز عبور مربوط به حساب شما در سامانه |
| fromNumber | string | شماره فرستنده |
| toNumbers | [] string | آرایه ای از شماره موبایل های گیرندگان می باشد حداکثر ۱۰۰ شماره در هر بار فراخوانی |
| messageContents | [] string | آرایه ای از متن پیامک ها متناظر با آرایه شماره موبایل های گیرندگان می باشد حداکثر ۱۰۰ شماره در هر بار فراخوانی |
| isFlash | bool | تعیین میکند آیاپیامک بصورت فلش ارسال گردد یا خیر |
| out smsId | int | شناسه ارسال |
| مقدار بازگشتی : | ||
| int | ۰ : ارسال با موفقیت انجام شد ۱ : نام کاربر یا کلمه عبور نامعتبر می باشد ۲ : کاربر مسدود شده است ۳ : شماره فرستنده نامعتبر است ۴ :محدودیت در ارسال روزانه ۵ : تعداد گیرندگان حداکثر ۱۰۰ شماره می باشد ۶ : خط فرسنتده غیرفعال است ۷ : متن پیامک شامل کلمات فیلتر شده است ۸ : اعتبار کافی نیست ۹ : سامانه در حال بروز رسانی می باشد ۱۰ : وب سرویس غیرفعال است |
