مستندات برنامه نویسی

مستندات تعاملی API آماده است! می‌توانید اندپوینت‌ها را آنلاین مشاهده و تست کنید.

مقدمه

مستند حاضر براي استفاده آن دسته از برنامه نویسانی طراحی شده است که می خواهند از سرویس RestFul سامانه پیامک لیمو اس ام اس استفاده نمایند. در این راهنما روش ها و دستورات مورد نیاز برنامه نویسان در هنگام استفاده از سرویس RestFul شرح داده شده است . سرویس RestFul به دلیل سادگی پیاده سازي و حمایت از تمامی زبانهاي برنامه نویسی از جمله محبوب ترین روش هاي مورد استفاده جهت ارسال پیام از طریق نرم افزار می باشد

سرویس soap api

برای استفاده از سرویس soap api لطفا از آدرس https://soap.limosms.com/Service.asmx استفاده کنید.

شروع به کار

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

مستندات تعاملی (Swagger و Scalar)

تمام اندپوینت‌ها با امکان ارسال درخواست آنلاین در دو رابط کاربری قابل مشاهده است. برای تست، مقدار ApiKey خود را در بخش Authorize وارد کنید.

باز کردن Swagger UI باز کردن Scalar UI

متد ارسال پیام

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

https://api.limosms.com/api/sendsms Post

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

ردیف	نام پارامتر	نوع	توضیحات
1	SenderNumber	string	شماره خط ارسال کننده پیام
2	Message	string	متن پیامک
3	MobileNumber	[ ] string	زمان ارسال پیام ( در صورت خالی بودن پیام در لحظه ارسال می‌شود )
4	SendToBlocksNumber	boolean	ارسال به شماره های بلاک شده
5	SendTimeSpan	double	زمان ارسال پیام ( در صورت خالی بودن پیام در لحظه ارسال می‌شود )

پارامتر خروجی

ردیف	نام پارامتر	نوع	توضیحات
1	Success	boolean	نتیجه ارسال پیام
2	Message	string	توضیحات ارسال پیام
3	MessageId	[ ] string	شناسه پیام ها برای دریافت وضعیت ارسال

نمونه کد

var client = new HttpClient();
string[] receiver = { "شماره موبایل"};
var data = new
{
Message = "متن پیام",
SenderNumber = "شماره ی فرستنده",
MobileNumber = receiver,
SendToBlocksNumber = true
};
var url = "https://api.limosms.com/api/sendsms";
client.DefaultRequestHeaders.Add("ApiKey", "کد دسترسی شما");
var objectStr = JsonConvert.SerializeObject(data);
var content = new StringContent(objectStr, Encoding.UTF8, "application/json");
var response = client.PostAsync(url, content).Result;
string resultContent = await response.Content.ReadAsStringAsync();
return resultContent;

$url ='https://api.limosms.com/api/sendsms';
$receiver = array("گیرندگان");
$post_data = json_encode(array(
'Message' =>'متن پیام' ,
'SenderNumber' => 'فرستنده',
'MobileNumber' => $receiver,
));
$process = curl_init();
curl_setopt( $process,CURLOPT_URL,$url);
curl_setopt( $process, CURLOPT_TIMEOUT,30);
curl_setopt( $process, CURLOPT_POST, 1);
curl_setopt($process, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt( $process, CURLOPT_POSTFIELDS, $post_data);
curl_setopt( $process, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt( $process, CURLOPT_FOLLOWLOCATION, true);
curl_setopt( $process, CURLOPT_HTTPHEADER, array('Content-Type: application/json'
,'ApiKey:کد دسترسی شما'));
$return = curl_exec( $process);
$httpcode = curl_getinfo( $process, CURLINFO_HTTP_CODE);
curl_close($process);
$decoded = json_decode($return);
print_r($decoded);

import requests
url = 'https://api.limosms.com/api/sendsms'
receiver = ["گیرندگان"]
myobj = {'Message' :'متن پیام',
'SenderNumber' : 'فرستنده',
'MobileNumber' : receiver}
x = requests.post(url, json = myobj, headers = {"ApiKey": "کد دسترسی شما"})
print(x.text)

متد ارسال پیام صوتی

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

https://api.limosms.com/api/sendvoice Post

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

ردیف	نام پارامتر	نوع	توضیحات
1	VoiceId	long	آیدی صوتی که قرار است ارسال شود
2	MobileNumber	[ ] string	آرایه ای از شماره موبایل ها که میتواد یک شماره و یا چند شماره باشد
3	MaxTry	short	تعداد تلاش برای تماس(درصورت پاسخ ندادن کاربر چند بار میتواند تماس را تکرار کند)
4	MinuteBetweenTries	int	فاصله زمانی بین هر تلاش برای تماس به دقیقه
5	StartTimeSpan	double	زمان شروع ارسال
6	EndTimeSpan	double	زمان پایان ارسال
7	HasVote	bool	درصورتی که این تماس همراه با نظرسنجی می باشد باید مقدار این فیلد true ارسال شود

پارامتر خروجی

ردیف	نام پارامتر	نوع	توضیحات
1	Success	boolean	نتیجه ارسال پیام
2	Message	string	توضیحات ارسال پیام
3	MessageId	[ ] string	شناسه پیام ها برای دریافت وضعیت ارسال

نمونه کد

var client = new HttpClient();
string[] receiver = { "شماره موبایل"};
var data = new
{
VoiceId =111111,
MaxTry = 3,
MinuteBetweenTries = 5,
MobileNumber = receiver,
HasVote = true
};
var url = "https://api.limosms.com/api/sendvoice";
client.DefaultRequestHeaders.Add("ApiKey", "کد دسترسی شما");
var objectStr = JsonConvert.SerializeObject(data);
var content = new StringContent(objectStr, Encoding.UTF8, "application/json");
var response = client.PostAsync(url, content).Result;
string resultContent = await response.Content.ReadAsStringAsync();
return resultContent;

$url ='https://api.limosms.com/api/sendvoice';
$receiver = array("گیرندگان");
$post_data = json_encode(array(
'VoiceId' =>11111 ,
'MaxTry' =>3 ,
'MinuteBetweenTries' =>5 ,
'HasVote' => true,
'MobileNumber' => $receiver,
));
$process = curl_init();
curl_setopt( $process,CURLOPT_URL,$url);
curl_setopt( $process, CURLOPT_TIMEOUT,30);
curl_setopt( $process, CURLOPT_POST, 1);
curl_setopt($process, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt( $process, CURLOPT_POSTFIELDS, $post_data);
curl_setopt( $process, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt( $process, CURLOPT_FOLLOWLOCATION, true);
curl_setopt( $process, CURLOPT_HTTPHEADER, array('Content-Type: application/json'
,'ApiKey:کد دسترسی شما'));
$return = curl_exec( $process);
$httpcode = curl_getinfo( $process, CURLINFO_HTTP_CODE);
curl_close($process);
$decoded = json_decode($return);
print_r($decoded);

import requests
url = 'https://api.limosms.com/api/sendsms'
receiver = ["گیرندگان"]
myobj = {'VoiceId' :11111,
'MinuteBetweenTries' :5,
'MaxTry' :3,
'HasVote' :true,
'MobileNumber' : receiver}
x = requests.post(url, json = myobj, headers = {"ApiKey": "کد دسترسی شما"})
print(x.text)

متد ارسال پیام متناظر

این وب سرویس برای ارسال پیام متناظر به صورت زمانبندی استفاده می شود

https://api.limosms.com/api/sendpeertopeersms Post

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

ردیف	نام پارامتر	نوع	توضیحات
1	SenderNumber	string	شماره خط ارسال کننده پیام
2	Message	[ ] string	متن پیام ها
3	MobileNumber	[ ] string	زمان ارسال پیام ( در صورت خالی بودن پیام در لحظه ارسال می‌شود )
4	SendToBlocksNumber	boolean	ارسال به شماره های بلاک شده
5	SendTimeSpan	double	زمان ارسال پیام ( در صورت خالی بودن پیام در لحظه ارسال می‌شود )

پارامتر خروجی

ردیف	نام پارامتر	نوع	توضیحات
1	Success	boolean	نتیجه ارسال پیام
2	Message	string	توضیحات ارسال پیام
3	MessageId	[ ] string	شناسه پیام ها برای دریافت وضعیت ارسال

نمونه کد

$url ='https://api.limosms.com/api/sendpeertopeersms';
$receiver = array("گیرنده دوم " , "گیرنده اول");
$post_data = json_encode(array(
'Message' =>array("پیام دوم" , "پیام اول"),
'SenderNumber' => 'فرستنده',
'SendToBlocksNumber' => 'false',
'MobileNumber' => $receiver,
));
$process = curl_init();
curl_setopt( $process,CURLOPT_URL,$url);
curl_setopt( $process, CURLOPT_TIMEOUT,30);
curl_setopt( $process, CURLOPT_POST, 1);
curl_setopt($process, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt( $process, CURLOPT_POSTFIELDS, $post_data);
curl_setopt( $process, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt( $process, CURLOPT_FOLLOWLOCATION, true);
curl_setopt( $process, CURLOPT_HTTPHEADER, array('Content-Type: application/json'
,'ApiKey:کد دسترسی'));
$return = curl_exec( $process);
$httpcode = curl_getinfo( $process, CURLINFO_HTTP_CODE);
curl_close($process);
$decoded = json_decode($return);
print_r($decoded);

import requests
url = 'https://api.limosms.com/api/sendpeertopeersms'
receiver = ["گیرنده ی اول", "گیرنده ی دوم"]
message = ["متن پیام اول", "متن پیام دوم"]
myobj = {'Message' :message,
'SenderNumber' : 'فرستنده',
'MobileNumber' : receiver}
x = requests.post(url, json = myobj, headers = {"ApiKey": "کد دسترسی شما"})
print(x.text)

ارسال پیام تکی و گروهی از طریق نرم افزار هلو

این وب سرویس برای ارسال پیام از نرم افزار هلو استفاده می شود.

https://api.limosms.com/api/SendSmsFromForm Post

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

ردیف	نام پارامتر	نوع	توضیحات
1	SenderNumber	string	شماره خط ارسال کننده پیام
2	Message	string	متن پیام
3	MobileNumber	[ ] string	آرایه ای از شماره موبایل ها
4	ApiKey	string	کد دسترسی شما

پارامتر خروجی

ردیف	نام پارامتر	نوع	توضیحات
1	Success	boolean	نتیجه ارسال پیام
2	Message	string	توضیحات ارسال پیام
3	MessageId	[ ] string	شناسه پیام ها برای دریافت وضعیت ارسال

نمونه کد

var client = new HttpClient();
string[] receiver = { "گیرنده ی دوم" , "گیرنده ی اول"};
string Message = "پیام";
var data = new
{
Message = Message,
SenderNumber = "فرستنده",
MobileNumber = receiver,
ApiKey="کد دسترسی شما",
};
var url = "https://api.limosms.com/api/SendSmsFromForm";
var objectStr = JsonConvert.SerializeObject(data);
var content = new StringContent(objectStr, Encoding.UTF8, "application/json");
var response = client.PostAsync(url, content).Result;
string resultContent = await response.Content.ReadAsStringAsync();
return resultContent;

$url ='https://api.limosms.com/api/SendSmsFromForm';
$receiver = ("گیرنده دوم " , "گیرنده اول");
$post_data = json_encode(array(
'Message' =>"پیام",
'SenderNumber' => 'فرستنده',
'ApiKey' => 'کد دسترسی شما',
'MobileNumber' => $receiver,
));
$process = curl_init();
curl_setopt( $process,CURLOPT_URL,$url);
curl_setopt( $process, CURLOPT_TIMEOUT,30);
curl_setopt( $process, CURLOPT_POST, 1);
curl_setopt($process, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt( $process, CURLOPT_POSTFIELDS, $post_data);
curl_setopt( $process, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt( $process, CURLOPT_FOLLOWLOCATION, true);
curl_setopt( $process, CURLOPT_HTTPHEADER, array('Content-Type: application/json'
));
$return = curl_exec( $process);
$httpcode = curl_getinfo( $process, CURLINFO_HTTP_CODE);
curl_close($process);
$decoded = json_decode($return);
print_r($decoded);

import requests
url = 'https://api.limosms.com/api/SendSmsFromForm'
receiver = ["گیرنده ی اول", "گیرنده ی دوم"]
message = "متن پیام"
myobj = {'Message' :message,
'SenderNumber' : 'فرستنده',
'ApiKey' : 'کد دسترسی شما',
'MobileNumber' : receiver}
x = requests.post(url, json = myobj)
print(x.text)

متد ارسال پترن (الگو) مشاهده فیلم آموزشی

در ارسال پیامک وب سرویس از طریق پترن شما متن کلی پیامک را مشخص می‌کنید و فقط در بعضی از موارد که نیاز است متغیر قرار می‌دهید، بنابراین کلیت متن شما ثابت است و یک مرتبه واحد مانیتورینگ متن پیامک را تایید می‌کند در صورتی که متن پیامک تبلیغاتی نباشد یک کد الگو در اختیار شما قرار می‌گیرد زمانی که شما از طریق این الگو پیامک ارسال می‌کنید بدون تایید ناظر انسانی پیامک ارسال می‌شود و پیامک ارسال شده در کمتر از 5 ثانیه به دست مخاطب می‌رسد.

https://api.limosms.com/api/sendpatternmessage Post

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

ردیف	نام پارامتر	نوع	توضیحات
1	OtpId	Long	شناسه متن پیام
2	ReplaceToken	[ ] string	متن های جایگذین
3	MobileNumber	string	شناسه متن پیام
4	Send	bool	به صورت پیشفرض این فیلد true می باشد و پیامک ارسال می شود. درصورتی که مقدار این فیلد false ارسال شود ، محاسبه هزینه انجام می شود و هزینه و متن پیامک نهایی برگشت داده می شود

پارامتر خروجی

ردیف	نام پارامتر	نوع	توضیحات
1	Success	boolean	نتیجه ارسال پیام
2	Message	string	توضیحات ارسال پیام
3	TotalAmount	?long	هزینه پیامک

نمونه کد

var client = new HttpClient();
string[] Message = { "تست" };
var data = new
{
OtpId = "1",
ReplaceToken = Message,
MobileNumber = "گیرنده",
};
var url = "https://api.limosms.com/api/sendpatternmessage";
client.DefaultRequestHeaders.Add("ApiKey", "کد دسترسی شما");
var objectStr = JsonConvert.SerializeObject(data);
var content = new StringContent(objectStr, Encoding.UTF8, "application/json");
var response = client.PostAsync(url, content).Result;
string resultContent = await response.Content.ReadAsStringAsync();
return resultContent;

$url ='https://api.limosms.com/api/sendpatternmessage';
$post_data = json_encode(array(
'OtpId' => '12' ,
'ReplaceToken' => ['تست' ],
'MobileNumber' => 'گیرنده'
));
$process = curl_init();
curl_setopt( $process,CURLOPT_URL,$url);
curl_setopt( $process, CURLOPT_TIMEOUT,30);
curl_setopt( $process, CURLOPT_POST, 1);
curl_setopt($process, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt( $process, CURLOPT_POSTFIELDS, $post_data);
curl_setopt( $process, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt( $process, CURLOPT_FOLLOWLOCATION, true);
curl_setopt( $process, CURLOPT_HTTPHEADER, array('Content-Type: application/json'
,'ApiKey:کد دسترسی'));
$return = curl_exec( $process);
$httpcode = curl_getinfo( $process, CURLINFO_HTTP_CODE);
curl_close($process);
$decoded = json_decode($return);
print_r($decoded);

import requests
url = 'https://api.limosms.com/api/sendpatternmessage'
message = ["خوش امدید"]
myobj = {'OtpId' :'شناسه ی پترن',
'ReplaceToken' : message,
'MobileNumber' : 'گیرنده'}
x = requests.post(url, json = myobj, headers = {"ApiKey": "کد دسترسی شما"})
print(x.text)

متد احراز هویت

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

https://api.limosms.com/api/sendcode Post

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

ردیف	نام پارامتر	نوع	توضیحات
1	Mobile	string	شماره موبایل دریافت کننده کد
2	Footer	string	متن فوتر در پیام

پارامتر خروجی

ردیف	نام پارامتر	نوع	توضیحات
1	Success	boolean	نتیجه ارسال پیام
2	Message	string	توضیحات ارسال پیام

نمونه کد

var client = new HttpClient();
var data = new
{
Mobile = "گیرنده",
Footer = "خوش امدید",
};
var url = "https://api.limosms.com/api/sendcode";
client.DefaultRequestHeaders.Add("ApiKey", "کد دسترسی شما");
var objectStr = JsonConvert.SerializeObject(data);
var content = new StringContent(objectStr, Encoding.UTF8, "application/json");
var response = client.PostAsync(url, content).Result;
string resultContent = await response.Content.ReadAsStringAsync();
return resultContent;

$url ='https://api.limosms.com/api/sendcode';
$post_data = json_encode(array(
'Mobile' => 'گیرنده' ,
'Footer' => 'خوش امدید'
));
$process = curl_init();
curl_setopt( $process,CURLOPT_URL,$url);
curl_setopt( $process, CURLOPT_TIMEOUT,30);
curl_setopt( $process, CURLOPT_POST, 1);
curl_setopt($process, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt( $process, CURLOPT_POSTFIELDS, $post_data);
curl_setopt( $process, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt( $process, CURLOPT_FOLLOWLOCATION, true);
curl_setopt( $process, CURLOPT_HTTPHEADER, array('Content-Type: application/json'
,'ApiKey:کد دسترسی شما'));
$return = curl_exec( $process);
$httpcode = curl_getinfo( $process, CURLINFO_HTTP_CODE);
curl_close($process);
$decoded = json_decode($return);
print_r($decoded);

import requests url = 'https://api.limosms.com/api/sendcode'
myobj = {'Mobile' :'گیرنده',
'Footer' : 'خوش امديد'}
x = requests.post(url, json = myobj, headers = {"ApiKey": "کد دسترسی شما"})
print(x.text)

متد دریافت وضعیت احراز هویت

برای چک کردن احراز هویت شماره موبایل کاربر از طریق api شما باید شماره موبایل و کد وارد شده توسط کاربر خود را ارسال کنید تا بررسی ها انجام و نتیجه به شما نمایش داده شود

https://api.limosms.com/api/checkcode Post

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

ردیف	نام پارامتر	نوع	توضیحات
1	Mobile	string	شماره موبایل دریافت کننده کد
2	Code	string	کد وارد شده توسط کاربر

پارامتر خروجی

ردیف	نام پارامتر	نوع	توضیحات
1	Success	boolean	نتیجه احراز هویت
2	Message	string	توضیحات

نمونه کد

var client = new HttpClient();
var data = new
{
Mobile = "گیرنده",
Code = "123655",
};
var url = "https://api.limosms.com/api/checkcode";
client.DefaultRequestHeaders.Add("ApiKey", "کد دسترسی شما");
var objectStr = JsonConvert.SerializeObject(data);
var content = new StringContent(objectStr, Encoding.UTF8, "application/json");
var response = client.PostAsync(url, content).Result;
string resultContent = await response.Content.ReadAsStringAsync();
return resultContent;

$url ='https://api.limosms.com/api/checkcode';
$post_data = json_encode(array(
'Mobile' => 'گیرنده' ,
'Code' => '13245'
));
$process = curl_init();
curl_setopt( $process,CURLOPT_URL,$url);
curl_setopt( $process, CURLOPT_TIMEOUT,30);
curl_setopt( $process, CURLOPT_POST, 1);
curl_setopt($process, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt( $process, CURLOPT_POSTFIELDS, $post_data);
curl_setopt( $process, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt( $process, CURLOPT_FOLLOWLOCATION, true);
curl_setopt( $process, CURLOPT_HTTPHEADER, array('Content-Type: application/json'
,'ApiKey:کد دسترسی شما'));
$return = curl_exec( $process);
$httpcode = curl_getinfo( $process, CURLINFO_HTTP_CODE);
curl_close($process);
$decoded = json_decode($return);
print_r($decoded);

import requests
url = 'https://api.limosms.com/api/checkcode'
myobj = {'Mobile' :'گیرنده',
'Code' : '15545'}
x = requests.post(url, json = myobj, headers = {"ApiKey": "کد دسترسی شما"})
print(x.text)

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

این وب سرویس برای دریافت پیام های دریافتی ارسال شده به خط اختصاصی شما استفاده می شود. توجه : در هر درخواست حداکثر 100 تا پیام برگشت داده می شود

https://api.limosms.com/api/getreceivedmessage Post

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

ردیف	نام پارامتر	نوع	توضیحات
1	Number	string	شماره ی اختصاصی
2	Page	int	شماره صفحه
3	Size	int	تعداد

پارامتر خروجی

ردیف	نام پارامتر	نوع	توضیحات
1	Success	boolean	نتیجه ارسال پیام
2	Message	string	توضیحات ارسال پیام
3	Result	[ ] Object	لیست پیام ها

نمونه کد

var client = new HttpClient();
var data = new
{
Number = "شماره ی اختصاصی شما",
Page = شماره ی صفحه,
Size = تعداد
};
var url = "https://api.limosms.com/api/getreceivedmessage";
client.DefaultRequestHeaders.Add("ApiKey", "کد دسترسی شما");
var objectStr = JsonConvert.SerializeObject(data);
var content = new StringContent(objectStr, Encoding.UTF8, "application/json");
var response = client.PostAsync(url, content).Result;
string resultContent = await response.Content.ReadAsStringAsync();
return resultContent;

$url ='https://api.limosms.com/api/getreceivedmessage';
$post_data = json_encode(array(
'Number' =>'شماره ی اختصاصی',
'Page' => شماره صفحه,
'Size' => تعداد,
));
$process = curl_init();
curl_setopt( $process,CURLOPT_URL,$url);
curl_setopt( $process, CURLOPT_TIMEOUT,30);
curl_setopt( $process, CURLOPT_POST, 1);
curl_setopt($process, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt( $process, CURLOPT_POSTFIELDS, $post_data);
curl_setopt( $process, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt( $process, CURLOPT_FOLLOWLOCATION, true);
curl_setopt( $process, CURLOPT_HTTPHEADER, array('Content-Type: application/json'
,'ApiKey:کد دسترسی'));
$return = curl_exec( $process);
$httpcode = curl_getinfo( $process, CURLINFO_HTTP_CODE);
curl_close($process);
$decoded = json_decode($return);
print_r($decoded);

import requests
url = 'https://api.limosms.com/api/getreceivedmessage'
myobj = {
'Number' :'شماره ی اختصاصی',
'Page' : شماره ی صفحه,
'Size' : تعداد
}
x = requests.post(url, json = myobj, headers = {"ApiKey": "کد دسترسی شما"})
print(x.text)

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

این وب سرویس برای دریافت وضعیت ارسال پیام ها استفاده می شود. توجه : در هر درخواست حداکثر 100 تا وضعیت برگشت داده می شود

https://api.limosms.com/api/getstatus Post

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

ردیف	نام پارامتر	نوع	توضیحات
1	MessageId	[ ] string	شناسه پیام های ارسالی

پارامتر خروجی

ردیف	نام پارامتر	نوع	توضیحات
1	Success	boolean	نتیجه ارسال پیام
2	Message	string	توضیحات ارسال پیام
3	Data	[ ] Object	لیست وضعیت پیام ها

نمونه کد

var client = new HttpClient();
string[] Id= {"شناسه ی پیام"};
var data = new
{
MessageId =Id,
};
var url = "https://api.limosms.com/api/getstatus";
client.DefaultRequestHeaders.Add("ApiKey", "کد دسترسی شما");
var objectStr = JsonConvert.SerializeObject(data);
var content = new StringContent(objectStr, Encoding.UTF8, "application/json");
var response = client.PostAsync(url, content).Result;
string resultContent = await response.Content.ReadAsStringAsync();
return resultContent;

$url ='https://api.limosms.com/api/getstatus';
$post_data = json_encode(array(
'MessageId' => ['شناسه ی پیام']
));
$process = curl_init();
curl_setopt( $process,CURLOPT_URL,$url);
curl_setopt( $process, CURLOPT_TIMEOUT,30);
curl_setopt( $process, CURLOPT_POST, 1);
curl_setopt($process, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt( $process, CURLOPT_POSTFIELDS, $post_data);
curl_setopt( $process, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt( $process, CURLOPT_FOLLOWLOCATION, true);
curl_setopt( $process, CURLOPT_HTTPHEADER, array('Content-Type: application/json'
,'ApiKey:کد دسترسی شما'));
$return = curl_exec( $process);
$httpcode = curl_getinfo( $process, CURLINFO_HTTP_CODE);
curl_close($process);
$decoded = json_decode($return);
print_r($decoded);

import requests
url = 'https://api.limosms.com/api/getstatus'
status = ["265463"]
myobj = {'MessageId' :status}
x = requests.post(url, json = myobj, headers = {"ApiKey": "کد دسترسی شما"})
print(x.text)

متد دریافت اطلاعات پروفایل

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

https://api.limosms.com/api/getcurrentcredit Post

پارامتر خروجی

ردیف	نام پارامتر	نوع	توضیحات
1	Success	boolean	نتیجه احراز هویت
2	Message	string	توضیحات
3	Result	Object	اطلاعات پروفایل

نمونه کد

var client = new HttpClient();
var url = "https://api.limosms.com/api/getcurrentcredit";
client.DefaultRequestHeaders.Add("ApiKey", "کد دسترسی شما");
var content = new StringContent("", Encoding.UTF8, "application/json");
var response = client.PostAsync(url, content).Result;
string resultContent = await response.Content.ReadAsStringAsync();
return resultContent;

$url ='https://api.limosms.com/api/getcurrentcredit';
$process = curl_init();
curl_setopt( $process,CURLOPT_URL,$url);
curl_setopt( $process, CURLOPT_TIMEOUT,30);
curl_setopt( $process, CURLOPT_POST, 1);
curl_setopt( $process, CURLOPT_POSTFIELDS, $post_data);
curl_setopt( $process, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt( $process, CURLOPT_FOLLOWLOCATION, true);
curl_setopt( $process, CURLOPT_HTTPHEADER, array('Content-Type: application/json'
,'ApiKey:کد دسترسی شما'));
$return = curl_exec( $process);
$httpcode = curl_getinfo( $process, CURLINFO_HTTP_CODE);
curl_close($process);
$decoded = json_decode($return);
print_r($decoded);

import requests
url = 'https://api.limosms.com/api/getcurrentcredit'
x = requests.post(url, json = '', headers = {"ApiKey": "کد دسترسی شما"})
print(x.text)

متد ارسال OTP صوتی

این وب سرویس برای ارسال کد اعتبار سنجی OTP بصورت تماس تلفنی مورد استفاده قرار می گیرد .

https://api.limosms.com/api/SendOTPVoice Post

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

ردیف	نام پارامتر	نوع	توضیحات
1	PhoneNumber	string	شماره خط دریافت کننده پیام
2	GenerateCode	string	کد اعتبارسنجی (اختیاری)

پارامتر خروجی

ردیف	نام پارامتر	نوع	توضیحات
1	Success	boolean	نتیجه ارسال پیام
2	Message	string	توضیحات ارسال پیام
3	GenerateCode	string	کد تولید شده درصورت اختیاری بودن کد اعتبارسنجی

نمونه کد

var client = new HttpClient();
var data = new {
PhoneNumber = "9111234567" ,
GenerateCode = "1234"
}
var url = 'https://api.limosms.com/api/SendOTPVoice ';
client.DefaultRequestHeaders.Add("ApiKey", 'i56y45n-...');
var objectStr = JsonConvert.SerializeObject(obj);
var content = new StringContent(objectStr, Encoding.UTF8, "application/json");
var response = client.PostAsync(url, content).Result;
string resultContent = await response.Content.ReadAsStringAsync();
return resultContent;

$url ='https://api.limosms.com/api/SendOTPVoice ';
$receiver ="09108902507";
$post_data = json_encode(array(
'GenerateCode' =>'1234' ,
'PhoneNumber' => $receiver,
));
$process = curl_init();
curl_setopt( $process,CURLOPT_URL,$url);
curl_setopt( $process, CURLOPT_TIMEOUT,30);
curl_setopt( $process, CURLOPT_POST, 1);
curl_setopt($process, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt( $process, CURLOPT_POSTFIELDS, $post_data);
curl_setopt( $process, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt( $process, CURLOPT_FOLLOWLOCATION, true);
curl_setopt( $process, CURLOPT_HTTPHEADER, array('Content-Type: application/json'
,'ApiKey:i56y45n-...'));
$return = curl_exec( $process);
$httpcode = curl_getinfo( $process, CURLINFO_HTTP_CODE);
curl_close($process);
$decoded = json_decode($return);
print_r($decoded);

axios.post( 'https://api.limosms.com/api/SendOTPVoice ', {
"GenerateCode": "1234",
"PhoneNumber": "09108902507" ,
}, headers: }
ApiKey: i56y45n-...
})
.then((response) => {
console.log(response);
}, (error) => {
console.log(error);
});

لغو پیام تکی زمانبندی شده

این وبسرویس برای حذف پیام تکی زمانبندی شده استفاده می شود

https://api.limosms.com/api/CancelUserOneMessage Post

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

ردیف	نام پارامتر	نوع	توضیحات
1	Id	long	آیدی پیام

پارامتر خروجی

ردیف	نام پارامتر	نوع	توضیحات
1	Success	boolean	نتیجه ارسال پیام
2	Message	string	توضیحات ارسال پیام

نمونه کد

var client = new HttpClient();
var data = new {
Id = 3214654512 ,
}
var url = 'https://api.limosms.com/api/CancelUserOneMessage ';
client.DefaultRequestHeaders.Add("ApiKey", 'i56y45n-...');
var objectStr = JsonConvert.SerializeObject(obj);
var content = new StringContent(objectStr, Encoding.UTF8, "application/json");
var response = client.PostAsync(url, content).Result;
string resultContent = await response.Content.ReadAsStringAsync();
return resultContent;

$url ='https://api.limosms.com/api/CancelUserOneMessage ';
$receiver ="09108902507";
$post_data = json_encode(array(
'Id' =>315421354564 ,
));
$process = curl_init();
curl_setopt( $process,CURLOPT_URL,$url);
curl_setopt( $process, CURLOPT_TIMEOUT,30);
curl_setopt( $process, CURLOPT_POST, 1);
curl_setopt($process, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt( $process, CURLOPT_POSTFIELDS, $post_data);
curl_setopt( $process, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt( $process, CURLOPT_FOLLOWLOCATION, true);
curl_setopt( $process, CURLOPT_HTTPHEADER, array('Content-Type: application/json'
,'ApiKey:i56y45n-...'));
$return = curl_exec( $process);
$httpcode = curl_getinfo( $process, CURLINFO_HTTP_CODE);
curl_close($process);
$decoded = json_decode($return);
print_r($decoded);

axios.post( 'https://api.limosms.com/api/CancelUserOneMessage ', {
"Id": 352465432112,
}, headers: }
ApiKey: i56y45n-...
})
.then((response) => {
console.log(response);
}, (error) => {
console.log(error);
});

import requests
url = 'https://api.limosms.com/api/CancelUserOneMessage'
myobj = {'Id' :3321564045,
x = requests.post(url, json = myobj, headers = {"ApiKey": "کد دسترسی شما"})
print(x.text)