مستندات وب سرویس و پلاگین پیامک کاپنل

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

Send

برای ارسال پیامک 

پارامتر های ورودی  
 نام کاربری
Char
Uname
 پسورد
Char
Pass
 شماره ارسال کننده
Char
From
 متن پیام
Char
Message
 شماره دریافت کننده
Char
TO

نکته:
مقدار بازگشتی: یک کد خطا و متن خطا بازگشت داده می شود. **** در صورت دریافت کد صفر با موفقیت انجام گرفته است.

Credit

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

پارامتر های ورودی  
نام کاربری
Char
Uname
پسورد
Char
Pass
Credit
Char
Op

Delivery

برای گزارش از وضعیت ارسال به کار میرود.

پارامتر های ورودی  
نام کاربری
Char
Uname
پسورد
Char
Pass
Delivery
Char
Op
کد بالک
Int
Uniqid

[“+۹۸۹۱۰۰۰۰۰۹۸:notsync”,”+989210000616:notsync”,”+989212000943:notsync”,”+989360000994:notsync”]

در حال ارسال :Notsync
ارسال شده :Send
رسیده به مخابرات :Pending
نرسیده به گوشی : Failed
بلک لیست :Discarded
رسیده به گوشی : Delivered
The username or password is incorrect : خطاها
اشتباه بودن نام کاربری یا رمز عبور

بدین معنی است که کد بالک ارسالی اشتباه است :Null 

delivery : نمونه خروجی برای گرفتن دلیوری پیام های ارسالی

Booksend

برای ارسال از دفترچه استفاده می شود

پارامتر های ورودی  
نام کاربری
Char
Uname
پسورد
Char
Pass
Checkmessage
Char
Op
کد بالک
Int
Messageid

statusMess

پایان یافته  :Finish

عدم برقراری با اپراتور :NoContactWithTheOperator

:Interacting

نکته:

مقدار بازگشتی: یک کد خطا و متن خطا بازگشت بازگشت داده می شود. **** در صورت دریافت کد صفر با موفقیت انجام گرفته است.

statusMessag

پایان یافته:Finish

عدم برقراری با اپراتور: NoContactWithTheOperator

در حال ارتباط :Interacting

عدم احراز هویت :NoAuthentication

فعال :Active

عدم ارسال پیامک :NoSendSMS

انصراف :Cancel

validMessage

تایید شده: Approve

رد شده: Cancel

منتظر تایید: Notconfirm

 

Booksend

برای ارسال از دفترچه استفاده می شود

پارامتر های ورودی  
نام کاربری
Char
Uname
پسورد
Char
Pass
شماره ارسال کننده
Char
From
متن پیام
Char
Message
Json از لیست دفترچه ها
Char
bookid
Booksend
Char
Op

statusMess

پایان یافته  :Finish

عدم برقراری با اپراتور :NoContactWithTheOperator

:Interacting

Booklist

برای گزارش از وضعیت ارسال به کار می رود.

پارامتر های ورودی  
نام کاربری
Char
Uname
پسورد
Char
Pass
Booklist
Char
Op

StatusMess

پایان یافته  :Finish

عدم برقراری با اپراتور :NoContactWithTheOperator

:Interacting

Inboxlist 

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

پارامتر های ورودی  
نام کاربری
Char
Uname
پسورد
Char
Pass
Inboxlist
Char
Op

StatusMess

پایان یافته  :Finish

عدم برقراری با اپراتور :NoContactWithTheOperator

:Interacting

Accesslist

برای دریافت بسته های در دسترس استفاده می شود

پارامتر های ورودی  
نام کاربری
char
uname
پسورد
char
pass
accesslist
char
Op

Accesslist

برای دریافت بسته های در دسترس استفاده می شود

Newuser

برای ساخت کاربر جدید مورد استفاده قرار میگیرد

پارامتر های ورودی  
نام کاربری
Char
Uname
پسورد
Char
Pass
نام کاربری کاربر
Char
User-name
پسورد کاربر
Char
User-pass
نام
Char
name
نام شرکت
Char
company
کد ملی
Char
national-id
شماره شناسنامه
Char
certificate-id
Id سطح دسترسی
Char
access-id
تلفن
Char
Tell
موبایل
Char
mobile
کدپستی
Char
postalcode
ایمیل
Char
email
آدرس
Char
address
newuser
Char
Op

 

statusMess

پایان یافته  :Finish

عدم برقراری با اپراتور :NoContactWithTheOperator

:Interacting

Postalcodecount

برای گرفتن تعداد شماره ها در یک کدپستی می باشد

پارامتر های ورودی  
نام کاربری
Char
Uname
پسورد
Char
Pass
postalcodecount
Char
Op
tci برای همراه اول / mtn برای ایرانسل
Char
type
0 -برای مرد و زن . ۱ – برای مرد. ۲ -برای زن
itn
gender
کد پستی
char
postalcode

Postalcodearea

برای گرفتن محله های تهران استفاده می شود. 

پارامتر های ورودی  
نام کاربری
Char
Uname
پسورد
Char
Pass
Postalcoderarea
Char
Op

statusMess

پایان یافته  :Finish

عدم برقراری با اپراتور :NoContactWithTheOperator

:Interacting

Postalcodesen

برای گرفتن تعداد شماره ها در یک کدپستی می باشد.

پارامتر های ورودی  
نام کاربری
Char
Uname
پسورد
Char
Pass
شماره ارسال کننده
Char
From
متن پیام جهت ارسال
Char
Massage
Tci برای همراه اول / Mtn برای ایرانسل
Char
type
0 -برای مرد وزن. ۱ -برای مرد. ۲ -برای زن
Int
Gender
کدپستی
Char
Postalcode
Postalcodesend
Char
Op

statusMess

پایان یافته  :Finish

عدم برقراری با اپراتور :NoContactWithTheOperator

:Interacting

Jobssend

برای ارسال مشاغل به کار میرود.

پارامتر های ورودی  
نام کاربری
Char
Uname
پسورد
Char
Pass
شماره ارسال کننده
Char
From
پیام
Int
Message
Json لیست از گرایش ها
Char
Trendid
Jobssend
Char
Op
Id شغل
Int
Jobsid

statusMess

پایان یافته  :Finish

عدم برقراری با اپراتور :NoContactWithTheOperator

:Interacting

Jobslist

برای گرفتن لیست شغل هاست.

پارامتر های ورودی  
نام کاربری
Char
Uname
پسورد
Char
Pass
Postalcoderarea
Char
Op

statusMess

پایان یافته  :Finish

عدم برقراری با اپراتور :NoContactWithTheOperator

:Interacting

Jobstrenlist

برای گرفتن لیست گرایش ها به کار می رود.

پارامتر های ورودی  
نام کاربری
Char
Uname
پسورد
Char
Pass
Checkmessage
Char
Op
کد بالک
Int
Messageid

statusMess

پایان یافته  :Finish

عدم برقراری با اپراتور :NoContactWithTheOperator

:Interacting

Jobscount

برای گرفتن تعداد شماره مشاغل استفاده می گردد. 

پارامتر های ورودی  
نام کاربری
char
Uname
پسورد
char
Pass
Json لیست از گرایش ها
char
Trendid
jobscount
Int
Op

statusMess

پایان یافته  :Finish

عدم برقراری با اپراتور :NoContactWithTheOperator

:Interacting

دریافت وضعیت دلیوری ارسال ها از طریق وب هوک

کاربر میبایست یک سرور http آماده کند که قادر به پاسخگویی درخواست از نوع POST با پارامترهای ذکر شده در عکس ضمیمه باشد.

 

* تمام وضعیت‌های ممکن برای پیام در تصویر ضمیمه وجود دارد (چهار حالت ممکنه).

 

* سرور کاربر میبایستی در حداکثر زمان ۱۵ ثانیه درخواست سرور ما را پاسخگو باشد، در غیر اینصورت پیام reject میشود.

 

* محتویات پیام ارسالی از سمت ما در قالب json می باشد، لذا سرور مربوط به کاربر میبایستی یک json-api باشد.

 

* فرمت تاریخ موجود از استاندارد RFC3339 استفاده نموده و timezone آن UTC می‌باشد.

 

* فرمت شماره گیرنده و فرستنده، به صورتی که در عکس ضمیمه دیده می شود باید باشد (با کد کشور و کاراکتر +).

 

* آدرسی که از سمت کاربر ارائه می شود نباید redirect داشته باشد و میبایست نقطه‌ی نهایی api ارائه شود (اگر سرور https باشد، آدرس را با پروتکل https ارائه دهید).

 

* برای حفظ امنیت سرور کاربر، توصیه میگردد درخواست‌ها به این وب سرویس، به آدرسی که متعاقبا از سمت کاپنل ارائه می شود محدود گردد.

زبان های برنامه نویسی سامانه پیامک کاپنل

به کسب و کار خود قدرت بدهید

آزمایشگاه ما در اختیار شماست

متن سربرگ خود را وارد کنید

متن سربرگ خود را وارد کنید

متن سربرگ خود را وارد کنید

متن سربرگ خود را وارد کنید

متن سربرگ خود را وارد کنید

متن سربرگ خود را وارد کنید

متن سربرگ خود را وارد کنید

متن سربرگ خود را وارد کنید

متن سربرگ خود را وارد کنید

متن سربرگ خود را وارد کنید

متن سربرگ خود را وارد کنید

متن سربرگ خود را وارد کنید

هر نرم افزار و سامانه ای با استفاده از API پیامک میتواند در زمان های مورد نظر پیامک ارسال کند. این اتفاق میتواند به سادگی ارسال پیامک در زمان انجام عملیات در ATM باشد. ارسال پیامک در زمان ثبت نام و عضویت در سایت ها، خرید از سایت ها و اپلیکیشن ها و عملیاتی از این دست امروزه بسیار رایج و ضروری به شمار میروند.

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

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

خیر، به جز پنل برنزی و نقره ای که از وب سرویس پشتیبانی نمیکنند، سایر پنل ها در دسترسی به وب سرویس پیامک تفاوتی ندارند.

بله، شما تا ۳۰ روز زمان دارید سرویس را تست نمایید. در صورت نارضایتی تمام وجه بازگشت داده خواهد شد.