وب سرویس دریافت خطوط فعال برای ارسال پیامک
جهت دریافت شماره خط های فعال برای ارسال پیامک می بایست آدرس زیر را به صورت POST فراخوانی کنید
پارامترهای ورودی جهت دریافت خطوط فعال برای ارسال پیامک به صورت زیر می باشد
پارامتر ورودی | توضیحات |
---|---|
Token | توکن دریافتی از طریق پنل |
پاسخ دریافتی به صورت JSON و شامل موارد زیر می باشد
پارامتر | توضیحات |
---|---|
LineNumber | شماره خط |
LineType | نوع خط |
PriceEn | مبلغ پیامک انگلیسی |
PriceFa | مبلغ پیامک فارسی |
وب سرویس ارسال پیامک
وب سرویس جاری به شما این امکان را می دهد تا به یک یا چند شماره به صورت همزمان پیامک ارسال کنید و همچنین میتوانید وضعیت ارسال پیامک (SMS Delivery) را بررسی کنید
برای ارسال پیامک می بایست پارامترهای مورد نیاز را به صورت GET به WebAPI مورد نظر با آدرس زیر ارسال کنید :
ورودی های وب سرویس ارسال پیامک به شرح زیر می باشد
پارامتر ورودی | توضیحات |
---|---|
Token | توکن دریافتی از طریق پنل |
LineNo | شماره ای که پیامک از طریق آن ارسال خواهد شد (در صورتی که برابر 0 قرار گیرد خط پیش فرض انتخاب خواهد شد) |
MobileNumbers | شماره موبایل دریافت کننده پیامک (در صورتی که چندین دریافت کننده وجود دارد، شماره ها را با کاما از یکدیگر جدا کنید) |
Message | متن پیام |
در صورتی که قصد داشته باشید از طریق URL سرویس را فراخوانی کنید فرمت ارسال می بایست به شکل زیر باشد
نمونه کد C# جهت ارسال پیامک
USSD.CS
private void SendSMS()
{
using (var client = new HttpClient())
{
client.BaseAddress = new Uri("https://restful.inoti.com/");
string Token = "23-33-29-44-6D-46-49-67-59-3D";
string LineNo = "0";
string MobileNumbers = "09121234567,09351234567,09191234567";
string Message = "سلام";
var responseTask = client.GetAsync(string.Format("api/SMSAPI/SendSMS/{0}/{1}/{2}/{3}" ,Token, LineNo, MobileNumbers, Message));
var result = responseTask.Result;
}
}
پاسخ دریافتی
پاسخ دریافتی به صورت JSON می باشد که شامل دو متغیر Result و AccountStatus می باشد
مقادیر Result به شرح زیر می باشد
Result | توضیحات |
---|---|
عدد بزرگتر از صفر (کد پیگیری پیامک) | پیامک با موفقیت ارسال شد |
-1 | کاربر وجود ندارد و یا وضعیت کاربر فعال نیست |
-2 | شماره خط ارسال کننده پیامک معتبر نیست |
-4 | اعتبار نقدی کاربر برای ارسال پیامک کافی نیست |
-5 | متن پیام خالی است |
-6 | کاربر احراز هویت نشده است |
-20 | توکن وارد شده معتبر نیست |
-21 | توکن وارد شده منقضی شده است |
مقادیر AccountStatus نیز به شرح زیر می باشد
AccountStatus | توضیحات |
---|---|
1 | فعال |
2 | دسترسی شما محدود شده است با پشتیبانی خود تماس حاصل فرمایید |
3 | دسترسی شما به دلیل عدم تطبیق مدارک و اطلاعات ثبت شده، محدود شده است |
4 | به دلیل تخلف دسترسی شما معلق و محدود شده است. |
5 | تا تایید واحد بررسی دسترسی شما محدود شده است |
6 | تا تایید واحد بررسی دسترسی شما محدود شده است |
7 | به دلیل تخلف از قوانین و مقررات آی نوتی موقعیت شما مسدود گردید |
8 | جایگاه شما به دلیل درخواست خودتان لغو شده است در صورتی که تمایل به فعال سازی مجدد، قبل از شروع ماه شمسی جدید با شرکت تماس گرفته و درخواست بازیابی جایگاه نمایید |
9 | ثبت نام شما در حال بررسی می باشد، شما قبل از تایید اطلاعات هویتی نمی توانید اقدام به خرید،ارسال و ... نمایید. لطفا شکیبا باشید تا حساب کاربری شما بررسی و تایید گردد |
نمونه JSON دریافتی
{
"Result": 12345,
"AccountStatus": 1
}
وب سرویس دریافت وضعیت پیامک ارسال شده
برای دریافت وضعیت پیامک ارسال شده می بایست پارامترهای مورد نیاز را به صورت GET به WebAPI مورد نظر با آدرس زیر ارسال کنید:
ورودی های وب سرویس دریافت وضعیت پیامک ارسال شده به شرح زیر می باشد
پارامتر ورودی | توضیحات |
---|---|
Token | توکن دریافتی از طریق پنل |
LineNo | شماره ای که پیامک از طریق آن ارسال شده است |
SMSID | کد پیگیری ای که در هنگام ارسال پیامک تکی و یا گروهی دریافت کردید |
در صورتی که قصد داشته باشید از طریق URL سرویس را فراخوانی کنید فرمت ارسال می بایست به شکل زیر باشد
نمونه کد C# جهت دریافت وضعیت پیامک ارسال شده
USSD.CS
private void SendSMS()
{
using (var client = new HttpClient())
{
client.BaseAddress = new Uri("https://restful.inoti.com/");
string Token = "23-33-29-44-6D-46-49-67-59-3D";
string LineNo = "100009999";
string SMSID = "435436";
var responseTask = client.GetAsync(string.Format("api/SMSAPI/SMSDelivery/{0}/{1}/{2}" ,Token, LineNo, SMSID));
var result = responseTask.Result;
}
}
پاسخ دریافتی
پاسخ دریافتی شامل لیستی از مشخصات دریافت کنندگان پیامک می باشد که به صورت JSON نمایش داده می شود و متغیرهای آن به شرح زیر می باشد
پارامتر | توضیحات |
---|---|
ResultCode | نتیجه فراخوانی سرویس |
Mobile | شماره موبایل مقصد |
Status | وضعیت ارسال |
LastDeliverDateTime | آخرین تاریخ تغییر وضعیت ارسال |
پارامتر ResultCode نشان دهنده نتیجه فراخوانی سرویس می باشد که میتواند شامل مقادیر زیر باشد
Description | Result |
---|---|
پیامک مورد نظر یافت نشد | 0 |
کاربر وجود ندارد و یا وضعیت کاربر فعال نیست | -1 |
شماره خط ارسال کننده پیامک معتبر نیست | -2 |
کد پیگیری صحیح نمیباشد | -4 |
متن پیام خالی است | -5 |
کاربر احراز هویت نشده است | -6 |
توکن وارد شده معتبر نیست | -20 |
توکن وارد شده منقضی شده است | -21 |
عملیات با موفقیت انجام شد | 1 |
پارامتر Status نیز که نشان دهنده وضعیت ارسال است شامل مقادیر زیر می باشد
Status | توضیحات |
---|---|
1 | در انتظار دریافت گزارش |
2 | رسیده به مخابرات |
3 | ناموفق |
4 | موفق |
5 | لیست سیاه |
6 | لغو شده |
7 | تحویل آنتن BTS |
نمونه JSON دریافتی
{
"ResultCode": 1,
"deliveryLists": [
{
"Mobile": "09121234567",
"Status": 1,
"LastDeliverDateTime": "2020-01-01T09:10:00"
},
{
"Mobile": "09351234567",
"Status": 1,
"LastDeliverDateTime": "2020-01-01T09:10:00"
}
]
}