وب سرویس سامانه پیام کوتاه

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

آشنایی با اصول REST API

راهنمای API مخفف واژگان Application Programming Interface به معنی «رابط های برنامه نویسی اپلیکیشن» می باشد. به طور خلاصه، ای پی آی به راحتی این امکان را در اختیار یک برنامه نویس می‌دهد تا به‌ برخی یا تمامی قابلیت‌های یک نرم‌افزار دیگر دسترسی پیدا کند.

REST یا Representational State Transfer عبارت است از راه کارها و روش‌هایی که با استفاده از آن‌ها می‌توان به رد و بدل دیتا از طریق شبکه پرداخت. به عبارت دیگر، REST راهی ساده به منظور سازماندهی تعاملات مابین سیستم‌های مجزا از یکدیگر می باشد.

معماری REST دارای یکسری ویژگی‌ها است که شاخص ترین آن‌ها عبارتند از:

  • ثبات و یکنواختی این معماری در جای جای API
  • عدم برخورداری از سشن در سمت سرور
  • به کارگیری از کدهای وضعیت اچ تی تی پی
  • استفاده از یو آر ال ها برای مشخص ساختن مسیرهای مد نظر
  • اعمال کوئری ها در یو آر ال به جای هدر پروتکل اچ تی تی پی

با این تفاسیر، RESTful API ها به خدمت توسعه دهندگان وب آمده‌اند تا فرایند توسعه ی وب، ایجاد تجربه ی کاربری بهتر، سهولت در استفاده از ای پی آی ها و نقل و انتقال داده‌ها از طریق پروتکل اچ تی تی پی را امکان‌پذیر سازند.

قالب های آماده وب سرویسی با پارامتر

سرویس قالب های آماده وب سرویسی به شما این امکان را میدهد که بدون نیاز به داشتن خط خدماتی و طی کردن پروسه زمانبر تهیه آن بتوانید از طریق وب سرویس به راحتی و بالاترین سرعت ممکن پیام های خود مانند: کد فعال سازی،شماره چک و فاکتور،کد قرعه کشی و... را به تمامی کاربران اعم از فیلتر و غیر فیلتر ارسال نمایید.
در متن قالب نام برند ،شرکت و یا خدمات خود را حتما ذکر نمایید و حداقل حاوی یک پارامتر %param1% باشد.حداکثر از 3 پارامتر، %param1% ، %param2% و %param3% میتوان استفاده کرد.

ساختار URL:

  http://api.smsapp.ir/v2/send/verify

متد:

Post

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

Parameter Entry in Format Description Required
apikey Headers String برای بدست آوردن مقدار به قسمت تنظیمات/حساب کاربری رفته و کد apikey را دریافت نمایید. اجباری
receptor Body String شماره گیرنده پیام (برای مثال 09122222222) اجباری
type Body Integer برای ارسال پیام متنی type=1 و برای ارسال پیام صوتی type=2 قرار دهید اجباری
template Body string عنوان قالبی که در پنل خود ایجاد کرده ایید اجباری
checkingids Body string پس از ارسال پیام کوتاه ممکن است به دلایل مختلف مثلا Time Out خروجی دریافت نکنید با مقدار دهی checkingids می توانید از طریق متد CheckMessageIDs از وضعیت پیام ارسالی مطلع شوید و از ارسال مجدد آن جلوگیری نمائید . اختیاری
param1 Body string مقادیری که از سمت شما وارد می شود ، وارد کردن حداقل 1 مورد اجباریست اجباری
param2 Body string مقادیری که از سمت شما وارد می شود ، وارد کردن حداقل 1 مورد اجباریست اختیاری
param3 Body string مقادیری که از سمت شما وارد می شود ، وارد کردن حداقل 1 مورد اجباریست اختیاری

نمونه کد خروجی:

$curl = curl_init();
curl_setopt_array($curl,
array(
CURLOPT_URL => "http://api.smsapp.ir/v2/send/verify",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "type=1¶m1=&receptor=09191111111&template=testvoice",
CURLOPT_HTTPHEADER => array(
"apikey: yourapikey",
"cache-control: no-cache",
"content-type: application/x-www-form-urlencoded",
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}

OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
RequestBody body = RequestBody.create(mediaType, "type=1¶m1=&receptor=09191111111&template=testvoice");
Request request = new Request.Builder()
.url("http://api.smsapp.ir/v2/send/verify")
.post(body)
.addHeader("apikey", "yourapikey")
.addHeader("cache-control", "no-cache")
.addHeader("content-type", "application/x-www-form-urlencoded")
.build();
Response response = client.newCall(request).execute();


Install-Package RestSharp

var client = new RestClient("http://api.smsapp.ir/v2/send/verify");
var request = new RestRequest(Method.POST);
request.AddHeader("apikey", "your apikey");
request.AddParameter("type", 1);
request.AddParameter("receptor",09111111111 );
request.AddParameter("template", "test");
request.AddParameter("param1", "تست");
IRestResponse response = client.Execute(request);

import http.client

conn = http.client.HTTPConnection("api.smsapp.ir")
payload = "type=1¶m1=&receptor=09191111111&template=testvoice"
headers = { 'apikey': "+yourapikey",
'content-type': "application/x-www-form-urlencoded"
}
conn.request("POST", "/v2/send/verify", payload, headers)
es = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Install-Package RestSharp

var client = new RestClient("http://api.smsapp.ir/v2/send/verify");var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/x-www-form-urlencoded");
request.AddHeader("apikey", "yourapikey");
request.AddParameter("application/x-www-form-urlencoded", "type=1¶m1=&receptor=09191111111&template=testvoice", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

خروجی:

{"result":"success","messageids":11509774}

نتیجه نهایی:

{
"result": "success", ,
"voiceid": 4321
"messageids:"1234در ارسال اگر messageids بزرگتر از 1000 باشد یعنی عملیات با موفقیت انجام شده است در غیر این صورت کد خطای مربوطه بازگردانده می شود,
}

{
"result": "error",.
message": "invalid template اگر نام قالب وارد شده صحیح نباشد . ,
}

{
"result": "error",
"message": "invalid parameter",
اگر یکی از پارامتر های ورودی به درستی وارد نشود . ,
}

{
"result": "error",
"message": "invalid api key", اگر کد apikey نامعتبر باشد .
}

توضیح موارد خطا:

کد خطا توضیحات
1 نام کاربری یا رمز عبور معتبر نمی باشد .
2 آرایه ها خالی می باشد.
3 طول آرایه بیشتر از 100 می باشد .
4 طول آرایه ی فرستنده و گیرنده و متن پیام با یکدیگر تطابق ندارد .
5 امکان گرفتن پیام جدید وجود ندارد .
6 - حساب کاربری غیر فعال می باشد.
- نام کاربری و یا رمز عبور خود را به درستی وارد نمی کنید .
- در صورتی که به تازگی وب سرویس را فعال کرده اید از منوی تنظیمات _رمز عبور ، رمز عبور وب سرویس خود را مجدد ست کنید .
7 امکان دسترسی به خط مورد نظر وجود ندارد .
8 شماره گیرنده نامعتبر است .
9 حساب اعتبار ریالی مورد نیاز را دارا نمی باشد.
10 خطایی در سیستم رخ داده است . دوباره سعی کنید .
11 نامعتبر می باشد . IP
20 شماره مخاطب فیلتر شده می باشد .
21 ارتباط با سرویس دهنده قطع می باشد .
ایجاد قالب آماده

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

ساختار URL:

  http://api.ghasedaksms.com/v2/sms/otp/create

متد:

Post

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

Parameter Entry in Format Description Required
apikey Headers String برای بدست آوردن مقدار به قسمت تنظیمات/حساب کاربری رفته و کد apikey را دریافت نمایید. اجباری
template Body String نام قالب که باید نام تکراری نباشد و شامل حروف فارسی نباشد اجباری
message Body String متن پیامکی قالب که حتما شامل حداقل یک پارمتر باید باشد (%param) اجباری
type Body integer نوع قالب که به صورت پیش فرض قالب پیامکی هست (برای مثال type=0 قالب پیامکی و type=1 قالب صوتی) اختیاری
voicemessage Body string اگر نوع قالب type=1 یعنی پیامک صوتی باشد باید متن پیامک صوتی خود را وارد کنید که حتما شامل حداقل یک پارمتر باشد (%param) اختیاری

نمونه کد خروجی:

$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'http://api.ghasedaksms.com/v2/sms/otp/create',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => 'template=test&message=test%20%20%25param1%25',
CURLOPT_HTTPHEADER => array(
'apikey: your apikey',
'Content-Type: application/x-www-form-urlencoded'
), )); $response = curl_exec($curl);
curl_close($curl);
echo $response;

OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
RequestBody body = RequestBody.create(mediaType, "template=testi&message=test %param1%");
Request request = new Request.Builder()
.url("http://api.ghasedaksms.com/v2/sms/otp/create")
.method("POST", body)
.addHeader("apikey", "your apikey")
.addHeader("Content-Type", "application/x-www-form-urlencoded")
.build();
Response response = client.newCall(request).execute();


var client = new RestClient("http://api.ghasedaksms.com/v2/sms/otp/create");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("apikey", "your apikey");
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddParameter("template", "testi");
request.AddParameter("message", "test %param1%");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

import http.client
conn = http.client.HTTPSConnection("api.ghasedaksms.com")
payload = 'template=testi&message=test%20%20%25param1%25'
headers = {
'apikey': 'your apikey',
'Content-Type': 'application/x-www-form-urlencoded'
}
conn.request("POST", "/v2/sms/otp/create", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

var http = require('follow-redirects').http;
var fs = require('fs');
var qs = require('querystring');
var options = {
'method': 'POST',
'hostname': 'api.ghasedaksms.com',
'path': '/v2/sms/otp/create',
'headers': {
'apikey': 'your apikey',
'Content-Type': 'application/x-www-form-urlencoded'
},
'maxRedirects': 20
};
var req = http.request(options, function (res) {
var chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function (chunk) {
var body = Buffer.concat(chunks);
console.log(body.toString());
});
res.on("error", function (error) {
console.error(error);
});
});
var postData = qs.stringify({
'template': 'testi',
'message': 'test %param1%'
});
req.write(postData);
req.end();

خروجی:

{"result": "success", "templateid": 9421}

نتیجه نهایی:

{
"result": "success", ,
"templateid": 9421

{
"result": "error",.
message": "invalid template اگر نام قالب وارد شده صحیح نباشد . ,
}

{
"result": "error",
"message": "invalid parameter",
اگر یکی از پارامتر های ورودی به درستی وارد نشود . ,
}

{
"result": "error",
"message": "invalid api key", اگر کد apikey نامعتبر باشد .
}

توضیح موارد خطا:

کد خطا توضیحات
1 نام کاربری یا رمز عبور معتبر نمی باشد .
2 آرایه ها خالی می باشد.
3 طول آرایه بیشتر از 100 می باشد .
4 طول آرایه ی فرستنده و گیرنده و متن پیام با یکدیگر تطابق ندارد .
5 امکان گرفتن پیام جدید وجود ندارد .
6 - حساب کاربری غیر فعال می باشد.
- نام کاربری و یا رمز عبور خود را به درستی وارد نمی کنید .
- در صورتی که به تازگی وب سرویس را فعال کرده اید از منوی تنظیمات _رمز عبور ، رمز عبور وب سرویس خود را مجدد ست کنید .
7 امکان دسترسی به خط مورد نظر وجود ندارد .
8 شماره گیرنده نامعتبر است .
9 حساب اعتبار ریالی مورد نیاز را دارا نمی باشد.
10 خطایی در سیستم رخ داده است . دوباره سعی کنید .
11 نامعتبر می باشد . IP
20 شماره مخاطب فیلتر شده می باشد .
21 ارتباط با سرویس دهنده قطع می باشد .
ایجاد قالب آماده

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

ساختار URL:

  http://api.ghasedaksms.com/v2/sms/otp/status

متد:

Post

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

Parameter Entry in Format Description Required
apikey Headers String برای بدست آوردن مقدار به قسمت تنظیمات/حساب کاربری رفته و کد apikey را دریافت نمایید. اجباری
templateid Body integer شناسه قالب که هنگام ایجاد قالب دریافت شده است اجباری

نمونه کد خروجی:

$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'http://api.ghasedaksms.com/v2/sms/otp/edit',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => 'templateid=9380',
CURLOPT_HTTPHEADER => array(
'apikey: your apikey',
'Content-Type: application/x-www-form-urlencoded'
), )); $response = curl_exec($curl);
curl_close($curl);
echo $response;

OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
RequestBody body = RequestBody.create(mediaType, "templateid=9380");
Request request = new Request.Builder()
.url("http://api.ghasedaksms.com/v2/sms/otp/edit")
.method("POST", body)
.addHeader("apikey", "your apikey")
.addHeader("Content-Type", "application/x-www-form-urlencoded")
.build();
Response response = client.newCall(request).execute();


var client = new RestClient("http://api.ghasedaksms.com/v2/sms/otp/edit");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("apikey", "your apikey");
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddParameter("templateid", 9380);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

import http.client
conn = http.client.HTTPSConnection("api.ghasedaksms.com")
payload = 'templateid=9380'
headers = {
'apikey': 'your apikey',
'Content-Type': 'application/x-www-form-urlencoded'
}
conn.request("POST", "/v2/sms/otp/edit", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

var http = require('follow-redirects').http;
var fs = require('fs');
var qs = require('querystring');
var options = {
'method': 'POST',
'hostname': 'api.ghasedaksms.com',
'path': '/v2/sms/otp/edit',
'headers': {
'apikey': 'your apikey',
'Content-Type': 'application/x-www-form-urlencoded'
},
'maxRedirects': 20
};
var req = http.request(options, function (res) {
var chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function (chunk) {
var body = Buffer.concat(chunks);
console.log(body.toString());
});
res.on("error", function (error) {
console.error(error);
});
});
var postData = qs.stringify({
'templateid': 9920,

});
req.write(postData);
req.end();

خروجی:

{"result": "success", "status": 1}

نتیجه نهایی:

{
"result": "success", ,
"status": 1

{
"result": "error",.
message": "invalid template اگر نام قالب وارد شده صحیح نباشد . ,
}

{
"result": "error",
"message": "invalid parameter",
اگر یکی از پارامتر های ورودی به درستی وارد نشود . ,
}

{
"result": "error",
"message": "invalid api key", اگر کد apikey نامعتبر باشد .
}

توضیح موارد خطا:

کد خطا توضیحات
1 نام کاربری یا رمز عبور معتبر نمی باشد .
2 آرایه ها خالی می باشد.
3 طول آرایه بیشتر از 100 می باشد .
4 طول آرایه ی فرستنده و گیرنده و متن پیام با یکدیگر تطابق ندارد .
5 امکان گرفتن پیام جدید وجود ندارد .
6 - حساب کاربری غیر فعال می باشد.
- نام کاربری و یا رمز عبور خود را به درستی وارد نمی کنید .
- در صورتی که به تازگی وب سرویس را فعال کرده اید از منوی تنظیمات _رمز عبور ، رمز عبور وب سرویس خود را مجدد ست کنید .
7 امکان دسترسی به خط مورد نظر وجود ندارد .
8 شماره گیرنده نامعتبر است .
9 حساب اعتبار ریالی مورد نیاز را دارا نمی باشد.
10 خطایی در سیستم رخ داده است . دوباره سعی کنید .
11 نامعتبر می باشد . IP
20 شماره مخاطب فیلتر شده می باشد .
21 ارتباط با سرویس دهنده قطع می باشد .
ویرایش قالب آماده

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

ساختار URL:

  http://api.ghasedaksms.com/v2/sms/otp/edit

متد:

Post

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

Parameter Entry in Format Description Required
apikey Headers String برای بدست آوردن مقدار به قسمت تنظیمات/حساب کاربری رفته و کد apikey را دریافت نمایید. اجباری
templateid Body integer شناسه قالب که هنگام ایجاد قالب دریافت شده است اجباری
template Body String نام قالب که باید نام تکراری نباشد و شامل حروف فارسی نباشد اجباری
message Body String متن پیامکی قالب که حتما شامل حداقل یک پارمتر باید باشد (%param) اجباری
type Body integer نوع قالب که به صورت پیش فرض قالب پیامکی هست (برای مثال type=0 قالب پیامکی و type=1 قالب صوتی) اختیاری
voicemessage Body string اگر نوع قالب type=1 یعنی پیامک صوتی باشد باید متن پیامک صوتی خود را وارد کنید که حتما شامل حداقل یک پارمتر باشد (%param) اختیاری

نمونه کد خروجی:

$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'http://api.ghasedaksms.com/v2/sms/otp/edit',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => 'template=test&templateid=9380&message=test%20%20%25param1%25',
CURLOPT_HTTPHEADER => array(
'apikey: your apikey',
'Content-Type: application/x-www-form-urlencoded'
), )); $response = curl_exec($curl);
curl_close($curl);
echo $response;

OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
RequestBody body = RequestBody.create(mediaType, "template=testi&templateid=9380&message=test %param1%");
Request request = new Request.Builder()
.url("http://api.ghasedaksms.com/v2/sms/otp/edit")
.method("POST", body)
.addHeader("apikey", "your apikey")
.addHeader("Content-Type", "application/x-www-form-urlencoded")
.build();
Response response = client.newCall(request).execute();


var client = new RestClient("http://api.ghasedaksms.com/v2/sms/otp/edit");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("apikey", "your apikey");
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddParameter("template", "testi");
request.AddParameter("templateid", 9424);
request.AddParameter("message", "test %param1%");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

import http.client
conn = http.client.HTTPSConnection("api.ghasedaksms.com")
payload = 'template=testi&templateid=9380&message=test%20%20%25param1%25'
headers = {
'apikey': 'your apikey',
'Content-Type': 'application/x-www-form-urlencoded'
}
conn.request("POST", "/v2/sms/otp/edit", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

var http = require('follow-redirects').http;
var fs = require('fs');
var qs = require('querystring');
var options = {
'method': 'POST',
'hostname': 'api.ghasedaksms.com',
'path': '/v2/sms/otp/edit',
'headers': {
'apikey': 'your apikey',
'Content-Type': 'application/x-www-form-urlencoded'
},
'maxRedirects': 20
};
var req = http.request(options, function (res) {
var chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function (chunk) {
var body = Buffer.concat(chunks);
console.log(body.toString());
});
res.on("error", function (error) {
console.error(error);
});
});
var postData = qs.stringify({
'templateid': 9452,
'template': 'testi',
'message': 'test %param1%'
});
req.write(postData);
req.end();

خروجی:

{"result": "success", "message": "template success update"}

نتیجه نهایی:

{
"result": "success", ,
"message": "template success update"

{
"result": "error",.
message": "invalid template اگر نام قالب وارد شده صحیح نباشد . ,
}

{
"result": "error",
"message": "invalid parameter",
اگر یکی از پارامتر های ورودی به درستی وارد نشود . ,
}

{
"result": "error",
"message": "invalid api key", اگر کد apikey نامعتبر باشد .
}

توضیح موارد خطا:

کد خطا توضیحات
1 نام کاربری یا رمز عبور معتبر نمی باشد .
2 آرایه ها خالی می باشد.
3 طول آرایه بیشتر از 100 می باشد .
4 طول آرایه ی فرستنده و گیرنده و متن پیام با یکدیگر تطابق ندارد .
5 امکان گرفتن پیام جدید وجود ندارد .
6 - حساب کاربری غیر فعال می باشد.
- نام کاربری و یا رمز عبور خود را به درستی وارد نمی کنید .
- در صورتی که به تازگی وب سرویس را فعال کرده اید از منوی تنظیمات _رمز عبور ، رمز عبور وب سرویس خود را مجدد ست کنید .
7 امکان دسترسی به خط مورد نظر وجود ندارد .
8 شماره گیرنده نامعتبر است .
9 حساب اعتبار ریالی مورد نیاز را دارا نمی باشد.
10 خطایی در سیستم رخ داده است . دوباره سعی کنید .
11 نامعتبر می باشد . IP
20 شماره مخاطب فیلتر شده می باشد .
21 ارتباط با سرویس دهنده قطع می باشد .
ارسال تکی

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

ساختار URL:

  http://api.smsapp.ir/v2/sms/send/simple

متد:

Post

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

Parameter Entry in Format Description Required
apikey Headers String برای بدست آوردن مقدار به قسمت تنظیمات/حساب کاربری رفته و کد apikey را دریافت نمایید. اجباری
message Body String

متنی که باید ارسال شود

اجباری
sender Body String شماره فرستنده پیام (برای مثال 5000110003333) اجباری
receptor Body String شماره گیرنده پیام (برای مثال 09122222222) اجباری
senddate Body Unixtime

تاریخ و زمان دقیق ارسال پیام بر اساس Unixtime (برای مثال 1484352000 ) که اگر قید نشود در همان لحظه پیام ارسال می شود

اختیاری
checkingids Body String پس از ارسال پیام کوتاه ممکن است به دلایل مختلف مثلا Time Out خروجی دریافت نکنید با مقدار دهی checkingids می توانید از طریق متد CheckMessageIDs از وضعیت پیام ارسالی مطلع شوید و از ارسال مجدد آن جلوگیری نمائید . اختیاری

نمونه کد خروجی:

$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "http://api.smsapp.ir/v2/sms/send/simple",
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "message= &sender= & Receptor=&=",
CURLOPT_HTTPHEADER => array(
"apikey: your apikey",
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}

HttpResponse response = Unirest.post("http://api.smsapp.ir/v2/sms/send/simple ")
.header("postman-token", "your apikey")
.header("content-type", "application/x-www-form-urlencoded")
.body("message=hello%20world&sender=&Receptor=&=")
.asString();


Install-Package RestSharp

var client = new RestClient("http://api.smsapp.ir/v2/sms/send/simple");
var request = new RestRequest(Method.POST);
request.AddHeader("apikey", "your apikey");
request.AddParameter("senddate", 1484352000);
request.AddParameter("receptor",09111111111 );
request.AddParameter("message", "test");
request.AddParameter("checkingids", "11509774");
request.AddParameter("sender","50001000" );
IRestResponse response = client.Execute(request);

import requests
url = "http://api.smsapp.ir/v2/sms/send/simple "

payload = "message=hello%20world&sender= &Receptor=&="
headers = {
'apikey': "your apikey",

response = requests.request("POST", url, data=payload, headers=headers)
print(response.text)

var request = require("request");
var options = { method: 'POST',
url: ' http://api.smsapp.ir/v2/sms/send/simple ',
headers:
{
apikey: 'your apikey' },
form:
{ message: '',
sender: '',
Receptor: '',
'': '' } };
request(options, function (error, response, body) {
if (error) throw new Error(error);

console.log(body);
});

خروجی:

{"result":"success","messageids":11509774}

نتیجه نهایی:

{
"result": "success",
messageids":11509774" در ارسال اگر messageids بزرگتر از 1000 باشد یعنی عملیات با موفقیت انجام شده است در غیر این صورت کد خطای مربوطه بازگردانده می شود,

}

{
"result": "error",.
"messageids":7,7 اگر ارسال انجام نشود کد خطا مربوطه بازگشت داده می شود .
}

{
"result": "error",
"message": "invalid parameter",
اگر یکی از پارامتر های ورودی به درستی وارد نشود . ,
}

{
"result": "error",
"message": "invalid api key", اگر کد apikey نامعتبر باشد .
}

توضیح موارد خطا:

کد خطا توضیحات
1 نام کاربری یا رمز عبور معتبر نمی باشد .
2 آرایه ها خالی می باشد.
3 طول آرایه بیشتر از 100 می باشد .
4 طول آرایه ی فرستنده و گیرنده و متن پیام با یکدیگر تطابق ندارد .
5 امکان گرفتن پیام جدید وجود ندارد .
6 - حساب کاربری غیر فعال می باشد.
- نام کاربری و یا رمز عبور خود را به درستی وارد نمی کنید .
- در صورتی که به تازگی وب سرویس را فعال کرده اید از منوی تنظیمات _رمز عبور ، رمز عبور وب سرویس خود را مجدد ست کنید .
7 امکان دسترسی به خط مورد نظر وجود ندارد .
8 شماره گیرنده نامعتبر است .
9 حساب اعتبار ریالی مورد نیاز را دارا نمی باشد.
10 خطایی در سیستم رخ داده است . دوباره سعی کنید .
11 نامعتبر می باشد . IP
20 شماره مخاطب فیلتر شده می باشد .
21 ارتباط با سرویس دهنده قطع می باشد .
ارسال گروهی

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

ساختار URL:

  http://api.smsapp.ir/v2/sms/send/bulk

متد:

Post

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

Parameter Entry in Format Description Required
apikey Headers String برای بدست آوردن مقدار به قسمت تنظیمات/حساب کاربری رفته و کد apikey را دریافت نمایید. اجباری
message Body String

متونی که باید ارسال شوند و با (،) از هم جدا می شوند

اجباری
sender Body String (برای مثال 50001000...,1000200...,... ) لیست شماره فرستندگان پیام که با (،) از هم جدا می شوند اجباری
receptor Body String لیست شماره افراد گیرنده پیام که با (،) از هم جدا می شوند (برای مثال 09122222222,09111111111,... ) اجباری
senddate Body Unixtime

تاریخ و زمان دقیق ارسال پیام بر اساس Unixtime که اگر قید نشوند در همان لحظه پیام ها ارسال میشوند (برای مثال 1484352000) که با (،)از هم جدا میشوند

اختیاری
groupids Body string شماره گروهی که میخواهیم پیام به مخاطبین آن گروه اضافه شود اختیاری
checkingids Body String پس از ارسال پیام کوتاه ممکن است به دلایل مختلف مثلا Time Out خروجی دریافت نکنید با مقدار دهی checkingids می توانید از طریق متد CheckMessageIDs از وضعیت پیام ارسالی مطلع شوید و از ارسال مجدد آن جلوگیری نمائید . اختیاری

نمونه کد خروجی:


$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => " http://api.smsapp.ir/v2/sms/send/bulk ",

CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => " message=hello%20world%2Cgute%20nacht &sender=&Receptor =&checkmessageids%09=2%2C3 ",
CURLOPT_HTTPHEADER => array(
"apikey: your apikey",
),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}

HttpResponse response = Unirest.post(" http://api.smsapp.ir/v2/sms/send/bulk ")
.header("apikey", "your apikey=")
.body("message= %2C&sender=&receptor =&checkmessageids%09=%2C")
.asString();


Install-Package RestSharp

var client = new RestClient("http://api.smsapp.ir/v2/sms/send/bulk");
var request = new RestRequest(Method.POST);
request.AddHeader("apikey", "your apikey");
request.AddParameter("senddate", "1484352000,1484354000");
request.AddParameter("receptor", 09121111111 , 9122222222 );
request.AddParameter("message", "تست 1 , تست 2");
request.AddParameter("checkingids", "11509774,11509775");
request.AddParameter("sender","50001000,50002000" );
IRestResponse response = client.Execute(request);

import requests

url = " http://api.smsapp.ir/v2/sms/send/bulk "

payload = "message= %2C &sender=&receptor =%2C&checkmessageids%09= %2C"
headers = {
'apikey': "",

}
response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

var request = require("request");

var options = { method: 'POST',
url: ' http://api.smsapp.ir/v2/sms/send/bulk ',
headers:
{
apikey: 'your apikey' },
form:
{ message: ' , ',
sender: '',
receptor : ' , ',
'checkmessageids\t': '2,3' } };

request(options, function (error, response, body) {
if (error) throw new Error(error);

console.log(body);
});

خروجی:

{"result":"success","messageids":"115096100,115066101"}

نتیجه نهایی:

{
"result": "success",
messageids":"115096100,115066101"در ارسال اگر messageids بزرگتر از 1000 باشد یعنی عملیات با موفقیت انجام شده است در غیر این صورت کد خطای مربوطه بازگردانده می شود,

}

{
"result": "error",.
"messageids":7,7 اگر ارسال انجام نشود کد خطا مربوطه بازگشت داده می شود .
}

{
"result": "error",
"message": "invalid parameter",
اگر یکی از پارامتر های ورودی به درستی وارد نشود . ,
}

{
"result": "error",
"message": "invalid api key", اگر کد apikey نامعتبر باشد .
}

توضیح موارد خطا:

جدول

ارسال گروهی 2

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

ساختار URL:

  http://api.smsapp.ir/v2/sms/send/bulk2

متد:

Post

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

Parameter Entry in Format Description Required
apikey Headers String برای بدست آوردن مقدار به قسمت تنظیمات/حساب کاربری رفته و کد apikey را دریافت نمایید. اجباری
message Body String

متنی که باید ارسال شود

اجباری
sender Body String شماره فرستنده پیام (برای مثال 5000110003333) اجباری
receptor Body String لیست شماره افراد گیرنده پیام که با (،) از هم جدا می شوند (برای مثال 09122222222,09111111111,... ) اجباری
senddate Body Unixtime

تاریخ و زمان دقیق ارسال پیام بر اساس Unixtime (برای مثال 1484352000 ) که اگر قید نشود در همان لحظه پیام ارسال می شود

اختیاری
groupids Body string شماره گروهی که میخواهیم پیام به مخاطبین آن گروه اضافه شود اختیاری
checkingids Body String پس از ارسال پیام کوتاه ممکن است به دلایل مختلف مثلا Time Out خروجی دریافت نکنید با مقدار دهی checkingids می توانید از طریق متد CheckMessageIDs از وضعیت پیام ارسالی مطلع شوید و از ارسال مجدد آن جلوگیری نمائید . اختیاری

نمونه کد خروجی:

$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "http://api.smsapp.ir/v2/sms/send/bulk2",
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "message= d&sender= &Receptor= %2C&checkmessageids%09=2%2C3",
CURLOPT_HTTPHEADER => array(
"apikey: your apikey",
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}

HttpResponse response = Unirest.post(" http://api.smsapp.ir/v2/sms/send/bulk2 ")
.header("apikey", "your apikey")
.body("message= & sender=30005088&Receptor=%2C&checkmessageids%09=2%2C3")
.asString();


Install-Package RestSharp

var client = new RestClient("http://api.smsapp.ir/v2/sms/send/bulk2");
var request = new RestRequest(Method.POST);
request.AddHeader("apikey", "your apikey");
request.AddParameter("senddate", "1484352000");
request.AddParameter("receptor", "09121111111 , 09122222222" );
request.AddParameter("message", "تست");
request.AddParameter("checkingids", "11509774");
request.AddParameter("sender", "50001000" );
IRestResponse response = client.Execute(request);

import requests

url = "http://api.smsapp.ir/v2/sms/send/bulk2"

payload = " message= &sender=&receptor =91111111111%2C091111111111&checkingids%09=2%2C3 "
headers = {
'apikey': "your apikey",
}

response = requests.request("POST", url, data=payload, headers=headers)
print(response.text)

var request = require("request");
var options = { method: 'POST',
url: 'http://api.smsapp.ir/v2/sms/send/bulk2',
headers:
{
apikey: 'your apikey' },
form:
{ message: '',
sender: '',
Receptor: ',',
'Checkmessageids\t': ',' } };
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});

خروجی:

{"result":"success","messageids":"115041869,115064870"}

نتیجه نهایی:

{
"result": "success",
messageids":"115041869,115064870" در ارسال اگر messageids بزرگتر از 1000 باشد یعنی عملیات با موفقیت انجام شده است در غیر این صورت کد خطای مربوطه بازگردانده می شود,

}

{
"result": "error",.
"messageids":7,7 اگر ارسال انجام نشود کد خطا مربوطه بازگشت داده می شود .
}

{
"result": "error",
"message": "invalid parameter",
اگر یکی از پارامتر های ورودی به درستی وارد نشود . ,
}

{
"result": "error",
"message": "invalid api key", اگر کد apikey نامعتبر باشد .
}

توضیح موارد خطا:

جدول

وضعیت پیام های ارسالی

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

کد وضعیت:

کد توضیحات
0 وضعیت دریافت نشده است(یا پیامک در صف ارسال قرار دارد)
1 رسیده به گوشی
2 نرسیده به گوشی
8 رسیده به مخابرات
16 نرسیده به مخابرات
27 شماره گیرنده جزو لیست سیاه می باشد
1- شناسه ارسال شده اشتباه است

ساختار URL:

  http://api.smsapp.ir/v2/sms/status

متد:

Post

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

Parameter Entry in Format Description Required
apikey Headers String برای بدست آوردن مقدار به قسمت تنظیمات/حساب کاربری رفته و کد apikey را دریافت نمایید. اجباری
messageids Body String

شناسه پیامک که با (،) ازهم جدا می شوند

اجباری

نمونه کد خروجی:


$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => " http://api.smsapp.ir/v2/sms/status ",
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "messageids=123456",
CURLOPT_HTTPHEADER => array(
"apikey: your apikey",
),
));
$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}

HttpResponse response = Unirest.post(" http://api.smsapp.ir/v2/sms/status ")
.header("apikey", "your apikey")
.body("messageids=123456")
.asString();


Install-Package RestSharp

var client = new RestClient("http://api.smsapp.ir/v2/sms/status");
var request = new RestRequest(Method.POST);
request.AddHeader("apikey", "yourapikey");
request.AddParameter("messageids","115041869" );
IRestResponse response = client.Execute(request);

import requests

url = " http://api.smsapp.ir/v2/sms/status "

payload = "messageids=123456"
headers = {
'apikey': "your apikey",

}

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

var request = require("request");

var options = { method: 'POST',
url: ' http://api.smsapp.ir/v2/sms/status ',
headers:
{
apikey: 'your apikey' },
form: { messageids: '123456' } };

request(options, function (error, response, body) {
if (error) throw new Error(error);

console.log(body);
});

خروجی:

{"result":"success","list":"1"}

نتیجه نهایی:

{
"result": "success",
"list":"1""آرایه ای است از وضعیت پیامک ها تا این لحظه",

}

{
"result": "error",
}

{
"result": "error",
"message": "invalid parameter",
اگر یکی از پارامتر های ورودی به درستی وارد نشود . ,
}

{
"result": "error",
"message": "invalid api key", اگر کد apikey نامعتبر باشد .
}

گرفتن شناسه پیامک (Checkmessageids)

این متد برای گرفتن شناسه پیامکی که توسط سیستم تولید شده است می باشد. مقدار بازگشتی این تابع( MessageID) یا کد خطا می باشد. توسط این متد می توانید با ارائه شماره پیامک خود که در هنگام ارسال تنظیم کرده اید شناسه پیامک را دریافت کرده و با متد Status از وضعیت ارسال آن اطلاع پیدا کنید.

ساختار URL:

  http://api.smsapp.ir/v2/sms/check

متد:

Post

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

Parameter Entry in Format Description Required
apikey Headers String برای بدست آوردن مقدار به قسمت تنظیمات/حساب کاربری رفته و کد apikey را دریافت نمایید. اجباری
checkingids Body String

شناسه پیامک کاربر که با (،) از هم جدا می شوند.

اجباری

نمونه کد خروجی:


$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => " http://api.smsapp.ir/v2/sms/check ",
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "checkingids=123456",
CURLOPT_HTTPHEADER => array(
"apikey: your apikey",
),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}

HttpResponse response = Unirest.post(" http://api.smsapp.ir/v2/sms/check ")
.header("apikey", "your apikey")
.body("checkingids=123456")
.asString();


Install-Package RestSharp

var client = new RestClient("http://api.smsapp.ir/v2/sms/check");
var request = new RestRequest(Method.POST);
request.AddHeader("apikey", "your apikey");
request.AddParameter("checkingids","123852" )
IRestResponse response = client.Execute(request);

import requests

url = " http://api.smsapp.ir/v2/sms/check "

payload = "checkingids=123456"
headers = {
'apikey': "your apikey",

}

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

var request = require("request");

var options = { method: 'POST',
url: ' http://api.smsapp.ir/v2/sms/check ',
headers:
{
apikey: 'your apikey' },
form: { checkingids: '123456' } };

request(options, function (error, response, body) {
if (error) throw new Error(error);

console.log(body);
});

خروجی:

{"result":"success","list":"-1"}

نتیجه نهایی:

{
"result": "success",
"list":"-1 آرایه ای است از شناسه پیامک یا کد خطا",

}

{
"result": "error",
}

{
"result": "error",
"message": "invalid parameter",
اگر یکی از پارامتر های ورودی به درستی وارد نشود . ,
}

{
"result": "error",
"message": "invalid api key", اگر کد apikey نامعتبر باشد .
}

کد وضعیت:

جدول

دریافت گزارش

این متد برای دریافت گزارش وضعیت ارسال منطقه ای می باشد، این گزارش شامل تعداد پیام ها، هزینه کل ارسال و... می باشد.

ساختار URL:

  http://api.smsapp.ir/v2/sms/requestinfo

متد:

Post

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

Parameter Entry in Format Description Required
apikey Headers String برای بدست آوردن مقدار به قسمت تنظیمات/حساب کاربری رفته و کد apikey را دریافت نمایید. اجباری
messageids Body String کد ارسال پیام انبوه اجباری

نمونه کد خروجی:


$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => " http://api.smsapp.ir/v2/sms/requestinfo ",
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "messageids=12345",
CURLOPT_HTTPHEADER => array(
"apikey: your apikey",
),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;}

HttpResponse response = Unirest.post(" http://api.smsapp.ir/v2/sms/requestinfo ")
.header("apikey", "your apikey")
.body("messageids=123456")
.asString();


Install-Package RestSharp

var client = new RestClient("http://api.smsapp.ir/v2/sms/requestinfo");
var request = new RestRequest(Method.POST);
request.AddHeader("apikey", your apikey");
request.AddParameter("messageids","" )
IRestResponse response = client.Execute(request);

import requests

url = " http://api.smsapp.ir/v2/sms/requestinfo "

payload = "messageids=123456"
headers = {
'apikey': "your apikey",
}

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

var request = require("request");

var options = { method: 'POST',
url: ' http://api.smsapp.ir/v2/sms/requestinfo ',
headers: {
apikey: 'your apikey' },
form: { messageids: '1234564' } };

request(options, function (error, response, body) {
if (error) throw new Error(error);

console.log(body);
});

خروجی:

{"result":"success","request":{"id":0,"senderNumber":"30001818001828","message":"تست 15:46","sendDate":"2016-11-26T15:46:27","totalSms":2,"price":300,"status":2,"statusDescription":"ارسال شده","deliveryReport":[{"statusId":1,"statusCount":2}]}}

نتیجه نهایی:

{
"result": "success",
{"result":"success","request":{"id":0,"senderNumber":"30001818001828","message":"تست 15:46","sendDate":"2016-11-26T15:46:27","totalSms":2,"price":300,"status":2,"statusDescription":"ارسال شده","deliveryReport":[{"statusId":1,"statusCount":2}]}},

}

{
"result": "error",
}

{
"result": "error",
"message": "invalid parameter",
اگر یکی از پارامتر های ورودی به درستی وارد نشود . ,
}

{
"result": "error",
"message": "invalid api key", اگر کد apikey نامعتبر باشد .
}

کد وضعیت:

جدول

افزودن گروه جدید

از این متد برای اضافه کردن گروه جدید به لیست مخاطبین استفاده می شود.

ساختار URL:

  http://api.smsapp.ir/v2/contact/group/add

متد:

Post

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

Parameter Entry in Format Description Required
apikey Headers String برای بدست آوردن مقدار به قسمت تنظیمات/حساب کاربری رفته و کد apikey را دریافت نمایید. اجباری
parentid Body String

شماره گروه والد، در صورتی که میخواهیم گروه جدید در مسیر اصلی ساخته شود (parentid=0)قرار می دهیم.

اجباری
groupname Body String

نام گروه

اجباری

نمونه کد خروجی:

$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "http://api.smsapp.ir/v2/contact/group/add",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "parentid=0&groupname=hallo",
CURLOPT_HTTPHEADER => array(
"apikey: your apikey",

),
));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}

HttpResponse response = Unirest.post("http://api.smsapp.ir/v2/contact/group/add")
.header("apikey", "your apikey")
.body("parentid=0&groupname=hallo")
.asString();


Install-Package RestSharp

var client = new RestClient("http://api.smsapp.ir/v2/contact/group/add");
var request = new RestRequest(Method.POST);
request.AddHeader("apikey", "your apikey");
request.AddParameter("parentid","");
request.AddParameter("parentid=0&groupname=hallo")
IRestResponse response = client.Execute(request);

import requests
url = "http://api.smsapp.ir/v2/contact/group/add"
payload = "parentid=0&groupname=hallo"
headers = {
'apikey': "your apikey",
}
response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

var request = require("request");
var options = { method: 'POST',
url: 'http://api.smsapp.ir/v2/contact/group/add',
headers:
{
apikey: 'your apikey' },
form: { parentid: '0', groupname: 'hallo' } };
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});

خروجی:

{result = "success", groupid = 120214}

نتیجه نهایی:

{
"result": "success",
"groupid = 120214 ,

}

{
"result": "error",
}

{
"result": "error",
"message": "invalid parameter",
اگر یکی از پارامتر های ورودی به درستی وارد نشود . ,
}

{
"result": "error",
"message": "invalid api key", اگر کد apikey نامعتبر باشد .
}

توضیح کد خطا:

جدول

افزودن شماره به گروه

از این متد برای اضافه کردن شماره به یک گروه استفاده می شود.

ساختار URL:

  http://api.smsapp.ir/v2/contact/group/number/add

متد:

Post

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

Parameter Entry in Format Description Required
apikey Headers String برای بدست آوردن مقدار به قسمت تنظیمات/حساب کاربری رفته و کد apikey را دریافت نمایید. اجباری
groupid Body String

شماره گروه که به هنگام ثبت گروه دریافت شده

اجباری
number Body String

شماره تلفن مخاطب

اجباری
lastname Body String

نام خانوادگی مخاطب

اختیاری
firstname Body String

نام مخاطب

اختیاری
email Body String

ایمیل مخاطب

اختیاری
gender Body string

جنسیت: خانم/آقا

اختیاری
birthday Body string

تاریخ تولد مخاطب : 1/1/1370

اختیاری

نمونه کد خروجی:


$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "http://api.smsapp.ir/v2/contact/group/number/add",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "groupid=152074&number=09121111111",
CURLOPT_HTTPHEADER => array(
"apikey: your apikey",
),));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}

HttpResponse response = Unirest.post("http://api.smsapp.ir/v2/contact/group/number/add")
.header("apikey", "your apikey")
.body("groupid=152074&number=09121111111")
.asString();


Install-Package RestSharp

var client = new RestClient("http://api.smsapp.ir/v2/contact/group/number/add");
var request = new RestRequest(Method.POST);
request.AddHeader("apikey", "your apikey");
request.AddParameter("groupid");
request.AddParameter("number");
request.AddParameter("lastname");
request.AddParameter("firstname");
request.AddParameter("email");
request.AddParameter("gender");
request.AddParameter("birthday");
IRestResponse response = client.Execute(request);

import requests

url = "http://api.smsapp.ir/v2/contact/group/number/add"

payload = "groupid=152074&number=09121111111"
headers = {
'apikey': "your apikey",
}
response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

var request = require("request");
var options = { method: 'POST',
url: 'http://api.smsapp.ir/v2/contact/group/number/add',
headers:
{
apikey: 'your apikey' },
form: { groupid: '152074', number: '09121111111' } };
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});

خروجی:

{result = "success"}

نتیجه نهایی:

{
"result": "success",
,
}

{
"result": "error",
}

{
"result": "error",
"message": "invalid parameter",
اگر یکی از پارامتر های ورودی به درستی وارد نشود . ,
}

{
"result": "error",
"message": "invalid api key", اگر کد apikey نامعتبر باشد .
}

توضیح کد خطا:

جدول

افزودن چند شماره به گروه

از این متد برای اضافه کردن همزمان چند شماره به یک گروه استفاده می شود.

ساختار URL:

  http://api.smsapp.ir/v2/contact/group/number/addbulk

متد:

Post

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

Parameter Entry in Format Description Required
apikey Headers String برای بدست آوردن مقدار به قسمت تنظیمات/حساب کاربری رفته و کد apikey را دریافت نمایید. اجباری
groupid Body String

شماره گروه که به هنگام ثبت گروه دریافت شده

اجباری
numbers Body String

شماره تلفن مخاطبین که با (،) از هم جدا می شوند (برای مثال 09377777777,9121111111 )

اجباری

نمونه کد خروجی:

$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "http://api.smsapp.ir/v2/contact/group/number/addbulk",
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "groupid=152074&numbers=09121111111%2C09122222222",
CURLOPT_HTTPHEADER => array(
"apikey: your apikey",
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}

HttpResponse response = Unirest.post("http://api.smsapp.ir/v2/contact/group/number/addbulk")
.header("apikey", "your apikey")
.body("groupid=152074&numbers=09121111111%2C09122222222")
.asString();


Install-Package RestSharp

var client = new RestClient("http://api.smsapp.ir/v2/contact/group/number/addbulk");
var request = new RestRequest(Method.POST);
request.AddHeader("apikey", "your apikey");
request.AddParameter("groupid");
request.AddParameter("numbers","09121111111,09122222222,...");
IRestResponse response = client.Execute(request);

import requests
url = "http://api.smsapp.ir/v2/contact/group/number/addbulk"

payload = "groupid=152074&numbers=09121111111%2C09122222222"
headers = {
'apikey': "your apikey=",
}
response = requests.request("POST", url, data=payload, headers=headers)
print(response.text)

var request = require("request");
var options = { method: 'POST',
url: 'http://api.smsapp.ir/v2/contact/group/number/addbulk',
headers:
{
apikey: 'your apikey' },
form: { groupid: '152074', numbers: '09121111111,09122222222' } };

request(options, function (error, response, body) {
if (error) throw new Error(error);

console.log(body);
});

خروجی:

{  "result": "success",  "succcount": 1}

نتیجه نهایی:

{
"result": "success",
"succcount": 1 ,

}

{
"result": "error",
}

{
"result": "error",
"message": "invalid parameter",
اگر یکی از پارامتر های ورودی به درستی وارد نشود . ,
}

{
"result": "error",
"message": "invalid api key", اگر کد apikey نامعتبر باشد .
}

توضیح کد خطا:

جدول

لیست گروه ها

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

ساختار URL:

  http://api.smsapp.ir/v2/contact/group/list

متد:

Post

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

Parameter Entry in Format Description Required
apikey Headers String برای بدست آوردن مقدار به قسمت تنظیمات/حساب کاربری رفته و کد apikey را دریافت نمایید. اجباری
parentid Body String

شماره گروه والد، در صورتی که میخواهیم گره در مسیر اصلی را جستجو کنیم (parentid=0)قرار می دهیم.

اجباری

نمونه کد خروجی:

curl_setopt_array($curl, array(
CURLOPT_URL => "http://api.smsapp.ir/v2/contact/group/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "parentid=0&=",
CURLOPT_HTTPHEADER => array(
"apikey: your apikey",
),));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}

HttpResponse response = Unirest.post("http://api.smsapp.ir/v2/contact/group/list")
.header("apikey", "your apikey")
.body("parentid=0&=")
.asString();


Install-Package RestSharp

var client = new RestClient("http://api.smsapp.ir/v2/contact/group/list");
var request = new RestRequest(Method.POST);
request.AddHeader("apikey", "your apikey");
request.AddParameter("parentid");
IRestResponse response = client.Execute(request);

import requests
url = "http://api.smsapp.ir/v2/contact/group/list"

payload = "parentid=0&="
headers = {
'apikey': "your apikey",
}

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

import requests
url = "http://api.smsapp.ir/v2/contact/group/list"

payload = "parentid=0&="
headers = {
'apikey': "your apikey",
}
response = requests.request("POST", url, data=payload, headers=headers)
print(response.text)

خروجی:

{"result":"success","list":[{"Id":152074,"ParentId":0,"Name":"hallo"},{"Id":144510,"ParentId":0,"Name":"mytest"},{"Id":152005,"ParentId":0,"Name":"reza"},{"Id":152073,"ParentId":0,"Name":"'test web service'"},{"Id":143790,"ParentId":0,"Name":"تست "}

نتیجه نهایی:

{
"result": "success",
"list":[{"Id":152074,"ParentId":0,"Name":"hallo"}, {"Id":144510,"ParentId":0,"Name":"mytest"}, {"Id":152005,"ParentId":0,"Name":"reza"}, {"Id":152073,"ParentId":0,"Name":"'test web service'"},{"Id":143790,"ParentId":0,"Name":"تست "} ,

}

{
"result": "error",
}

{
"result": "error",
"message": "invalid parameter",
اگر یکی از پارامتر های ورودی به درستی وارد نشود . ,
}

{
"result": "error",
"message": "invalid api key", اگر کد apikey نامعتبر باشد .
}

توضیح کد خطا:

جدول

لیست مخاطبین گروه

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

ساختار URL:

  http://api.smsapp.ir/v2/contact/group/number/list

متد:

Post

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

Parameter Entry in Format Description Required
apikey Headers String برای بدست آوردن مقدار به قسمت تنظیمات/حساب کاربری رفته و کد apikey را دریافت نمایید. اجباری
groupid Body String

شماره گروه که به هنگام ثبت گروه دریافت شده

اجباری

نمونه کد خروجی:

$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "http://api.smsapp.ir/v2/contact/group/number/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "groupid=152074&=",
CURLOPT_HTTPHEADER => array(
"apikey: your apikey",
),
));
$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}

HttpResponse response = Unirest.post("http://api.smsapp.ir/v2/contact/group/number/list")
.header("apikey", "your apikey")
.body("groupid=152074&=")
.asString();
>


Install-Package RestSharp

var client = new RestClient("http://api.smsapp.ir/v2/contact/group/number/list");
var request = new RestRequest(Method.POST);
request.AddHeader("apikey", "your apikey");
request.AddParameter("groupid");
IRestResponse response = client.Execute(request);

import requests

url = "http://api.smsapp.ir/v2/contact/group/number/list"

payload = "groupid=152074&="
headers = {
'apikey': "your apikey",

}

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

var request = require("request");
var options = { method: 'POST',
url: 'http://api.smsapp.ir/v2/contact/group/number/list',
headers:
{
apikey: 'your apikey' },
form: { groupid: '152074', '': '' } };

request(options, function (error, response, body) {
if (error) throw new Error(error);

console.log(body);
});

خروجی:

{"result":"success","list":[{"number":"09121111111","firstname":"","lastname":""},{"number":"0912222222","firstname":"","lastname":""}]}

نتیجه نهایی:

{
"result": "success",
"list":[{"number":"09121111111","firstname":"","lastname":""},{"number":"0912222222","firstname":"","lastname":""}]} ,

}

{
"result": "error",
}

{
"result": "error",
"message": "invalid parameter",
اگر یکی از پارامتر های ورودی به درستی وارد نشود . ,
}

{
"result": "error",
"message": "invalid api key", اگر کد apikey نامعتبر باشد .
}

توضیح کد خطا:

جدول

ویرایش گروه ها

از این متد برای ویرایش گروه ها (تغییر نام گروه) استفاده می شود.

ساختار URL:

  http://api.smsapp.ir/v2/contact/group/edit

متد:

Post

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

Parameter Entry in Format Description Required
apikey Headers String برای بدست آوردن مقدار به قسمت تنظیمات/حساب کاربری رفته و کد apikey را دریافت نمایید. اجباری
groupid Body String

شماره گروه که به هنگام ثبت گروه دریافت شده

اجباری
groupname Body String

نام جدید برای گروه

اجباری

نمونه کد خروجی:


curl_setopt_array($curl, array(
CURLOPT_URL => "http://api.smsapp.ir/v2/contact/group/edit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "groupid=152074&groupname=tissue",
CURLOPT_HTTPHEADER => array(
"apikey: your apikey",

),
));
$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}

HttpResponse response = Unirest.post("http://api.smsapp.ir/v2/contact/group/edit")
.header("apikey", "your apikey")
.body("groupid=152074&groupname=tissue")
.asString();


Install-Package RestSharp

var client = new RestClient("http://api.smsapp.ir/v2/contact/group/edit");
var request = new RestRequest(Method.POST);
request.AddHeader("apikey", "your apikey");
request.AddParameter("groupid");
request.AddParameter("groupname=test");
IRestResponse response = client.Execute(request);

import requests
url = "http://api.smsapp.ir/v2/contact/group/edit"

payload = "groupid=152074&groupname=test"
headers = {
'apikey': "your apikey",
}
response = requests.request("POST", url, data=payload, headers=headers)
print(response.text)

var request = require("request");
var options = { method: 'POST',
url: 'http://api.smsapp.ir/v2/contact/group/edit',
headers:
{
apikey: 'your apikey' },
form: { groupid: '152074', groupname: 'test' } };

request(options, function (error, response, body) {
if (error) throw new Error(error);

console.log(body);
});

خروجی:

{"result":"success"}

نتیجه نهایی:

{
"result": "success", }

{
"result": "error",
}

{
"result": "error",
"message": "invalid parameter",
اگر یکی از پارامتر های ورودی به درستی وارد نشود . ,
}

{
"result": "error",
"message": "invalid api key", اگر کد apikey نامعتبر باشد .
}

توضیح کد خطا:

جدول

حذف گروه

از این متد برای حذف گروه مخاطبین استفاده می شود.

ساختار URL:

  http://api.smsapp.ir/v2/contact/group/delete

متد:

Post

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

Parameter Entry in Format Description Required
apikey Headers String برای بدست آوردن مقدار به قسمت تنظیمات/حساب کاربری رفته و کد apikey را دریافت نمایید. اجباری
groupid Body String

شماره گروه که به هنگام ثبت گروه دریافت شده

اجباری

نمونه کد خروجی:

curl_setopt_array($curl, array(
CURLOPT_URL => "http://api.smsapp.ir/v2/contact/group/delete",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "groupid=152074",
CURLOPT_HTTPHEADER => array(
"apikey: your apikey",
),));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}

HttpResponse response = Unirest.post("http://api.smsapp.ir/v2/contact/group/delete")
.header("apikey", "your apikey")
.body("groupid=152074")
.asString();


Install-Package RestSharp

var client = new RestClient("http://api.smsapp.ir/v2/contact/group/delete");
var request = new RestRequest(Method.POST);
request.AddHeader("apikey", "your apikey");
request.AddParameter( "groupid=152074");
IRestResponse response = client.Execute(request);

import requests
url = "http://api.smsapp.ir/v2/contact/group/delete"
payload = "groupid=152074"
headers = {
'apikey': "your apikey",
}

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

var request = require("request");
var options = { method: 'POST',
url: 'http://api.smsapp.ir/v2/contact/group/delete',
headers:
{
apikey: 'your apikey' },
form: { groupid: '152074' } };

request(options, function (error, response, body) {
if (error) throw new Error(error);

console.log(body);
});

خروجی:

{"result":"success"}

نتیجه نهایی:

{
"result": "success",
}

{
"result": "error",
}

{
"result": "error",
"message": "invalid parameter",
اگر یکی از پارامتر های ورودی به درستی وارد نشود . ,
}

{
"result": "error",
"message": "invalid api key", اگر کد apikey نامعتبر باشد .
}

توضیح کد خطا:

جدول

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

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

ساختار URL:

  http://api.smsapp.ir/v2/sms/recive

متد:

Post

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

Parameter Entry in Format Description Required
apikey Headers String برای بدست آوردن مقدار به قسمت تنظیمات/حساب کاربری رفته و کد apikey را دریافت نمایید. اجباری
linenumber Body String

شماره خط

اجباری
isread Body Integer

اگر (0) وارد شود پیام های خوانده نشده و اگر (1) وارد شود پیام های خوانده شده بر می گردد، طول آرایه 100 می باشد

اجباری

نمونه کد خروجی:


$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => " http://api.smsapp.ir/v2/sms/recive ",
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "checkmessageids=30001818001828&isread=0&=",
CURLOPT_HTTPHEADER => array(
"apikey:your apikey",

),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" .$err;
} else {
echo $response;
}

HttpResponse response = Unirest.post(" http://api.smsapp.ir/v2/sms/recive ")
.header("apikey", "your apikey")

.body("linenumber=30001818...&isread=0&=")
.asString();


Install-Package RestSharp

var client = new RestClient("http://api.smsapp.ir/v2/sms/recive");
var request = new RestRequest(Method.POST);
request.AddHeader("apikey", "your apikey");
request.AddParameter("linenumber","" )
request.AddParameter("isread","0/1" )
IRestResponse response = client.Execute(request);

import requests
url = " http://api.smsapp.ir/v2/sms/recive "

payload = "linenumber=3000...&isread=0&="
headers = {
'apikey': "your apikey",

}
response = requests.request("POST", url, data=payload, headers=headers)
print(response.text)

var request = require("request");

var options = { method: 'POST',
url: ' http://api.smsapp.ir/v2/sms/recive ',
headers:
{
apikey: 'your apikey' },
form: { linenumber: '3000....', isread: '0', '': '' } };

request(options, function (error, response, body) {
if (error) throw new Error(error);

console.log(body);
});

خروجی:

{"result":"success","list":[{"MessageID":62253087,"RecipientNumber":"30001818001828","SenderNumber":"09111111111","Body":"تست","ReceiveDate":"1480237406"},{"MessageID":62232291,"RecipientNumber":"30001818001828","SenderNumber":"09111111111","Body":"؟؟","ReceiveDate":"1480170680"}]}

نتیجه نهایی:

{
"result": "success",
"list":[{"MessageID":62253087,"RecipientNumber":"30001818001828","SenderNumber": "09111111111","Body":"تست","ReceiveDate":"1480237406"},{"MessageID":62232291,"RecipientNumber":"30001818001828", "SenderNumber":"09111111111","Body":"؟؟", "ReceiveDate":"1480170680"}]},

}

{
"result": "error",
}

{
"result": "error",
"message": "invalid parameter",
اگر یکی از پارامتر های ورودی به درستی وارد نشود . ,
}

{
"result": "error",
"message": "invalid api key", اگر کد apikey نامعتبر باشد .
}

جستجو در پیام های دریافتی

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

ساختار URL:

  http://api.smsapp.ir/v2/sms/receive/paging

متد:

Post

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

Parameter Entry in Format Description Required
apikey Headers String برای بدست آوردن مقدار به قسمت تنظیمات/حساب کاربری رفته و کد apikey را دریافت نمایید. اجباری
linenumber Body String

شماره خط

اجباری
fromdate Body Unixtime تاریخ شروع جستجو با فرمت Unixtime اجباری
todate Body Unixtime تاریخ پایان جستجو با فرمت Unixtime اجباری
limit Body Int

تعداد پیام بازگشتی ( 1 تا 200 )

اجباری
offset Body Int

offset

اجباری

نمونه کد خروجی:

$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => " http://api.smsapp.ir/v2/sms/receive/paging ",
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "linenumber=5000121212&fromdate=1576972800&todate=1548054490&limit=50&offset=1",
CURLOPT_HTTPHEADER => array(
"apikey:",
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}

HttpResponse response = Unirest.post(" http://api.smsapp.ir/v2/sms/receive/paging ")
.header("apikey", ""))
.body("linenumber=5000121212&fromdate=1576972800&todate=1548054490&limit=50&offset=1") ;
.asString();

Install-Package RestSharp

var client = new RestClient("http://api.smsapp.ir/v2/sms/receive/paging");
var request = new RestRequest(Method.POST);
request.AddHeader("apikey", "");
request.AddParameter("fromdate", "unixtime");
request.AddParameter("todate", "unixtime");
request.AddParameter("linenumber", 5000121212 );
request.AddParameter("limit", 50 );
request.AddParameter("offset", 2 );
IRestResponse response = client.Execute(request);

import requests
url = " http://api.smsapp.ir/v2/sms/receive/paging "
payload = "linenumber=5000121212&fromdate=1576972800&todate=1548054490&limit=50&offset=1"&="
headers = {
'apikey': "",
}
response = requests.request("POST", url, data=payload, headers=headers)
print(response.text);

var request = require("request");

var options = { method: 'POST',
url: ' http://api.smsapp.ir/v2/sms/receive/paging ',
headers:
apikey: '' },
form: { linenumber: '5000121212', fromdate : '1576972800', todate : '1548054490', limit : 50, offset : 1 } };

request(options, function (error, response, body) {
if (error) throw new Error(error);

console.log(body);
});

خروجی:

{"result":"success","list":[{"receive_id":81051747,"receive_date":"2019-01-20T11:51:32","receive_fromnumber":"09111111111","receive_message":"تست"}], "totalcount": 1}

نتیجه نهایی:

{
"result": "success",
"list":[{"receive_id":81051747,"receive_date":"2019-01-20T11:51:32","receive_fromnumber": "09111111111","receive_message":"تست"}],
"totalcount": 1
}
,

}

{
"result": "error",
}

{
"result": "error",
"message": "invalid parameter",
اگر یکی از پارامتر های ورودی به درستی وارد نشود . ,
}

{
"result": "error",
"message": "invalid api key", اگر کد apikey نامعتبر باشد .
}

لغو پیام ارسالی

از این متد برای لغو پیام های ارسالی زمانبندی شده استفاده میگردد.به این معنا که هر پیامی قابله حذف نمی باشد.

ساختار URL:

  http://api.smsapp.ir/v2/sms/send/cancel

متد:

Post

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

Parameter Entry in Format Description Required
apikey Headers String برای بدست آوردن مقدار به قسمت تنظیمات/حساب کاربری رفته و کد apikey را دریافت نمایید. اجباری
messageids Body String

شناسه پیامک که با (،) ازهم جدا می شوند

اجباری

نمونه کد خروجی:


$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => " http://api.smsapp.ir/v2/sms/send/cancel ",

CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "messageids=123456",
CURLOPT_HTTPHEADER => array(
"apikey: your apikey",
\ ),
));
$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}

HttpResponse response = Unirest.post(" http://api.smsapp.ir/v2/sms/send/cancel ")
.header("apikey", "your apikey")
.header("cache-control", "no-cache")
.body("messageids=123456")
.asString();


Install-Package RestSharp

var client = new RestClient("http://api.smsapp.ir/v2/sms/send/cancel");
var request = new RestRequest(Method.POST);
request.AddHeader("apikey", "your apikey");
request.AddParameter("messageids","" )
IRestResponse response = client.Execute(request);

import requests

url = " http://api.smsapp.ir/v2/sms/send/cancel "

payload = "messageids=123456"
headers = {
'apikey': "your apikey",

}

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

var request = require("request");

var options = { method: 'POST',
url: ' http://api.smsapp.ir/v2/sms/send/cancel ',
headers:
{ ',
apikey: 'your apikey' },
form: { messageids: '123456' } };

request(options, function (error, response, body) {
if (error) throw new Error(error);

console.log(body);
});

خروجی:

{"result":"success","res":"0"}

نتیجه نهایی:

{
"result": "success",
"res":"0"}"Array of integer": آرایه ای است از وضعیت پیامک ها ی لغو شده . عدد صفر به معنای موفقیت آمیز بودن لغو پیام می باشد و در غیر این صورت کد خطای مربوطه برمیگردد . ,

}

{
"result": "error",
}

{
"result": "error",
"message": "invalid parameter",
اگر یکی از پارامتر های ورودی به درستی وارد نشود . ,
}

{
"result": "error",
"message": "invalid api key", اگر کد apikey نامعتبر باشد .
}

توضیح کد خطا:

جدول

اعتبار باقی مانده

این متد برای دریافت مقدار ریالی اعتبار باقیمانده حساب کاربری می باشد

ساختار URL:

  http://api.smsapp.ir/v2/credit

متد:

Post

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

Parameter Entry in Format Description Required
apikey Headers String برای بدست آوردن مقدار به قسمت تنظیمات/حساب کاربری رفته و کد apikey را دریافت نمایید. اجباری

نمونه کد خروجی:

$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "http://api.ghasedaksms.com/v2/credit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"apikey: your_api_key"
)
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}

HttpResponse response = Unirest.post(" http://api.smsapp.ir/v2/credit")
.header("apikey", "your apikey")

.asString();


Install-Package RestSharp

var client = new RestClient("http://api.smsapp.ir/v2/credit");
var request = new RestRequest(Method.POST);
request.AddHeader("apikey", "your apikey");
IRestResponse response = client.Execute(request);

import requests

url = "http://api.smsapp.ir/v2/credit"

headers = {
'apikey': "your apikey",
}
response = requests.request("POST", url, headers=headers)
print(response.text)

var request = require("request");
var options = { method: 'POST',
url: ' http://api.smsapp.ir/v2/credit',
headers:
{
apikey: 'your apikey' } };

request(options, function (error, response, body) {
if (error) throw new Error(error);

console.log(body);
});

خروجی:

{"result":"success","credit":9190153.0}

نتیجه نهایی:

{
"result": "success",
credit":9190153.0"باقیمانده اعتبار به ریال",

}

{
"result": "error",
}

{
"result": "error",
"message": "description has been denied for this request.",
}

آپلود فایل

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

ساختار URL:

  http://api.smsapp.ir/v1/voice/upload

متد:

Post

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

Parameter Entry in Format Description Required
apikey Headers String برای بدست آوردن مقدار به قسمت تنظیمات/حساب کاربری رفته و کد apikey را دریافت نمایید اجباری
description Headers توضیح برای فایلی که می خواهید آپلود نمایید اجباری
file Body Wav فایل با حجم کمتر از 5 مگابایت اجباری

نمونه کد خروجی:

curl_setopt_array($curl, array(
CURLOPT_URL => " http://api.smsapp.ir/v1/voice/upload ",
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"1.wav\"\r\nContent-Type: audio/mpeg\r\n\r\n\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => array(
"apikey: your apikeyy",
"description: file-2",
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}

HttpResponse response = Unirest.post(" http://api.smsapp.ir/v1/voice/upload ")
.header("apikey", "your apikey")
.header("description", "file-2")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"1.wav\"\r\nContent-Type: audio/mpeg\r\n\r\n\r\n-----011000010111000001101001--")
.asString();

;

Install-Package RestSharp

var client = new RestClient("http://api.smsapp.ir/v1/voice/upload");
var request = new RestRequest(Method.POST);
request.AddHeader("description", "file-2");
request.AddHeader("apikey", "your apikey");
request.Parameter("file", "wav/waw");
IRestResponse response = client.Execute(request);

import requests
url = " http://api.smsapp.ir/v1/voice/upload "
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\";
filename=\"1.wav\"\r\nContent-Type:audio/mpeg\r\n\r\n\r\n-----011000010111000001101001--"
headers = {
'apikey': "your apikey",
'description': "file-2",
}response = requests.request("POST", url, data=payload, headers=headers)
print(response.text)

var fs = require("fs");
var request = require("request");
var options = { method: 'POST',
url: ' http://api.smsapp.ir/v1/voice/upload ',
headers:
{ description: 'file-2',
apikey: 'your apikey',1' },
formData:
{ file:
{ value: 'fs.createReadStream("1.wav")',
options: { filename: '1.wav', contentType: null } } } };
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});

خروجی:

{"result":"success","fileid":2285}

نتیجه نهایی:

{
"result": "success",
"fileid":2285 "example"
}

{
"result": "error",.
"message": "invalid api key"
}

{
"result": "error",
"message": "invalid parameter",
اگر یکی از پارامتر های ورودی به درستی وارد نشود . ,
}

{
"result": "error",
"message": "invalid api key", اگر کد apikey نامعتبر باشد .
}

ارسال فایل صوتی

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

ساختار URL:

  http://api.smsapp.ir/v1/voice/send/file

متد:

Post

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

Parameter Entry in Format Description Required
apikey Headers String برای بدست آوردن مقدار به قسمت تنظیمات/حساب کاربری رفته و کد apikey را دریافت نمایید اجباری
fileid body String ID فایلی که میخواهید ارسال نمایید اجباری
senddate Body Unixtime تاریخ و زمان دقیق ارسال پیام بر اساس Unixtime که اگر قید نشود در همان لحظه پیام ارسال می شود اختیاری
receptor Body 09122222222,09111111111,... لیست شماره افراد گیرنده پیام که با (،) از هم جدا می شوند اجباری

نمونه کد خروجی:

$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => " http://api.smsapp.ir/v1/voice/send/file ",
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "fileid=&receptor =",
CURLOPT_HTTPHEADER => array(
"apikey:",
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}

HttpResponse response = Unirest.post(" http://api.smsapp.ir/v1/voice/send/file ")
.header("apikey", ""))
.body("fileid=&receptor =") ;
.asString();

Install-Package RestSharp

var client = new RestClient("http://api.smsapp.ir/v1/voice/send/file");
var request = new RestRequest(Method.POST);
request.AddHeader("apikey", "");
request.AddParameter("senddate", "unixtime");
request.AddParameter("receptor", 091211111 );
request.AddParameter("fileid",");
IRestResponse response = client.Execute(request);

import requests
url = " http://api.smsapp.ir/v1/voice/send/file "
payload = "fileid=921&receptor ="
headers = {
'apikey': "",
}
response = requests.request("POST", url, data=payload, headers=headers)
print(response.text);

var request = require("request");

var options = { method: 'POST',
url: ' http://api.smsapp.ir/v1/voice/send/file ',
headers:
apikey: '' },
form: { fileid: '', receptor : '' } };

request(options, function (error, response, body) {
if (error) throw new Error(error);

console.log(body);
});

خروجی:

{"result":"success"}

نتیجه نهایی:

{
"result": "success",

}

{
"result": "error",.
"message": "خطا در سرویس دهنده
}

{
"result": "error",
"message": "invalid parameter",
اگر یکی از پارامتر های ورودی به درستی وارد نشود . ,
}

{
"result": "error",
"message": "invalid api key", اگر کد apikey نامعتبر باشد .
}

متن به گفتار

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

ساختار URL:

  http://api.smsapp.ir/v1/voice/send/text

متد:

Post

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

Parameter Entry in Format Description Required
apikey Headers String برای بدست آوردن مقدار به قسمت تنظیمات/حساب کاربری رفته و کد apikey را دریافت نمایید. اجباری
message Body String

متنی که باید ارسال شود

اجباری
senddate Body Unixtime

تاریخ و زمان دقیق ارسال پیام بر اساس Unixtime که اگر قید نشود در همان لحظه پیام ارسال می شود

اختیاری
receptor Body 09122222222,09111111111,... لیست شماره افراد گیرنده پیام که با (،) از هم جدا می شوند اجباری

نمونه کد خروجی:

$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => " http://api.smsapp.ir/v1/voice/send/text ",
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "Message=&receptor=",
CURLOPT_HTTPHEADER => array(
"apikey: your apikey",
),));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}

HttpResponse response = Unirest.post(" http://api.smsapp.ir/v1/voice/send/text ")
.header("apikey", "your apikey")
.body(" Message=&receptor= ")
.asString();


Install-Package RestSharp

var client = new RestClient("http://api.smsapp.ir/v1/voice/send/text");
var request = new RestRequest(Method.POST);
request.AddHeader("apikey", "your apikey");
request.AddParameter("senddate", "unixtime");
request.AddParameter("receptor", 0912111111 );
request.AddParameter("message",");
IRestResponse response = client.Execute(request);

import requests

url = " http://api.smsapp.ir/v1/voice/send/text "

payload = " message=&receptor ="
headers = {
'apikey': "",
}
response = requests.request("POST", url, data=payload, headers=headers )

print(response.text)
;

var request = require("request");
var options = { method: 'POST',
url: ' http://api.smsapp.ir/v1/voice/send/text ',
headers:
{
apikey: 'your apikey' },
form: { Message: '', receptor: '' } };
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});

خروجی:

{"result":"success"}

نتیجه نهایی:

{
"result": "success",
}

{
"result": "error",.
"message": "خطا در سرویس دهنده"
}

{
"result": "error",
"message": "invalid parameter",
اگر یکی از پارامتر های ورودی به درستی وارد نشود . ,
}

{
"result": "error",
"message": "invalid api key", اگر کد apikey نامعتبر باشد .
}