وب سرویس صدارس

وب سرویس ها برنامه (قطعه کد) هایی هستند که تحت وب قابل دسترسی اند و از طریق پروتکل های استانداردی مانند Http به انتقال و مبادله دیتا با سایر برنامه های کاربردی می پردازند. اساس کار وب سرویس (Web Service) ها بر پایه دریافت و تولید پیغام بنیان گذاری شده است. بدین معنی که آنها منتظر می مانند که کلاینت ها به آنها وصل شده و بنا به درخواست کلاینت ها به آن ها پاسخ می دهند . راه ارتباطی انتقال این پیغام ها یک آدرس است که شما میتوانید با افزودن آن در برنامه خود از خصوصیات آن استفاده نمائید

وب Api صدارس

مخفف چیست؟ API به معنی رابط کاربردی برنامه نویسی یا Application Programming Interface و همچنین جنبه اساسی تشکیل وب 2 است. اما واقعا API چیست؟ ما در این مطلب به توضیح این موضوع خواهیم پرداخت. این کلمه توجه خاصی به رابط یا Interface دارد. اگر شما هر گونه تجربه ای در برنامه نویسی داشته باشید، همه معانی و مخفف ها با شنیدن کلمه Interface به ذهنتان می آید؛ اما ما بیشتر علاقمند به دانستن معنی کلاسیک و معمولی آن هستیم. یک رابط (Interface) یک مرز مشترک بین دو سیستم و سرویس جدا است. از جمله می توان این موضوع را برداشت کرد که بین این دو سیستم ارتباط برقرار است.

شما در اینجا چه از وب سرویس استفاده نمائید و چه از وب Api متدهایی که میتوانید از آن استفاده نمائید یکسان هستند ، شما میتوانید متدها را با توضیحات کامل به علاوه ی ورودی ها و خروجی های آن مشاهده نمائید:
برای راحتی کار شما در پایان توضیحات هر متد نمونه کدهایی از زبان های رایج نیز برایتان فراهم شده است.

UploadMessage از طریق این متد میتوانید فایل صوتی خود را که در قالب wav با فرمت PCM 8000h 16k mono تنظیم کرده اید، در سامانه آپلود و در ارسال ها استفاده نمایید.

ورودی ها

نام نوع شرح
UserName String نام کاربری شما در سامانه صدارس
Password String رمز عبور شما در سامانه صدارس
Title String عنوان فایل صوتی شما
File Byte[ ] dicbinaryfile فایل صوتی شما که میبایست با پسوند wav و به صورت آرایه ای از نوع بایت باشد
فایل صوتی شما میبایست در قالب mono,8000Hz,16b بوده و حجم آن نیز از 5مگابایت بیشتر نباشد

خروجی ها

خروجی یک عدد از نوع int )کد [id] فایل آپلود شده در سامانه( می باشد.

نمونه کدها

UploadMessage

var webservice = new sedaras.WebService3();
OpenFileDialog openFileDialog1 = new OpenFileDialog();
try
{
    openFileDialog1.InitialDirectory = "c:\\";
    openFileDialog1.Filter = "wav files (*.wav)|*.wav|All files (*.*)|*.*";
    openFileDialog1.RestoreDirectory = true;
    if (openFileDialog1.ShowDialog() == DialogResult.OK)
    {
        Byte[] bytes = System.IO.File.ReadAllBytes(openFileDialog1.FileName);
        textBox2.Text = webservice.UploadMessage(_Username, _Password, textBox1.Text, bytes).ToString();
    }
}
catch (Exception ex)
{
    textBox2.Text = ex.Message;
}

DeleteMessage از طریق این متد می توانید فایل آپلود شده در سامانه را حذف نمایید.

ورودی ها

نام نوع شرح
UserName String نام کاربری شما در سامانه صدارس
Password String رمز عبور شما در سامانه صدارس
messageId int کد [id] فایل آپلود شده

خروجی ها

خروجی این متد از نوع Boolean میباشد. در صورتی که عملیات حذف با موفقیت انجام شود مقدار true و در غیر این صورت مقدار false برگردانده می شود.

نمونه کدها

DeleteMessage

var webservice = new sedaras.WebService3();
try
{
    textBox2.Text = webservice.DeleteMessage(_Username, _Password, Convert.ToInt32(textBox1.Text)).ToString();
}
catch (Exception ex)
{
    textBox2.Text = ex.Message;
}

CreateCampaign از طریق این متد میتوانید یک لیست ارسال ایجاد و در صورت تماید ارسال نمایید

ورودی ها

نام نوع شرح
userName string متن ساده
password string متن ساده
messageId int کد [id] فایل آپلود شده
title string عنوان لیست ارسال
numbers string شماره های لیست ارسال. شمارها باید با کما “,” از هم جدا شوند
maxTryCount int حداکثر تعداد تلاش برای هر شماره
minuteBetweenTries int مدت تاخیر بین تلاش ها بر اسا دقیقه
startDate string 2116-11- تاریخ شروع ارسال لیست به میلادی. مانند: 11
startTime string ساعت شروع ارسال لیست. مانند: 18:11
endDate string 2116-11- تاریخ خاتمه ارسال لیست به میلادی. مانند: 11
endTime string ساعت خاتمه ارسال لیست. مانند: 18:11
messageId int کد [id] پیام صوتی آپلود شده در سامانه
removeInvalids bool حذف شماره های اشتباه و تکراری بصورت خودکار
autoStart bool شروع خودکار لیست پس از ایجاد
vote bool فعال سازی امکان نظرسنجی بر روی تماس ها

خروجی ها

خروجی یک عدد از نوع int )کد [id] لیست ارسال ایجاد شده در سامانه( می باشد.

نمونه کدها

CreateCampaign

var webservice = new sedaras.WebService3();
try
{
    txtResult.Text = webservice.CreateCampaign(_Username, _Password,
        txtTitle.Text,
        txtNumbers.Text,
        Convert.ToInt32(ddlMaxTryCount.Text),
        Convert.ToInt32(ddlMinuteBetweenTry.Text),
        dtpStartDate.Value.Date.ToShortDateString(),
        txtStartTime.Text,
        dtpEndDate.Value.Date.ToShortDateString(),
        txtEndTime.Text,
        Convert.ToInt32(ddlMessages.SelectedValue),
        cbRemoveInvalids.Checked,
        cbStart.Checked,
        cbVote.Checked).ToString();
}
catch (Exception ex)
{
    MessageBox.Show(ex.Message, "خطا", MessageBoxButtons.OK, MessageBoxIcon.Exclamation);
}

StartCampaign Method از طریق این متد می توانید اقدام به ارسال یک لیست ارسال ایجاد شده نمایید.

ورودی ها

نام نوع شرح
username string متن ساده
password string string
campaignid int کد [id] لیست ارسال موردنظر
title string عنوان لیست ارسال
numbers string شماره های لیست ارسال. شمارها باید با کما “,” از هم جدا شوند
maxtrycount int حداکثر تعداد تلاش برای هر شماره
minutebetweentries int مدت تاخیر بین تلاش ها بر اسا دقیقه
startdate string 2116-11- تاریخ شروع ارسال لیست به میلادی. مانند: 11
starttime string ساعت شروع ارسال لیست. مانند: 18:11
enddate string 2116-11- تاریخ خاتمه ارسال لیست به میلادی. مانند: 11
endtime string ساعت خاتمه ارسال لیست. مانند: 18:11

خروجی ها

خروجی این متد از نوع Boolean میباشد. در صورتی که عملیات شروع لیست ارسال با موفقیت انجام شود مقدار true و در غیر این صورت مقدار false برگردانده می شود.

نمونه کدها

StartCampaign

نمونه کدهای سی شارپ

StopCampaign از طریق این متد می توانید اقدام به توقف یک لیست ارسال ایجاد شده و درحال ارسال نمایید.

ورودی ها

نام نوع شرح
UserName String نام کاربری شما در سامانه صدارس
Password String رمز عبور شما در سامانه صدارس
campaignId int کد [id] لیست ارسال موردنظر

خروجی ها

خروجی این متد از نوع Boolean میباشد. در صورتی که عملیات توقف لیست ارسال با موفقیت انجام شود مقدار true و در غیر این صورت مقدار false برگردانده می شود.

نمونه کدها

StopCampaign

var webservice = new sedaras.WebService3();
try
{
    textBox2.Text = webservice.StopCampaign(_Username, _Password, Convert.ToInt32(textBox1.Text)).ToString();
}
catch (Exception ex)
{
    textBox2.Text = ex.Message;
}

GetCampaignByDateمــــتد دریافت نام و شماره شناسایی کاربــر

ورودی ها

نام نوع شرح
username string متن ساده
password string متن ساده
fromdate string 2116-11- تاریخ شروع به میلادی. مانند: 11
todate string 2116-11- تاریخ پایان به میلادی. مانند: 11

خروجی ها

خروجی این متد لیستی از لیست های ارسال ایجاد شده در بازه زمانی تعیین شده می باشد.

نمونه کدها

GetCampaignsByDate

var webservice = new sedaras.WebService3();
try
{
    dataGridView1.DataSource = webservice.GetCampaignsByDate(_Username, _Password, dateTimePicker1.Value.ToShortDateString(), dateTimePicker2.Value.ToShortDateString());
}
catch (Exception ex)
{
    MessageBox.Show(ex.Message, "خطا", MessageBoxButtons.OK, MessageBoxIcon.Exclamation);
}

GetCampaignById از طریق این متد می توانید اطلاعات یک لیست های ایجاد شده را بر اساس کد [id] لیست دریافت نمایید.

ورودی ها

نام نوع شرح
UserName String نام کاربری شما در سامانه صدارس
Password String رمز عبور شما در سامانه صدارس
campaignId Int کد [id] لیست ارسال

خروجی ها

خروجی این متد اطلاعات لیست ارسال مورد نظر می باشد.
کد وضعیت لیست ارسال ) Status :)
مقدار خروجی عنوان خروجی
-1 عدم تائید
0 در انتظار
1 تائید شده
2 در حال ارسال
3 تمام شده
4 متوقف شده

نمونه کدها

GetCampaignById

var webservice = new sedaras.WebService3();
try
{
    var model = webservice.GetCampaignById(_Username, _Password, Convert.ToInt32(textBox1.Text));
    var datatable = new DataTable();
    datatable.Columns.Add("property");
    datatable.Columns.Add("value");
    foreach (PropertyInfo propertyInfo in model.GetType().GetProperties())
    {
        var dr = datatable.NewRow();
        dr["property"] = propertyInfo.Name;
        dr["value"] = propertyInfo.GetValue(model, null);
        datatable.Rows.Add(dr);
    }
    dataGridView1.DataSource = datatable;
}
catch (Exception ex)
{
    MessageBox.Show(ex.Message, "خطا", MessageBoxButtons.OK, MessageBoxIcon.Exclamation);
}

GetCampaignNumbersByCampaignId از طریق این متد می توانید اطلاعات شماره های داخل یک لیست ارسال را بر اساس کد [id] لیست دریافت نمایید.

ورودی ها

نام نوع شرح
UserName String نام کاربری شما در سامانه صدارس
Password String رمز عبور شما در سامانه صدارس
campaignId Int کد [id] لیست ارسال

خروجی ها

خروجی این متد لیست اطلاعات شماره های داخل لیست ارسال مورد نظر می باشد.

نمونه کدها

GetCampaignNumbersByCampaignId

var webservice = new sedaras.WebService3();
try
{
    dataGridView1.DataSource = webservice.GetCampaignNumbersByCampaignId(_Username, _Password, Convert.ToInt32(textBox1.Text));
}
catch (Exception ex)
{
    MessageBox.Show(ex.Message, "خطا", MessageBoxButtons.OK, MessageBoxIcon.Exclamation);
}

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

ورودی ها

نام نوع شرح
UserName String نام کاربری شما در سامانه صدارس
Password String رمز عبور شما در سامانه صدارس
fromDate string 2116-11- تاریخ شروع به میلادی. مانند: 11
toDate string 2116-11- تاریخ پایان به میلادی. مانند: 11

خروجی ها

خروجی این متد لیست اطلاعات شماره های ارسال شده داخل لیست ارسال مختلف در بازه زمانی مورد نظر می باشد.

نمونه کدها

GetCampaignNumbersBySendDate

نمونه کدهای سی شارپ

GetCampaignNumbersDataByIds از طریق این متد می توانید با ارسال رشته ای از کد های شماره )جدا شده توسط کاما “,” (، اطلاعات آنها را در قالب یک لیست دریافت نمایید

ورودی ها

نام نوع توضیحات
UserName String نام کاربری شما در سامانه صدارس
Password String رمز عبور شما در سامانه صدارس
campaignNumberIds string رشته ای از کد های شماره )جدا شده توسط کاما “,” ) .

خروجی ها

خروجی این متد لیست اطلاعات شماره های ارسال شده داخل لیست ارسال مختلف در بازه زمانی مورد نظر می باشد.

نمونه کدها

GetCampaignNumbersDataByIds

var webservice = new sedaras.WebService3();
try
{
    dataGridView1.DataSource = webservice.GetCampaignNumbersDataByIds(_Username, _Password, textBox1.Text);
}
catch (Exception ex)
{
    MessageBox.Show(ex.Message, "خطا", MessageBoxButtons.OK, MessageBoxIcon.Exclamation);
}

GetCampaignNumberStatusById از طریق این متد می توانید وضعیت ارسال یک شماره خاص را دریافت نمایید

ورودی ها

نام نوع توضیحات
UserName String نام کاربری شما در سامانه صدارس
Password String رمز عبور شما در سامانه صدارس
campaignNumberId int کد [id] شماره

خروجی ها

خروجی این متد یک عدد از نوع صحیح می باشد که مشخص کننده وضعیت ارسال شما است.
مقدار خروجی عنوان خروجی
-3 ارسال شده
-2 در انتظار
-1 موفق
0 عدم دسترسی
1,3 عدم پاسخ
5,8 مشغولی

نمونه کدها

GetCampaignNumberStatusById

var webservice = new sedaras.WebService3();
try
{
    var model = webservice.GetCampaignNumberStatusById(_Username, _Password, Convert.ToInt32(textBox1.Text));
    var datatable = new DataTable();
    datatable.Columns.Add("property");
    datatable.Columns.Add("value");
    foreach (PropertyInfo propertyInfo in model.GetType().GetProperties())
    {
        var dr = datatable.NewRow();
        dr["property"] = propertyInfo.Name;
        dr["value"] = propertyInfo.GetValue(model, null);
        datatable.Rows.Add(dr);
    }
    dataGridView1.DataSource = datatable;
}
catch (Exception ex)
{
    MessageBox.Show(ex.Message, "خطا", MessageBoxButtons.OK, MessageBoxIcon.Exclamation);
}

GetCampaignNumbersStatusByIds از طریق این متد می توانید با ارسال رشته ای از کد های شماره )جدا شده توسط کاما “,” (، وضعیت آنها را در قالب یک لیست دریافت نمایید

ورودی ها

نام نوع توضیحات
UserName String نام کاربری شما در سامانه صدارس
Password String رمز عبور شما در سامانه صدارس
campaignNumberIds string رشته ای از کد های شماره )جدا شده توسط کاما “,” ) .

خروجی ها

خروجی این متد لیست وضعیت شماره های ارسال شده داخل لیست ارسال مختلف در قالب یک رشته بصورت جداشده با کاما می باشد.
مقدار خروجی عنوان خروجی
-3 ارسال شده
-2 در انتظار
-1 موفق
0 عدم دسترسی
1,3 عدم پاسخ
5,8 مشغولی

نمونه کدها

GetCampaignNumbersStatusByIds

var webservice = new sedaras.WebService3();
try
{
    var model = webservice.GetCampaignNumbersStatusByIds(_Username, _Password, textBox1.Text);
    string result = "";
    foreach (var item in model)
    {
        result = item.ToString() + ",";
    }
    textBox2.Text = result;
}
catch (Exception ex)
{
    MessageBox.Show(ex.Message, "خطا", MessageBoxButtons.OK, MessageBoxIcon.Exclamation);
}

QuickSend از طریق این متد می توانید برای یک شماره ارسال سریع انجام دهید.

ورودی ها

نام نوع توضیحات
UserName String نام کاربری شما در سامانه صدارس
Password String رمز عبور شما در سامانه صدارس
messageId id کد [id] لیست پیام آپلود شده
number string شماره تماس
vote bool فعال سازی نظرسنجی بر روی ارسال

خروجی ها

خروجی این متد یک عدد از نوع int برابر با کد [id] ارسال سریع انجام شده می باشد.

نمونه کدها

QuickSend

var webservice = new sedaras.WebService3();
try
{
    textBox2.Text = webservice.QuickSend(_Username, _Password, Convert.ToInt32(textBox3.Text), textBox1.Text, checkBox1.Checked).ToString();
}
catch (Exception ex)
{
    textBox2.Text = ex.Message;
}

GetQuickSend از طریق این متد می توانید اطلاعات یک ارسال سریع را بر اساس کد [id] آن دریافت نمایید.

ورودی ها

نام نوع توضیحات
UserName String نام کاربری شما در سامانه صدارس
Password String رمز عبور شما در سامانه صدارس
quickSendId id کد [id] ارسال سریع
price decimal این پارامتر بصورت byref می باشد و پس از اجرای متد مقدار آن برابر با هزینه ارسال می باشد

خروجی ها

خروجی این متد از نوع CDRDetails میباشد وشامل کلیه اطلاعات ارسال سریع است.

نمونه کدها

GetQuickSend

var webservice = new sedaras.WebService3();
try
{
    decimal price = 0;
    var model = webservice.GetQuickSend(_Username, _Password, Convert.ToInt32(textBox1.Text),ref price);
    var datatable = new DataTable();
    datatable.Columns.Add("property");
    datatable.Columns.Add("value");
    foreach (PropertyInfo propertyInfo in model.GetType().GetProperties())
    {
        var dr = datatable.NewRow();
        dr["property"] = propertyInfo.Name;
        dr["value"] = propertyInfo.GetValue(model, null);
        datatable.Rows.Add(dr);
    }
    dataGridView1.DataSource = datatable;
    textBox2.Text = price.ToString();
}
catch (Exception ex)
{
    MessageBox.Show(ex.Message, "خطا", MessageBoxButtons.OK, MessageBoxIcon.Exclamation);
}

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

ورودی ها

نام نوع توضیحات
UserName String نام کاربری شما در سامانه صدارس
Password String رمز عبور شما در سامانه صدارس
fromDate string 2116-11- تاریخ شروع به میلادی. مانند: 11
toDate string 2116-11- تاریخ پایان به میلادی. مانند: 11

خروجی ها

خروجی این متد از نوع عدد اعشاری برابر با مجموعه هزینه ارسال ها در بازه مشخص شده می باشد.

نمونه کدها

GetTotalCostByDate

var webservice = new sedaras.WebService3();
try
{
    textBox1.Text = webservice.GetTotalCostByDate(_Username, _Password, dateTimePicker1.Value.ToShortDateString(), dateTimePicker2.Value.ToShortDateString()).ToString();
}
catch (Exception ex)
{
    MessageBox.Show(ex.Message, "خطا", MessageBoxButtons.OK, MessageBoxIcon.Exclamation);
}

GetMessages از طریق این متد می توانید لیست کلیه پیام های آپلود شده در سامانه را دریافت نمایید.

ورودی ها

نام نوع توضیحات
UserName String نام کاربری شما در سامانه صدارس
Password String رمز عبور شما در سامانه صدارس

خروجی ها

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

نمونه کدها

GetMessages

var webservice = new sedaras.WebService3();
dataGridView1.DataSource = webservice.GetMessages(_Username, _Password);

GetCredit از طریق این متد می توانید اعتبارموجود پنل خود را دریافت نمایید

ورودی ها

نام نوع توضیحات
UserName String نام کاربری شما در سامانه صدارس
Password String رمز عبور شما در سامانه صدارس

خروجی ها

خروجی این متد از نوع عدد اعشاری برابر با اعتبار موجود پنل به ریال می باشد.

نمونه کدها

GetCredit

var webservice = new sedaras.WebService3();
try
{
    textBox1.Text = webservice.GetCredit(_Username, _Password).ToString();
}
catch (Exception ex)
{
    textBox1.Text = ex.Message;
}

GetExpirationDate از طریق این متد می توانید تاریخ انقضا پنل را دریافت نمایید.

ورودی ها

نام نوع توضیحات
UserName String نام کاربری شما در سامانه صدارس
Password String رمز عبور شما در سامانه صدارس

خروجی ها

خروجی این متد از نوع رشته ای برابر با تاریخ شمسی انقضا پنل می باشد.

نمونه کدها

GetExpirationDate

var webservice = new sedaras.WebService3();
try
{
    textBox1.Text = webservice.GetExpirationDate(_Username, _Password).ToString();
}
catch (Exception ex)
{
    textBox1.Text = ex.Message;
}

GetPrices از طریق این متد می توانید تعرفه های گنل خود را دریافت نمایید

ورودی ها

نام نوع توضیحات
UserName String نام کاربری شما در سامانه صدارس
Password String رمز عبور شما در سامانه صدارس

خروجی ها

خروجی این متد از نوع PriceViewModel برابر با تعرفه های پنل می باشد.

نمونه کدها

GetPrices

var webservice = new sedaras.WebService3();
try
{
    var model = webservice.GetPrices(_Username, _Password);
    var datatable = new DataTable();
    datatable.Columns.Add("property");
    datatable.Columns.Add("value");
    foreach (PropertyInfo propertyInfo in model.GetType().GetProperties())
    {
        var dr = datatable.NewRow();
        dr["property"] = propertyInfo.Name;
        dr["value"] = propertyInfo.GetValue(model, null);
        datatable.Rows.Add(dr);
    }
    dataGridView1.DataSource = datatable;
}
catch (Exception ex)
{
    MessageBox.Show(ex.Message, "خطا", MessageBoxButtons.OK, MessageBoxIcon.Exclamation);
}