در صورتی که برنامه نویس هستید و قصد دارید از پیام کوتاه در سایت نرم افزار خود استفاده نمایید، بهترین راه انجام این کار استفاده از وب سرویس است. هر وب سرویس مستنداتی دارد که در صورت وجود، کمک شایانی به استفاده از متدها و اطلاع از خطاهای اعلام شده خواهد کرد. مهم نیست که به چه زبانی برنامه نویسی می کنید، وب سرویس یک زبان بین المللی است که بدون درنظر گرفتن زبان برنامه نویسی پروژه شما، امکانات بسیاری را در اختیار شما قرار خواهد داد
برای استفاده از وب سرویس در دات نت از آدرس زیر استفاده کنید.
برای استفاده از وب سرویس در php و java از آدرس زیر استفاده کنید.
برای ارسال از طریق متد Post از فرمت زير استفاده نماييد. (مناسب برای استفاده در نرم افزار هلو)
مقادیر UserName, Password, From, To, Message باید در قالب تگ فرم یا json به آدرس ذیل sumit شوندشوند
آدرس :
http://payamak-service.ir/SMSInOutBox/Send
برای ارسال از طریق متد Get نيز از فرمت زير استفاده نماييد.(مناسب برای نرم افزارهای مختلف)
http://payamak-service.ir/SMSInOutBox/SendSms?username=*****&password=*****&from=*****&to=*****&text=*****
برای استفاده از وب سرویس در دات نت از آدرس زیر استفاده کنید.
برای استفاده از وب سرویس در php و java از آدرس زیر استفاده کنید.
برای ارسال از طریق متد Post از فرمت زير استفاده نماييد. (مناسب برای استفاده در نرم افزار هلو)
مقادیر UserName, Password, From, To, Message باید در قالب تگ فرم یا json به آدرس ذیل sumit شوندشوند
آدرس :
http://payamak-service.ir/SMSInOutBox/Send
برای ارسال از طریق متد Get نيز از فرمت زير استفاده نماييد.(مناسب برای نرم افزارهای مختلف)
http://payamak-service.ir/SMSInOutBox/SendSms?username=*****&password=*****&from=*****&to=*****&text=*****
|
نام پارامتر
|
نوع پارامتر
|
توضیحات
|
|---|---|---|
|
userName
|
string
|
نام کاربری مربوط به حساب شما در سامانه
|
|
password
|
string
|
رمز عبور مربوط به حساب شما در سامانه
|
|
مقدار بازگشتی
|
decimal
|
میزان اعتبار کاربر به پیامک می باشد مقدار اعتبار صفر یا عددی برزگتر از صفر می باشد در غیر اینصورت : 1 - نام کاربری و رمز عبور صحیح نمی باشد 2 - کاربر غیرفعال می باشد
|
|
نام پارامتر
|
نوع پارامتر
|
توضیحات
|
|---|---|---|
|
userName
|
string
|
نام کاربری مربوط به حساب شما در سامانه
|
|
password
|
string
|
رمز عبور مربوط به حساب شما در سامانه
|
|
isRead
|
bool
|
مقدار true برای پیامهای خوانده شده مقدار false برای پیامهای خوانده نشده
|
|
مقدار بازگشتی
|
int
|
اگر نام کاربری و رمز عبور صحیح باشد مقدار برگشتی یک عدد می باشد که بر اساس پارامتر isRead بیانگر تعداد پیامها دریافتی می باشد 1 - : نام کاربری و رمز عبور صحیح نمی باشد
|
|
نام پارامتر
|
نوع پارامتر
|
توضیحات
|
|---|---|---|
|
userName
|
string
|
نام کاربری مربوط به حساب شما در سامانه
|
|
password
|
string
|
رمز عبور مربوط به حساب شما در سامانه
|
|
fromNumber
|
string
|
شماره فرستنده
|
|
toNumbers
|
[] string
|
آرایه ای از شماره موبایل های گیرندگان می باشد حداکثر 100 شماره در هر بار فراخوانی
|
|
messageContent
|
string
|
متن پیامک
|
|
isFlash
|
bool
|
تعیین میکند آیا پیامک به صورت فلش ارسال گردد یا خیر
|
|
ref recId
|
[] int
|
هر خانه آرایه یک عدد یکتا به ازای هر گیرنده تولید می کند، این کد یکتا برای دریافت وضعیت تحویل کاربر دارد
|
|
ref status
|
[] byte
|
هر خانه آرایه عدد 0 یا 1 بوده به ازای هر گیرنده تولید می شود، 1 به معنی ارسال شده و 0 ارسال نشده
|
|
مقدار بازگشتی
|
int
|
0: ارسال با موفقیت انجام شد |
|
نام پارامتر
|
نوع پارامتر
|
توضیحات
|
|---|---|---|
|
userName
|
string
|
نام کاربری مربوط به حساب شما در سامانه
|
|
password
|
string
|
رمز عبور مربوط به حساب شما در سامانه
|
|
fromNumber
|
string
|
شماره فرستنده
|
|
toNumbers
|
[] string
|
آرایه ای از شماره موبایل های گیرندگان می باشد حداکثر 100 شماره در هر بار فراخوانی
|
|
messageContent
|
string
|
متن پیامک
|
|
isFlash
|
bool
|
تعیین میکند آیا پیامک به صورت فلش ارسال گردد یا خیر
|
|
out batchSmsId
|
int
|
شناسه ارسال گروهی
|
|
مقدار بازگشتی
|
int
|
0: ارسال با موفقیت انجام شد |
|
نام پارامتر
|
نوع پارامتر
|
توضیحات
|
|---|---|---|
|
userName
|
string
|
نام کاربری مربوط به حساب شما در سامانه
|
|
password
|
string
|
رمز عبور مربوط به حساب شما در سامانه
|
|
batchSmsId
|
int
|
شناسه ارسال با متد SendBatchSms
|
|
numbers
|
[] string
|
آرایه ای از شماره موبایل های گیرندگان می باشد
|
|
index
|
int
|
اندیس مربوط به ردیف پیام ارسالی، توجه مقدار اندیس از 1 شروع می شود.
|
|
count
|
int
|
تعداد رکورد درخواستی، حداکثر 100
|
|
deliveryStatus
|
[] int
|
آرایه ی از وضعیت تحویل متناظر با آرایه شماره موبایل ها می باشد |
|
مقدار بازگشتی
|
int
|
1 - : نام کاربری و رمز عبور صحیح نمی باشد 2 - : ارسال با مقدار شناسه batchSmsId وجود ندارد |
|
نام پارامتر
|
نوع پارامتر
|
توضیحات
|
|---|---|---|
|
userName
|
string
|
نام کاربری مربوط به حساب شما در سامانه
|
|
password
|
string
|
رمز عبور مربوط به حساب شما در سامانه
|
|
messageType
|
int
|
مشخص کننده نوع پیامک است، اگر 1 باشد پیامک های دریافتی و اگر 2 باشد پیامک های ارسالی را مشخص می کند
|
|
fromNumbers
|
[] string
|
آرایه ی از شماره های فرستنده می باشد مانند : 10002188
|
|
index
|
int
|
اندیس مربوط به ردیف پیام های دریافتی، توجه مقدار اندیس از 1 شروع می شود
|
|
count
|
int
|
تعداد رکورد درخواستی، حداکثر 1000
|
|
مقدار بازگشتی
|
[] MessageInfo
|
آرایه ی از نوع MessageInfo
|
|
FromDate
|
string
|
تاریخ شروع(شمسی) فرمت نمونه:1400/01/01
|
|
ToDate
|
string
|
تاریخ پایان(شمسی) فرمت نمونه:1400/10/01
|
|
تاریخ شروع و پایان اختیاری است،دو نسخه از این متد برای پوشش هر دو حالت تعبیه شده است
|
||
|
نام پارامتر
|
نوع پارامتر
|
توضیحات
|
|---|---|---|
|
userName
|
string
|
نام کاربری مربوط به حساب شما در سامانه
|
|
password
|
string
|
رمز عبور مربوط به حساب شما در سامانه
|
|
recId
|
long
|
شناسه پیامک ارسال شده
|
|
مقدار بازگشتی
|
int
|
وضعیت تحویل پیامک می باشد |
|
نام پارامتر
|
نوع پارامتر
|
توضیحات
|
|---|---|---|
|
userName
|
string
|
نام کاربری مربوط به حساب شما در سامانه
|
|
password
|
string
|
رمز عبور مربوط به حساب شما در سامانه
|
|
fromNumber
|
string
|
شماره فرستنده
|
|
toNumbers
|
[] string
|
آرایه ای از شماره موبایل های گیرندگان می باشد حداکثر 100 شماره در هر بار فراخوانی
|
|
messageContent
|
string
|
متن پیامک
|
|
isFlash
|
bool
|
تعیین میکند آیا پیامک به صورت فلش ارسال گردد یا خیر
|
|
ref recId
|
[] int
|
هر خانه آرایه یک عدد یکتا به ازای هر گیرنده تولید می کند، این کد یکتا برای دریافت وضعیت تحویل کاربر دارد
|
|
ref status
|
[] byte
|
هر خانه آرایه عدد 0 یا 1 بوده به ازای هر گیرنده تولید می شود، 1 به معنی ارسال شده و 0 ارسال نشده
|
|
مقدار بازگشتی
|
int
|
0: ارسال با موفقیت انجام شد |
|
نام پارامتر
|
نوع پارامتر
|
توضیحات
|
|---|---|---|
|
userName
|
string
|
نام کاربری مربوط به حساب شما در سامانه
|
|
password
|
string
|
رمز عبور مربوط به حساب شما در سامانه
|
|
fromNumber
|
string
|
شماره فرستنده
|
|
toNumbers
|
[] string
|
آرایه ای از شماره موبایل های گیرندگان می باشد حداکثر 100 شماره در هر بار فراخوانی
|
|
messageContent
|
string
|
متن پیامک
|
|
isFlash
|
bool
|
تعیین میکند آیا پیامک به صورت فلش ارسال گردد یا خیر
|
|
out batchSmsId
|
int
|
شناسه ارسال گروهی
|
|
مقدار بازگشتی
|
int
|
0: ارسال با موفقیت انجام شد |
|
نام پارامتر
|
نوع پارامتر
|
توضیحات
|
|---|---|---|
|
userName
|
string
|
نام کاربری مربوط به حساب شما در سامانه
|
|
password
|
string
|
رمز عبور مربوط به حساب شما در سامانه
|
|
recId
|
long
|
شناسه پیامک ارسال شده
|
|
مقدار بازگشتی
|
int
|
وضعیت تحویل پیامک می باشد |
|
نام پارامتر
|
نوع پارامتر
|
توضیحات
|
|---|---|---|
|
userName
|
string
|
نام کاربری مربوط به حساب شما در سامانه
|
|
password
|
string
|
رمز عبور مربوط به حساب شما در سامانه
|
|
مقدار بازگشتی
|
decimal
|
میزان اعتبار کاربر به پیامک می باشد مقدار اعتبار صفر یا عددی برزگتر از صفر می باشد در غیر اینصورت : 1 - نام کاربری و رمز عبور صحیح نمی باشد 2 - کاربر غیرفعال می باشد
|
|
نام پارامتر
|
نوع پارامتر
|
توضیحات
|
|---|---|---|
|
userName
|
string
|
نام کاربری مربوط به حساب شما در سامانه
|
|
password
|
string
|
رمز عبور مربوط به حساب شما در سامانه
|
|
isRead
|
bool
|
مقدار true برای پیامهای خوانده شده مقدار false برای پیامهای خوانده نشده
|
|
مقدار بازگشتی
|
int
|
اگر نام کاربری و رمز عبور صحیح باشد مقدار برگشتی یک عدد می باشد که بر اساس پارامتر isRead بیانگر تعداد پیامها دریافتی می باشد 1 - : نام کاربری و رمز عبور صحیح نمی باشد
|
|
نام پارامتر
|
نوع پارامتر
|
توضیحات
|
|---|---|---|
|
userName
|
string
|
نام کاربری مربوط به حساب شما در سامانه
|
|
password
|
string
|
رمز عبور مربوط به حساب شما در سامانه
|
|
batchSmsId
|
int
|
شناسه ارسال با متد SendBatchSms
|
|
numbers
|
[] string
|
آرایه ای از شماره موبایل های گیرندگان می باشد
|
|
index
|
int
|
اندیس مربوط به ردیف پیام ارسالی، توجه مقدار اندیس از 1 شروع می شود.
|
|
count
|
int
|
تعداد رکورد درخواستی، حداکثر 100
|
|
deliveryStatus
|
[] int
|
آرایه ی از وضعیت تحویل متناظر با آرایه شماره موبایل ها می باشد |
|
مقدار بازگشتی
|
int
|
1 - : نام کاربری و رمز عبور صحیح نمی باشد 2 - : ارسال با مقدار شناسه batchSmsId وجود ندارد |
|
نام پارامتر
|
نوع پارامتر
|
توضیحات
|
|---|---|---|
|
userName
|
string
|
نام کاربری مربوط به حساب شما در سامانه
|
|
password
|
string
|
رمز عبور مربوط به حساب شما در سامانه
|
|
messageType
|
int
|
مشخص کننده نوع پیامک است، اگر 1 باشد پیامک های دریافتی و اگر 2 باشد پیامک های ارسالی را مشخص می کند
|
|
fromNumbers
|
[] string
|
آرایه ی از شماره های فرستنده می باشد مانند : 10002188
|
|
index
|
int
|
اندیس مربوط به ردیف پیام های دریافتی، توجه مقدار اندیس از 1 شروع می شود
|
|
count
|
int
|
تعداد رکورد درخواستی، حداکثر 1000
|
|
مقدار بازگشتی
|
[] MessageInfo
|
آرایه ی از نوع MessageInfo
|
|
FromDate
|
string
|
تاریخ شروع(شمسی) فرمت نمونه:1400/01/01
|
|
ToDate
|
string
|
تاریخ پایان(شمسی) فرمت نمونه:1400/10/01
|
|
تاریخ شروع و پایان اختیاری است،دو نسخه از این متد برای پوشش هر دو حالت تعبیه شده است
|
||
