مستندات وبسرویس و پلاگین پیامک کاپنل
با استفاده از سامانه پیامک کاپنل، وبسایت یا اپلیکیشن خود را به سرویس ارسال پیامک متصل کنید. در این صفحه مستندات کامل ۱۶ متد وبسرویس به همراه نمونه کدهای آماده برای PHP، C#، Node.js، RESTful و VB.net در اختیار شماست. همچنین با سیستم Webhook وضعیت ارسال را لحظهای دریافت کنید.
📋 متدهای وبسرویس API
۱۶ متد
POST Send
▾
ارسال پیامک
| نام کاربری | Uname |
| پسورد | Pass |
| شماره ارسالکننده | From |
| متن پیام | Message |
| شماره دریافتکننده | TO |
✅ مقدار بازگشتی: کد خطا و متن خطا — کد صفر = موفقیت
GET Credit
▾
دریافت اعتبار
| نام کاربری | Uname |
| پسورد | Pass |
| عملیات | Op = Credit |
GET Delivery
▾
گزارش وضعیت ارسال
| نام کاربری | Uname |
| پسورد | Pass |
| عملیات | Op = Delivery |
| کد بالک | Uniqid (Int) |
در حال ارسال: notsync
ارسال شده: send
رسیده به مخابرات: pending
نرسیده به گوشی: failed
بلکلیست: discarded
رسیده به گوشی: delivered
GET Inboxlist
▾
دریافت پیامهای خواندهشده
| نام کاربری | Uname |
| پسورد | Pass |
| عملیات | Op = Inboxlist |
GET Accesslist
▾
دریافت بستههای در دسترس
| نام کاربری | Uname |
| پسورد | Pass |
| عملیات | Op = Accesslist |
POST Newuser
▾
ساخت کاربر جدید
| نام کاربری | Uname |
| پسورد | Pass |
| نام کاربری کاربر | User-name |
| پسورد کاربر | User-pass |
| نام | name |
| نام شرکت | company |
| کد ملی | national-id |
| شماره شناسنامه | certificate-id |
| ID سطح دسترسی | access-id |
| تلفن | Tell |
| موبایل | mobile |
| کدپستی | postalcode |
| ایمیل | |
| آدرس | address |
| عملیات | Op = Newuser |
POST Booksend
▾
ارسال از دفترچه
| نام کاربری | Uname |
| پسورد | Pass |
| شماره ارسالکننده | From |
| متن پیام | Message |
| JSON از لیست دفترچهها | bookid |
| عملیات | Op = Booksend |
پایانیافته: Finish
عدم برقراری با اپراتور: NoContactWithTheOperator
در حال ارتباط: Interacting
GET Booklist
▾
گزارش وضعیت ارسال از دفترچه
| نام کاربری | Uname |
| پسورد | Pass |
| عملیات | Op = Booklist |
GET Postalcodecount
▾
تعداد شمارهها در یک کدپستی
| نام کاربری | Uname |
| پسورد | Pass |
| عملیات | Op = Postalcodecount |
| اپراتور | type: tci (همراه اول) / mtn (ایرانسل) |
| جنسیت | gender: 0 = مرد و زن · 1 = مرد · 2 = زن |
| کد پستی | postalcode |
GET Postalcodearea
▾
دریافت محلههای تهران
| نام کاربری | Uname |
| پسورد | Pass |
| عملیات | Op = Postalcodearea |
POST Postalcodesen
▾
ارسال بر اساس کدپستی
| نام کاربری | Uname |
| پسورد | Pass |
| شماره ارسالکننده | From |
| متن پیام | Message |
| اپراتور | type: tci / mtn |
| جنسیت | gender: 0 · 1 · 2 |
| کدپستی | postalcode |
| عملیات | Op = Postalcodesend |
POST Jobssend
▾
ارسال بر اساس مشاغل
| نام کاربری | Uname |
| پسورد | Pass |
| شماره ارسالکننده | From |
| متن پیام | Message |
| JSON لیست از گرایشها | Trendid |
| ID شغل | Jobsid |
| عملیات | Op = Jobssend |
GET Jobslist
▾
دریافت لیست شغلها
| نام کاربری | Uname |
| پسورد | Pass |
| عملیات | Op = Jobslist |
GET Jobstrenlist
▾
دریافت لیست گرایشها
| نام کاربری | Uname |
| پسورد | Pass |
| عملیات | Op = Jobstrenlist |
GET Jobscount
▾
تعداد شماره مشاغل
| نام کاربری | Uname |
| پسورد | Pass |
| JSON لیست از گرایشها | Trendid |
| عملیات | Op = Jobscount |
🔗 دریافت وضعیت دلیوری ارسالها از طریق Webhook
- کاربر باید یک سرور HTTP آماده کند که قادر به پاسخگویی به درخواست از نوع POST با پارامترهای مشخصشده باشد.
- سرور کاربر باید در حداکثر ۱۵ ثانیه درخواست را پاسخگو باشد، در غیر اینصورت پیام reject میشود.
- محتویات پیام ارسالی در قالب JSON میباشد، بنابراین سرور باید یک JSON-API باشد.
- فرمت تاریخ از استاندارد RFC3339 با timezone UTC استفاده میکند.
- فرمت شماره گیرنده و فرستنده با کد کشور و کاراکتر + (مثل ۹۸۹۱۰۰۰۰۰۹۸+).
- آدرس ارائهشده نباید redirect داشته باشد و باید نقطهنهایی API باشد.
- توصیه میشود درخواستها به آدرس مشخصشده از سمت کاپنل محدود شود.
💻 زبانهای برنامهنویسی سامانه پیامک کاپنل
✨ به کسبوکار خود قدرت بدهید · آزمایشگاه ما در اختیار شماست
📊 نرمافزار حسابداری هلو
نام کاربری = UserName | کلمه عبور = Password | پیام متن = Message | شماره خط = From | شماره موبایل کاربر = To
آدرس استفاده در نرمافزار حسابداری هلو:
http://ippanel.com/service/holo
❓ سوالات متداول
پاسخ به سوالات رایج درباره وبسرویس پیامک کاپنل
کاربرد وبسرویس و API پیامک چیست؟
▾
هر نرمافزار و سامانهای با استفاده از API پیامک میتواند در زمانهای مورد نظر پیامک ارسال کند. این اتفاق میتواند به سادگی ارسال پیامک در زمان انجام عملیات در ATM، ثبتنام و عضویت در سایتها، خرید از سایتها و اپلیکیشنها و عملیاتی از این دست باشد که امروزه بسیار رایج و ضروری هستند.
آیا امکان ارسال به خطوط بلکلیست وجود دارد؟
▾
از آنجایی که وبسرویس پیامک برای ارسال پیامکهای خدماتی و اطلاعرسانی استفاده میشود، در سامانه کاپنل هیچ مانعی برای ارسال به خطوط بلکلیست وجود ندارد و این کار از طریق پترن انجام خواهد شد.
شرایط استفاده از وبسرویس کاپنل چیست؟
▾
برای استفاده از وبسرویس پیامک کاپنل هیچ هزینه جداگانهای از شما دریافت نمیشود. تنها با داشتن پنل طلایی، الماسی و یا نمایندگی کاپنل میتوانید از این امکان بهصورت رایگان استفاده کنید.
آیا پنلهای مختلف در دسترسی به وبسرویس تفاوت دارند؟
▾
به جز پنلهای برنزی و نقرهای که از وبسرویس پشتیبانی نمیکنند، سایر پنلها در دسترسی به وبسرویس پیامک تفاوتی ندارند و همه امکانات یکسان در اختیار شماست.
آیا امکان بازگشت وجه وجود دارد؟
▾
بله، شما تا ۷ روز فرصت دارید سرویس را تست کنید. در صورت نارضایتی، تمام وجه به شما بازگشت داده خواهد شد.
آیا وبسرویس کاپنل از RESTful پشتیبانی میکند؟
▾
بله، وبسرویس کاپنل بهصورت RESTful و SOAP در دسترس است. نمونه کدهای آماده برای هر دو روش در بخش نمونه کدهای برنامهنویسی این صفحه قرار داده شده است.
آیا میتوانم از وبسرویس در سایتسازها استفاده کنم؟
▾
بله، برای سایتسازهایی مانند وردپرس، جوملا، دروپال و سایر سیستمهای مدیریت محتوا، افزونهها و ماژولهای پیامکی سازگار تهیه شده است که به راحتی قابل نصب و استفاده هستند.
