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

api پنل اس ام اس و مستندات وب سرویس پیامک
send
برای ارسال پیامک
پارامتر های ورودی | ||
---|---|---|
نام کاربری | char | Uname |
پسورد | char | Pass |
شماره ارسال کننده | char | From |
متن پیام | char | Message |
شماره دریافت کننده | char | To |
credit
برای دریافت اعتبار به کار می رود
پارامتر های ورودی | ||
---|---|---|
نام کاربری | char | Uname |
پسورد | char | Pass |
شماره ارسال کننده | char | From |
متن پیام | char | Message |
delivery
برای گزارش از وضعیت ارسال به کار میرود.
پارامتر های ورودی | ||
---|---|---|
نام کاربری | char | Uname |
پسورد | char | Pass |
شماره ارسال کننده | char | From |
متن پیام | Int | Message |
[“+۹۸۹۱۰۰۰۰۰۹۸: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 |
statusMessag
پایان یافته:Finish
عدم برقراری با اپراتور: NoContactWithTheOperator
در حال ارتباط :Interacting
عدم احراز هویت :NoAuthentication
فعال :Active
عدم ارسال پیامک :NoSendSMS
انصراف :Cancel
validMessage
تایید شده: Approve
رد شده: Cancel
منتظر تایید: Notconfirm
booklist
برای گزارش از وضعیت ارسال به کار می رود
پارامتر های ورودی | ||
---|---|---|
نام کاربری | char | Uname |
پسورد | char | Pass |
Booklist | char | Op |
StatusMess
پایان یافته :Finish
عدم برقراری با اپراتور :NoContactWithTheOperator
:Interacting
booksend
برای ارسال از دفترچه استفاده می شود
پارامتر های ورودی | ||
---|---|---|
نام کاربری | char | Uname |
پسورد | char | Pass |
شماره ارسال کننده | char | From |
متن پیام | char | Message |
Json از لیست دفترچه ها | char | Bookid |
Booksend | 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 |
StatusMess
پایان یافته :Finish
عدم برقراری با اپراتور :NoContactWithTheOperator
:Interacting
Accesslist
برای دریافت بسته های در دسترس استفاده می شود
پارامتر های ورودی | ||
---|---|---|
نام کاربری | 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 | |
آدرس | 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 |
Tci برای همراه اول / Mtn برای ایرانسل | char | type |
0 -برای مرد وزن. ۱ -برای مرد. ۲ -برای زن | Int | Gender |
کدپستی | char | Postalcode |
Postalcodesend | char | Op |
StatusMess
پایان یافته :Finish
عدم برقراری با اپراتور :NoContactWithTheOperator
:Interacting
Postalcodesen
برای گرفتن تعداد شماره ها در یک کدپستی می باشد
پارامتر های ورودی | ||
---|---|---|
نام کاربری | char | Uname |
پسورد | char | Pass |
Jobslist | char | Op |
StatusMess
پایان یافته :Finish
عدم برقراری با اپراتور :NoContactWithTheOperator
:Interacting
Jobstrenlist
برای گرفتن لیست شغل هاست
پارامتر های ورودی | ||
---|---|---|
نام کاربری | char | Uname |
پسورد | char | Pass |
Jobslist | 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
Jobscount
برای گرفتن تعداد شماره مشاغل استفاده می گردد
پارامتر های ورودی | ||
---|---|---|
نام کاربری | char | Uname |
پسورد | char | Pass |
شماره ارسال کننده | char | From |
پیام | Int | Message |
Json لیست از گرایش ها | char | Trendid |
Jobssend | char | Op |
Id شغل | Int | Jobsid |
StatusMess
پایان یافته :Finish
عدم برقراری با اپراتور :NoContactWithTheOperator
:Interacting