مشاهده منو
همه ی متد ها

متد ارسال یک متن به یک یا چند شماره با متد Get (Send )

این متد مربوط به ارسال پیامک می باشد ، این متد این قابلیت را دارد که در یک بار فراخوانی به حد اکثر 99 شماره پیام ارسال نماید، به این معنی که نیازی نیست به ازای هر شماره یک بار متد را فراخوانی نمائید، می توانید شماره ها را به دسته های 99 تایی تقسیم نموده و هر دسته را توسط یک آرایه به این متد ارسال نمائید.


پارامتر های کوئری

کلید اختصاصی هر کاربر که در سامانه ایجاد می شود و شناسه کاربر برای دسترسی به پنل می باشد
هر پیامک انگلیسی 140حرف و هر پیامک فارسی نصف آن یعنی 70 حرف می باشد. (حتی ورود ی ک حرف فارسی باعث فارسی شدن کل پیام می شود) با گذر از صفحه اول از ظرفیت هر پیامک انگلیسی7 حرف و از ظرفیت هر پیامک فارسی 3 حرف برای اتصال بین صفحات کاسته می شود ، یعنی در صورتی که پیامک ما از یک صفحه تجاوز کرد ظرفیت تمامی صفحات از جمله صفحه اول کسر می شود (نحوه تشخیص تعداد صفحه در نمونه کد ها(
شماره ای است که با یکی از عدد های 3000، 5000 و ... شروع می شود وروی گوشی گیرنده به عنوان فرستنده پیام نمایش داده می شود.
آرایه ای از نوع String که حد اکثر شامل 99 شماره است . شماره های وارد شده باید با 09 یا 989 + شروع شود .

مقادیر موجود در فیلد Result

200 OBJECT

شناسه پیام ارسالی که امکان پیگیری وضعیت پیام با استفاده از آن وجود دارد
کاربر می تواند برای پیام های ارسالی شناسه ای تعریف و آن را برای پیگیری های بیشتر به سامانه ارسال نماید

کد آماده

                                                
                                                
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'http://api.sms-webservice.com/api/V3/Send?ApiKey=123456&Text=test&Sender=123654&Recipients=9121112222',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
                                                
                                            
                                                
                                                
var client = new RestClient("http://api.sms-webservice.com/api/V3/Send?ApiKey=123456&Text=test&Sender=123654&Recipients=9121112222");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
                                                
                                            
                                                
                                                
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("http://api.sms-webservice.com/api/V3/Send?ApiKey=123456&Text=test&Sender=123654&Recipients=9121112222")
.method("GET", body)
.build();
Response response = client.newCall(request).execute();
                                                
                                            
                                                
                                                
import requests

api_key = "your_api_key"
text = "your_message"
sender = "your_sender"
recipient = "recipient_phone_number"

url = f"https://api.sms-webservice.com/api/V3/Send?ApiKey={api_key}&Text={text}&Sender={sender}&Recipients={recipient}"

payload = {}
headers = {}

try:
    response = requests.get(url, headers=headers, data=payload)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.HTTPError as err:
    print(err)

                                                
                                            

متد ارسال یک متن به یک یا چند شماره با متد post (SendBulk )

این متد مربوط به ارسال پیامک می باشد ، این متد این قابلیت را دارد که در یک بار فراخوانی به حد اکثر 99 شماره پیام ارسال نماید، به این معنی که نیازی نیست به ازای هر شماره یک بار متد را فراخوانی نمائید، می توانید شماره ها را به دسته های 99 تایی تقسیم نموده و هر دسته را توسط یک آرایه شامل شماره دریافت کننده و کد پیگیری به این متد ارسال نمائید.

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

https://api.sms-webservice.com/api/V3/SendBulk


پارامتر های کوئری

کلید اختصاصی هر کاربر که در سامانه ایجاد می شود و شناسه کاربر برای دسترسی به پنل می باشد
هر پیامک انگلیسی 140حرف و هر پیامک فارسی نصف آن یعنی 70 حرف می باشد. (حتی ورود ی ک حرف فارسی باعث فارسی شدن کل پیام می شود) با گذر از صفحه اول از ظرفیت هر پیامک انگلیسی7 حرف و از ظرفیت هر پیامک فارسی 3 حرف برای اتصال بین صفحات کاسته می شود ، یعنی در صورتی که پیامک ما از یک صفحه تجاوز کرد ظرفیت تمامی صفحات از جمله صفحه اول کسر می شود (نحوه تشخیص تعداد صفحه در نمونه کد ها(
شماره ای است که با یکی از عدد های 3000، 5000 و ... شروع می شود وروی گوشی گیرنده به عنوان فرستنده پیام نمایش داده می شود.
آرایه ای از نوع String که حد اکثر شامل 99 شماره است . شماره های وارد شده باید با 09 یا 989 + شروع شود .

مقادیر موجود در فیلد Result

200 OBJECT

خروجی این متد نیز کاملا شبیه متد قبل می باشد

شناسه پیام ارسالی که امکان پیگیری وضعیت پیام با استفاده از آن وجود دارد
کاربر می تواند برای پیام های ارسالی شناسه ای تعریف و آن را برای پیگیری های بیشتر به سامانه ارسال نماید

کد آماده

                                                
                                                
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'http://api.sms-webservice.com/api/V3/SendBulk',
  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 =>'{"ApiKey": "string","Text": "string","Sender": 0,"Recipients": [{"Destination": 0,"UserTraceId": 0}]}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
                                                
                                            
                                                
                                                
var client = new RestClient("http://api.sms-webservice.com/api/V3/SendBulk");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
var body = @"{""ApiKey"": ""string"",""Text"": ""string"",""Sender"": 0,""Recipients"": [{""Destination"": 0,""UserTraceId"": 0}]}";
request.AddParameter("application/json", body,  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
                                                
                                            
                                                
                                                    
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"ApiKey\": \"string\",\"Text\": \"string\",\"Sender\": 0,\"Recipients\": [{\"Destination\": 0,\"UserTraceId\": 0}]}");
Request request = new Request.Builder()
.url("http://api.sms-webservice.com/api/V3/SendBulk")
.method("POST", body)
.addHeader("Content-Type", "application/json")
.build();
Response response = client.newCall(request).execute();
                                                
                                            
                                                
                                                
import requests

url = "https://api.sms-webservice.com/api/V3/SendBulk"

payload = {
    "ApiKey": "your_api_key",
    "Text": "your_message",
    "Sender": 1234,
    "Recipients": [
        {
            "Destination": 5678,
            "UserTraceId": 9876
        }
    ]
}

headers = {
    'Content-Type': 'application/json' 
}

try:
    response = requests.post(url, headers=headers, json=payload)
    response.raise_for_status() 
    print(response.text)
except requests.exceptions.HTTPError as err:
    print(err)

                                                
                                            

متد ارسال چند متن به چند گیرنده (SendMultiple)

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

https://api.sms-webservice.com/api/V3/SendMultiple


پارامتر های کوئری

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


مقادیر موجود در فیلد Result

200 OBJECT

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

شناسه پیام ارسالی که امکان پیگیری وضعیت پیام با استفاده از آن وجود دارد
کاربر می تواند برای پیام های ارسالی شناسه ای تعریف و آن را برای پیگیری های بیشتر به سامانه ارسال نماید

کد آماده

                                                
                                                
$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => 'http://api.sms-webservice.com/api/V3/SendMultiple',
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 =>'{"ApiKey": "123456","Recipients": [{"Sender": 0,"Text": "test","Destination": 0,"UserTraceId": 0}]}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
                                                
                                            
                                                
                                                
var client = new RestClient("http://api.sms-webservice.com/api/V3/SendMultiple");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
var body = @"{""ApiKey"": ""123456"",""Recipients"": [{""Sender"": 0,""Text"": ""test"",""Destination"": 0,""UserTraceId"": 0}]}";
request.AddParameter("application/json", body,  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
                                                
                                            
                                                
                                                
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"ApiKey\": \"123456\",\"Recipients\": [{\"Sender\": 0,\"Text\": \"test\",\"Destination\": 0,\"UserTraceId\": 0}]}");
Request request = new Request.Builder()
.url("http://api.sms-webservice.com/api/V3/SendMultiple")
.method("POST", body)
.addHeader("Content-Type", "application/json")
.build();
Response response = client.newCall(request).execute();
                                                
                                            
                                                
                                                
import requests

url = "https://api.sms-webservice.com/api/V3/SendMultiple"

payload = {
    "ApiKey": "your_api_key",
    "Recipients": [
        {
            "Sender": "your_sender",
            "Text": "your_message",
            "Destination": "recipient_phone_number",
            "UserTraceId": "unique_id"
        }
    ]
}

headers = {
    'Content-Type': 'application/json'  
}

try:
    response = requests.post(url, headers=headers, json=payload)
    response.raise_for_status() 
    print(response.text)
except requests.exceptions.HTTPError as err:
    print(err)

                                                
                                            

متد ارسال به یک شماره با استفاده از الگوی تعریف شده (SendTokenSingle)

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


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

کلید اختصاصی هر کاربر که در سامانه ایجاد می شود و شناسه کاربر برای دسترسی به پنل می باشد
کلیدی است که حین تعریف الگو در پنل خود تعریف نموده اید.
شماره ای که پیام شما را دریافت خواهد کرد.
مقدار مربوط به پارامتر اول که در متن بصورت {1} نوشته شده است.
مقدار مربوط به پارامتر دوم که در متن بصورت {2} نوشته شده است.
مقدار مربوط به پارامتر سوم که در متن بصورت {3} نوشته شده است.

مقادیر موجود در فیلد Result

200 OBJECT

پاسخ این متد علاوه بر فیلدهای Id و UserTraceId دو مقدار دیگر نیز در خروجی اضافه شده است،

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

کد آماده

                                                
                                                
$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => 'http://api.sms-webservice.com/api/V3/SendTokenSingle?ApiKey=123456&TemplateKey=123654&Destination=9121111111&p1=125&p2=45&p3=name',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_POSTFIELDS =>'{"ApiKey": "123456","Recipients": [{"Sender": 0,"Text": "test","Destination": 0,"UserTraceId": 0}]}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
                                                
                                            
                                                
                                                
var client = new RestClient("http://api.sms-webservice.com/api/V3/SendTokenSingle?ApiKey=123456&TemplateKey=123654&Destination=9121111111&p1=125&p2=45&p3=name");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Content-Type", "application/json");
var body = @"{""ApiKey"": ""123456"",""Recipients"": [{""Sender"": 0,""Text"": ""test"",""Destination"": 0,""UserTraceId"": 0}]}";
request.AddParameter("application/json", body,  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
                                                
                                            
                                                
                                                
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"ApiKey\": \"123456\",\"Recipients\": [{\"Sender\": 0,\"Text\": \"test\",\"Destination\": 0,\"UserTraceId\": 0}]}");
Request request = new Request.Builder()
.url("http://api.sms-webservice.com/api/V3/SendTokenSingle?ApiKey=123456&TemplateKey=123654&Destination=9121111111&p1=125&p2=45&p3=name")
.method("GET", body)
.addHeader("Content-Type", "application/json")
.build();
Response response = client.newCall(request).execute();
                                                
                                            
                                                
                                                
import requests

url = "https://api.sms-webservice.com/api/V3/SendTokenSingle"

api_key = "your_api_key"
template_key = "your_template_key"
destination = "recipient_phone_number"
param1 = "value1"
param2 = "value2"
param3 = "value3"

url += f"?ApiKey={api_key}&TemplateKey={template_key}&Destination={destination}&p1={param1}&p2={param2}&p3={param3}"

headers = {
  'Content-Type': 'text/plain'
}

try:
    response = requests.get(url, headers=headers)
    response.raise_for_status() 
    print(response.text)
except requests.exceptions.HTTPError as err:
    print(err)

                                                
                                            

متد ارسال یک الگو با متن های مختلف به چند شماره (SendTokenMulti)

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

https://api.sms-webservice.com/api/V3/SendTokenMulti


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

                                                    {
    "ApiKey": "string",
    "TemplateKey": "string",
    "Recipients": [
        {
        "Destination": 0,
        "UserTraceId": 0,
        "Parameters": [
            "string"
        ]
        }  ]}
                                                    
                                                

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


مقادیر موجود در فیلد Result

200 OBJECT

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

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

کد آماده

                                                
                                                
$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => 'http://api.sms-webservice.com/api/V3/SendTokenMulti',
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 =>'{"ApiKey": "string","TemplateKey": "string","Recipients": [{"Destination": 0,"UserTraceId": 0,"Parameters": ["string"]}]}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
                                                
                                            
                                                
                                                
var client = new RestClient("http://api.sms-webservice.com/api/V3/SendTokenMulti");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
var body = @"{""ApiKey"": ""string"",""TemplateKey"": ""string"",""Recipients"": [{""Destination"": 0,""UserTraceId"": 0,""Parameters"": [""string""]}]}";
request.AddParameter("application/json", body,  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);S
                                                
                                            
                                                
                                                
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"ApiKey\": \"string\",\"TemplateKey\": \"string\",\"Recipients\": [{\"Destination\": 0,\"UserTraceId\": 0,\"Parameters\": [\"string\"]}]}");
Request request = new Request.Builder()
.url("http://api.sms-webservice.com/api/V3/SendTokenMulti")
.method("POST", body)
.addHeader("Content-Type", "application/json")
.build();
Response response = client.newCall(request).execute();
                                                
                                            
                                                
                                                
import requests

url = "https://api.sms-webservice.com/api/V3/SendTokenMulti"

payload = {
    "ApiKey": "your_api_key",
    "TemplateKey": "your_template_key",
    "Recipients": [
        {
            "Destination": "recipient_phone_number",
            "UserTraceId": "unique_id",
            "Parameters": [
                "param1_value",
                "param2_value",
                "param3_value"
            ]
        }
    ]
}

headers = {
    'Content-Type': 'application/json'
}

try:
    response = requests.post(url, headers=headers, json=payload)
    response.raise_for_status() 
    print(response.text)
except requests.exceptions.HTTPError as err:
    print(err)

                                                
                                            

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

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

https://api.sms-webservice.com/api/V3/TokenList


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

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

کلید اختصاصی هر کاربر که در سامانه ایجاد می شود و شناسه کاربر برای دسترسی به پنل می باشد

مقادیر موجود در فیلد Result

200 OBJECT

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

اگر 0 باشد : درانتظار بررسی مقادیر
اگر 1 باشد : تایید شده
اگر 2 باشد : رد شده، قابل ویرایش
اگر 3 باشید : ردشده، غیر قابل ویرایش

کد آماده

                                                
                                                
$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => 'http://api.sms-webservice.com/api/V3/TokenList',
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 =>'{
"ApiKey": "123456"
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
                                                
                                            
                                                
                                                
var client = new RestClient("http://api.sms-webservice.com/api/V3/TokenList");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"  ""ApiKey"": ""123456""
" + "\n" +
@"}";
request.AddParameter("application/json", body,  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
                                                
                                            
                                                
                                                
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n  \"ApiKey\": \"123456\"\r\n}");
Request request = new Request.Builder()
.url("http://api.sms-webservice.com/api/V3/TokenList")
.method("POST", body)
.addHeader("Content-Type", "application/json")
.build();
Response response = client.newCall(request).execute();
                                                
                                            
                                                
                                                
import requests

url = "https://api.sms-webservice.com/api/V3/TokenList"

payload = {
    "ApiKey": "your_api_key"
}

headers = {
    'Content-Type': 'application/json' 
}

try:
    response = requests.post(url, headers=headers, json=payload)
    response.raise_for_status() 
    print(response.text)
except requests.exceptions.HTTPError as err:
    print(err)

                                                
                                            

متد دریافت وضعیت پیام های ارسالی (StatusById)

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

https://api.sms-webservice.com/api/V3/StatusById


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

این متد نیز post بوده و پارامترهای ورودی از طریق بدنه متد ارسال میشوند، بدنه متد شامل شناسه پنل و لیستی از شناسه پیامک های ارسالی که می خواهیم وضعیت آنها را داشته باشیم :

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

مقادیر موجود در فیلد Result

200 OBJECT

پاسخ این متد شامل لیستی است که به ازای هر id ، UserTraceId ووضعیت پیام ارسالی را نمایش می دهد، لیست کامل وضعیت هایی که به ازای این درخواست ممکن است دریافت نمایید، در جدول انتهای این سند موجود است.

شناسه پیام ارسالی که امکان پیگیری وضعیت پیام با استفاده از آن وجود دارد
کاربر می تواند برای پیام های ارسالی شناسه ای تعریف و آن را برای پیگیری های بیشتر به سامانه ارسال نماید
کد وضعیت پیامک ارسال شده
متن توضیح در مورد وضعیت پیامک ارسال شده

کد آماده

                                                
                                                
$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => 'http://api.sms-webservice.com/api/V3/StatusById',
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 =>'{"ApiKey": "string","Ids": [0]}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
                                                
                                            
                                                
                                                
var client = new RestClient("http://api.sms-webservice.com/api/V3/StatusById");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
var body = @"{""ApiKey"": ""string"",""Ids"": [0]}";
request.AddParameter("application/json", body,  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
                                                
                                            
                                                
                                                
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"ApiKey\": \"string\",\"Ids\": [0]}");
Request request = new Request.Builder()
.url("http://api.sms-webservice.com/api/V3/StatusById")
.method("POST", body)
.addHeader("Content-Type", "application/json")
.build();
Response response = client.newCall(request).execute();
                                                
                                            
                                                
                                                
import requests

url = "https://api.sms-webservice.com/api/V3/StatusById"

payload = {
    "ApiKey": "your_api_key",
    "Ids": [
        123456789 
    ]
}

headers = {
    'Content-Type': 'application/json'
}

try:
    response = requests.post(url, headers=headers, json=payload)
    response.raise_for_status() 
    print(response.text)
except requests.exceptions.HTTPError as err:
    print(err)

                                                
                                            

متد دریافت وضعیت پیام های ارسالی (StatusByTraceId)

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

https://api.sms-webservice.com/api/V3/StatusByUserTraceId


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

این متد نیز post بوده و پارامترهای ورودی از طریق بدنه متد ارسال میشوند، بدنه متد شامل شناسه پنل و لیستی از شناسه پیامک های ارسالی که قبلا توسط سیستم شما ایجاد شده و به سامانه ارسال شده، می باشد.

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

مقادیر موجود در فیلد Result

200 OBJECT

پاسخ این متد شامل لیستی است که به ازای هر UserTraceId ، id و وضعیت پیام ارسالی را نمایش می دهد، ، لیست کامل وضعیت هایی که به ازای این درخواست ممکن است دریافت نمایید، در جدول انتهای این سند موجود است.

شناسه پیام ارسالی که امکان پیگیری وضعیت پیام با استفاده از آن وجود دارد
کاربر می تواند برای پیام های ارسالی شناسه ای تعریف و آن را برای پیگیری های بیشتر به سامانه ارسال نماید
کد وضعیت پیامک ارسال شده
متن توضیح در مورد وضعیت پیامک ارسال شده

کد آماده

                                                
                                                
$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => 'http://api.sms-webservice.com/api/V3/StatusByUserTraceId',
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 =>'{"ApiKey": "string","UserTraceIds": [0]}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
                                                
                                            
                                                
                                                
var client = new RestClient("http://api.sms-webservice.com/api/V3/StatusByUserTraceId");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
var body = @"{""ApiKey"": ""string"",""UserTraceIds"": [0]}";
request.AddParameter("application/json", body,  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
                                                
                                            
                                                
                                                
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"ApiKey\": \"string\",\"UserTraceIds\": [0]}");
Request request = new Request.Builder()
.url("http://api.sms-webservice.com/api/V3/StatusByUserTraceId")
.method("POST", body)
.addHeader("Content-Type", "application/json")
.build();
Response response = client.newCall(request).execute();
                                                
                                            
                                                
                                                
import requests

url = "https://api.sms-webservice.com/api/V3/StatusByUserTraceId"

payload = {
    "ApiKey": "your_api_key",
    "UserTraceIds": [
        123456789 
    ]
}

headers = {
    'Content-Type': 'application/json' 
}

try:
    response = requests.post(url, headers=headers, json=payload)
    response.raise_for_status()  
    print(response.text)
except requests.exceptions.HTTPError as err:
    print(err)

                                                
                                            

متد دریافت مقدار اعتبار و لیست خطوط ارسال کننده فعال در پنل (AccountInfo)

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

https://api.sms-webservice.com/api/V3/AccountInfo


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

این متد نیز post بوده و پارامترهای ورودی از طریق بدنه متد ارسال میشوند، بدنه متد شامل شناسه پنل و لیستی از شناسه پیامک های ارسالی که قبلا توسط سیستم شما ایجاد شده و به سامانه ارسال شده، می باشد.

کلید اختصاصی هر کاربر که در سامانه ایجاد می شود و شناسه کاربر برای دسترسی به پنل می باشد

مقادیر موجود در فیلد Result

200 OBJECT

پاسخ این متد شامل لیستی است که به ازای هر UserTraceId ، id و وضعیت پیام ارسالی را نمایش می دهد، ، لیست کامل وضعیت هایی که به ازای این درخواست ممکن است دریافت نمایید، در جدول انتهای این سند موجود است.

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

کد آماده

                                                
                                                
$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => 'http://api.sms-webservice.com/api/V3/AccountInfo',
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 =>'{"ApiKey": "123456"}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
                                                
                                            
                                                
                                                
var client = new RestClient("http://api.sms-webservice.com/api/V3/AccountInfo");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
var body = @"{""ApiKey"": ""123456""}";
request.AddParameter("application/json", body,  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
                                                
                                            
                                                
                                                
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"ApiKey\": \"123456\"}");
Request request = new Request.Builder()
.url("http://api.sms-webservice.com/api/V3/AccountInfo")
.method("POST", body)
.addHeader("Content-Type", "application/json")
.build();
Response response = client.newCall(request).execute();
                                                
                                            
                                                
                                                
import requests

url = "https://api.sms-webservice.com/api/V3/AccountInfo"

payload = {
    "ApiKey": "your_api_key"
}

headers = {
    'Content-Type': 'application/json' 
}

try:
    response = requests.post(url, headers=headers, json=payload)
    response.raise_for_status() 
    print(response.text)
except requests.exceptions.HTTPError as err:
    print(err)