هاست ایران | لوگو
هاست ایران | منو

مستندات استفاده از پنل پیامکی هاست ایران

تنظیمات اتصال

برای اتصال به وب‌ سرویس‌ پنل پیامکی هاست‌ایران،
1) ابتدا از پروفایل کاربری خود BASE_URL و TOKEN را بردارید.
2) سپس با در نظر گرفتن پارامترهای هدر و مستندات فنی ذیل به وب‌سرویس متصل شوید.

ارسال پیامک

با استفاده از درخواست "ارسال پیامک" می‌توانید به حداگثر 100 گیرنده در هر بار فراخوانی پیامک ارسال کنید.

https://rest.payamak-panel.com/api/SendSMS/SendSMS
POST

POST

                                {
                                      "token": "{TOKEN}"
                                }
                 
                                {
                                      username: "example-name",
                                      password: "SDFh3456@#dhv",
                                      to: "09120000000",
                                      from: "10001234",
                                      text: "این متن تستی پیامک است",
                                      isFlash: false
                                }

پارامتر های ورودی :

نام پارامترنوعتوضیح
usernameاجباریStringنام کاربری مربوط به حساب شما در سامانه
passwordاجباریStringکلمه عبور مربوط به حساب شما در سامانه
toاجباریStringشماره گیرنده،جهت ارسال بیش از یک شماره می توانید با کاراکتر »,« جدا نمایید.
fromاجباریStringشماره اختصاصی فرستنده
textاجباریStringمتن پیامک
isFlashBoolتعیین می کند آیا پیامک بصورت فلش ارسال گردد یا خیر

نمونه پاسخ :

                                {
                                  “Value”: “recID,…”,
                                  “RetStatus”: 1,
                                  “StrRetStatus”: “Ok”
                                }

دریافت وضعیت ارسال

با استفاده از درخواست "دریافت وضعیت ارسال" می‌توانید وضعیت پیامک ارسال شده را دریافت کنید.

https://rest.payamak-panel.com/api/SendSMS/GetDeliveries2
POST

POST

                                {
                                      "token": "{TOKEN}"
                                }
                 
                                {
                                      username: "example-name",
                                      password: "SDFh3456@#dhv",
                                      recID: "999999999999999654367675LsdgfSS",
                                }

پارامتر های ورودی :

نام پارامترنوعتوضیح
usernameاجباریStringنام کاربری مربوط به حساب شما در سامانه
passwordاجباریStringکلمه عبور مربوط به حساب شما در سامانه
recIDاجباریlongکد recID که در هنگام ارسال پیامک دریافت کرده اید.

نمونه پاسخ :

                                {
                                  “Value”: “Status”,
                                  “RetStatus”: 1,
                                  “StrRetStatus”: “Ok”
                                }

دریافت لیست پیامک ها

با استفاده از درخواست "دریافت لیست پیامک ها" می‌توانید لیست پیامک های ارسال و یا دریافتی را دریافت کنید.

https://rest.payamak-panel.com/api/SendSMS/GetMessages
POST

POST

                                {
                                      "token": "{TOKEN}"
                                }
                 
                                {
                                      username: "example-name",
                                      password: "SDFh3456@#dhv",
                                      location: 1,
                                      from: "10001234",
                                      index: 0,
                                      count: 50
                                }

پارامتر های ورودی :

نام پارامترنوعتوضیح
usernameاجباریStringنام کاربری مربوط به حساب شما در سامانه
passwordاجباریStringکلمه عبور مربوط به حساب شما در سامانه
locationاجباریIntاجباری مشخص کننده نوع پیامک است، اگر 1 باشد پیامک های دریافتی، اگر 2 باشد پیامک های ارسالی را مشخص می کند.
fromStringشماره فرستنده ( مثال : 10001234 ) در صورت خالی گذاشتن این پارامتر، پیام های کلیه شماره ها دریافت می شود.
indexاجباریIntاندیس مربوط به ردیف پیام ها می باشد، پیشنهاد می گردد این مقدار را 0 در نظر بگیرید.
countInt تعداد را می توانید تنظیم نمایید. در هربارفراخوانی حداکثر 100 رکورد مجاز می باشد.

نمونه پاسخ :

                    {
                            "MyBase":{
                                 "Value": "Ok"
                                 "RetStatus": 1,
                                 "StrRetStatus": "Ok"
                            },
                            "Data":[{
                                 "MsgID": 45163…,
                                 "Body": "Test…",
                                 "SendDate": "2017-06-05T15:42:58.68T,
                                 "Sender": "10002…",
                                 "Receiver": "912…",
                                 "FirstLocation": 2,
                                 "CurrentLocation": 2,
                                 "Parts": 1,
                                 "RecCount": 1,
                                 "RecFailed": 0,
                                 "RecSuccess": 0,
                                 "IsUnicode": true
                            }]
                    }

دریافت موجودی پیامک

با استفاده از درخواست "دریافت موجودی پیامک" می‌توانید موجودی پیامک را دریافت کنید.

https://rest.payamak-panel.com/api/SendSMS/GetCredit
POST

POST

                                {
                                      "token": "{TOKEN}"
                                }
                 
                                {
                                      username: "example-name",
                                      password: "SDFh3456@#dhv",
                                }

پارامتر های ورودی :

نام پارامترنوعتوضیح
usernameاجباریStringنام کاربری مربوط به حساب شما در سامانه
passwordاجباریStringکلمه عبور مربوط به حساب شما در سامانه

نمونه پاسخ :

                                {
                                  "Value": "Status",
                                  “RetStatus”: 1,
                                  “StrRetStatus”: “Ok”
                                }

دریافت تعرفه پایه

با استفاده از درخواست "دریافت تعرفه پایه" می‌توانید تعرفه پایه پیامک را دریافت کنید.

https://rest.payamak-panel.com/api/SendSMS/GetBasePrice
POST

POST

                                {
                                      "token": "{TOKEN}"
                                }
                 
                                {
                                      username: "example-name",
                                      password: "SDFh3456@#dhv",
                                }

پارامتر های ورودی :

نام پارامترنوعتوضیح
usernameاجباریStringنام کاربری مربوط به حساب شما در سامانه
passwordاجباریStringکلمه عبور مربوط به حساب شما در سامانه

نمونه پاسخ :

                                {
                                  "Value": "Status",
                                  “RetStatus”: 1,
                                  “StrRetStatus”: “Ok”
                                }

دریافت لیست شماره اختصاصی

با استفاده از درخواست "دریافت لیست شماره اختصاصی" می‌توانید لیست شماره های اختصاصی را دریافت کنید.

https://rest.payamak-panel.com/api/SendSMS/GetUserNumbers
POST

POST

                                {
                                      "token": "{TOKEN}"
                                }
                 
                                {
                                      username: "example-name",
                                      password: "SDFh3456@#dhv",
                                }

پارامتر های ورودی :

نام پارامترنوعتوضیح
usernameاجباریStringنام کاربری مربوط به حساب شما در سامانه
passwordاجباریStringکلمه عبور مربوط به حساب شما در سامانه

نمونه پاسخ :

                                {
                                  "MyBase":{
                                      "Value": "Ok",
                                      "RetStatus": 1,
                                      "StrRetStatus": "Ok"
                                  },
                                  "Data":[
                                      {
                                          "Number": "1000912....."
                                      },
                                  ]
                                }