معرفی REST API

همان طور که شاید تا به حال شنیده باشید API مخفف عبارت Application Programming Interface می باشد که به برنامه نویسان امکان رد و بدل کردن اطلاعات مابین پلتفرم های مختلف را از طریق ارسال یک درخواست HTTP(S) ساده و فراخوانی متد های مورد نظر می دهد

در واقع REST یکی روش ساده و انعطاف پذیری برای استفاده از API است و البته محبوب ترین و پر کاربرد ترین که می توان توسط این ساختار از هر کلاینت و پلتفرمی درخواست ساده HTTP(S) را ارسال و پاسخ آن را دریافت نمود.
حال فرض کنید در خواست مورد نظر اطلاعات مربوط به ارسال یک پیامک باشد و جواب آن نتیجه و وضعیت پیامک ارسالی باشد
وب سرویس ارسال اس ام اس کاوه نگار شماره گیرنده ، متن پیامک و شماره فرستنده را از طریق پارامتر های ورودی در متد GET یا POST دریافت می کند و خروجی را در غالب فرمت های XML و JSON برگشت می دهد.
نکته : اگر با JSON آشنائی ندارید می توانید با مراجعه به سایت json.org هم از ساختار فرمت آن مطلع شوید و هم درایور مربوط به زبان برنامه نویسی مورد نظر خود را دریافت نمائید.

شروع

قبل از آن که در مورد ساختار خروجی متد ها توضیح دهیم این متد را باهم اجرا کنیم :

خروجی باید چیزی شبیه به این باشد :

{
    "return":
    {
        "status":200,
        "message":"تایید شد"
    },
    "entries":
    {
        "datetime":"02/06/2012 01:53:46 ب.ظ",
        "year":2012,
        "month":1,
        "day":26,
        "hour":13,
        "minute":53,
        "second":46,
        "unixtime":1338645226
    }
}

<response>
    <return>
        <status>200</status>
        <message>تایید شد</message>
    </return>
    <entries>
        <item>
            <datetime>02/06/2012 01:53:46 ب.ظ</datetime>
            <year>2012</year>
            <month>06</month>
            <day>02</day>
            <hour>13</hour>
            <minute>53</minute>
            <second>46</second>
            <unixtime>1338645226</unixtime>
        </item>
    </entries>
</response>

این متد تاریخ و زمان سرور کاوه نگار و همچنین زمان معادل آن به فرمت UnixTime را به شما نشان میدهد
کلیه فیلد های مربوط به تاریخ در وب سرویس کاوه نگار به فرمت UnixTime می باشد . دلیل استفاده از این فرمت جلوگیری از بروز خطا در هنگام پردازش آنهاست. برای آشنائی با فرمت UnixTime می توانید به اینجا مراجعه کنید و همچنین نمونه کد تبدیل آن را برای زبان های برنامه نویسی مختلف از اینجا دریافت کنید.

{
    "return":
    {
        "status":404,
        "message":"متد تعریف نشده است"
    },
    "entries":
    {
        null
    }
}

<response>
    <return>
        <status>404</status>
        <message>متد تعریف نشده است</message>
    </return>
    <entries>
    </entries>
</response>

طول پیامک

طول استاندارد یک پیام کوتاه 140 ﺑﺎﻳﺖ که معادل 70 کاراکتر برای یک پیامک فارسی و 140 کاراکتر برای یک پیامک لاتین و 140 بایت برای پیامک باینری می باشد. بنابراین هر کاراکتر فارسی معادل 2 بایت محاسبه می شود , این موضوع به دلیل گنجاندن کاراکتر های فارسی در فرمت یونیکد می باشد که با وجود حتی یک کاراکتر فارسی در پیامک باعث میشود تا طول آن بر حسب فرمت یونیکد (هر کاراکتر 22 بایت) محاسبه شده و پیامک فارسی شود (پیامک های فارسی ارزان تر از پیامک های لاتین هستند).

پیامک های چند بخشی

در صورتی که پیامک از طول استاندارد 140 بایت بیشتر شود باید به بخش های 140 بایتی تقسیم شده و سپس به مقصد ارسال شود که البته این کار توسط وب سرویس موجود انجام می شود و نیاز نیست برای این موضوع عملیاتی انجام دهید کافیست کل پیام را در فراخوانی وب سرویس ارسال نمائید . البته به این موضوع باید توجه داشت که به ازای هر بخش از یک پیامک فارسی طولانی، 3 کاراکتر و به ازای هر بخش از کی پیامک لاتین طولانی، 7 کاراکتر از فضای استاندارد متین پیامک به کد UDH اختصاص پیدا میکند.یعنی در واقع هر بخش از پیامک چند قسمتی فارسی حداکثر67 کاراکتروهربخش ازپیامک چند قسمتی لاتین حداکثر153 کاراکتررادرخودجای میدهد.

ﺣﺪاﻛﺜﺮ ﻃﻮل پیامک

حداکثر طول کل متن پیامک برای پیامک لاتین 612 ﻛﺎراﻛﺘﺮ و ﺑﺮاي پیامک ﻓﺎرﺳی 268 ﻛﺎراﻛﺘﺮ میباشد. درصورتی که بیشتر از این مقدار ارسال شود مقدار پارامتر status معادل 413 به معنای "متن پیام خالی است و یا طول آن بیشتر از حد مجاز می باشد" را برگشت میدهد. علاوه بر این موضوع در هر بار فراخوانی متد های ارسال پیامک می توانید حداکثر 200 پیامک ارسال کنید . این محدودیت برای حفظ کیفیت در ارسال و سرعت پاسخگوئی قرارداده شده است همچنین در هر بار فراخوانی متد های کنترل وضعیت Status و انصراف از ارسال پیامک Cancel میتوانید حداکثر 3,000 شناسه را در ورودی قرار دهید .

خطای مربوط به حداکثر رکورد درخواستی در هر بار فراخوانی :

توجه : شما می توانید با فراخوانی متد ها از طریق ساختار Multi-Threaded میزان درخواست همزمان خود را افزایش دهید . موضوع محدودیت مربوط به تعداد در هر بار فراخوانی (Per Request) می باشد.

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

در طراحی وب سرویس کاوه نگار سعی شده تا جای ممکن نسبت به داده های ورودی حساسیت وجود نداشته باشد در نهایت پارامتر ها با فرمت زیر قابل تشخیص هستند در غیر اینصورت احتمال دریافت کد خطا در داده های ورودی وجود دارد.
در هنگام ارسال درخواست با متد HTTP GET حتما مقدار پارامتر ها را URL Encode نمائید.

از این متد برای ارسال پیامک استفاده می کنیم ، امکان ارسال یک پیامک خاص به چندین گیرنده ( Receptor ) در این متد وجود دارد کافیست آنها را از طریق کاراکتر ویرگول « , » از هم جدا کنید .

{
    "return":
    {
        "status":200,
        "message":"تایید شد"
    },
    "entries": 
    [
        {
            "messageid":8792343,
            "message":"خدمات پیام کوتاه کاوه نگار",
            "status":1,
            "statustext":"در صف ارسال",
            "sender":"10004346",
            "receptor":"09125258596",
            "date":1356619709,
            "cost":120
        },
        {
            "messageid":8792344,
            "message":"خدمات پیام کوتاه کاوه نگار",
            "status":1,
            "statustext":"در صف ارسال",
            "sender":"10004346",
            "receptor":"09128585774",
            "date":1356619709,
            "cost":120
        }
    ]
}

<response>
    <return>
        <status>200</status>
        <message>تایید شد</message>
    </return>
    <entries>
        <item>
            <messageid>8792343</messageid>
            <message>خدمات پیام کوتاه کاوه نگار</message>
            <status>1</status>
            <statustext>در صف ارسال</statustext>
            <sender>10004346</sender>
            <receptor>09125258596</receptor>
            <date>1356620651</date>
            <cost>120</cost>
        </item>
        <item>
            <messageid>8792344</messageid>
            <message>خدمات پیام کوتاه کاوه نگار</message>
            <status>1</status>
            <statustext>در صف ارسال</statustext>
            <sender>10004346</sender>
            <receptor>09128585774</receptor>
            <date>1356620651</date>
            <cost>120</cost>
        </item>
    </entries>
</response>

پیامک ها بعد از این از طریق وب سرویس ارسال میشوند وضعیت در صف خواهند داشت ، در کمتر از 1 ثانیه به مخابرات تحویل داده میشوند و وضعیت ارسال به مخابرات را خواهند داشت ، بعد از 5 دقیقه از زمان تحویل به مخابرات تا زمانی که وضعیت آنها تغییر نکند دائما کنترل میشوند ، در نهایت پیامک های ارسالی یکی از مقادیر جدول 2 وضعیت پیامک ها را خواهند داشت.
از این تابع برای کنترل وضعیت رسید Delivery پیامک استفاده می شود . برای این منظور باید شناسه یکتای هر پیامک MessageId را که در هنگام ارسال پیامک از خروجی دریافت کرده اید را ارسال نمائید.
در هر بار اجرای این متد می توانید از وضعیت 3،000 پیامک با خبر شوید . کافیست شناسه یکتای پیامک ها را از طریق کاراکتر ویرگول «,» از هم جدا کنید .

{
    "return":
    {
        "status":200,
        "message":"تایید شد"
    },
    "entries": 
     [
        {
            "messageid" : 85463238 , 
            "status" : 10 , 
            "statustext" : "رسیده به گیرنده"
       },
       {
            "messageid" : 85463239 , 
            "status" : 4 , 
            "statustext" : "ارسال به مخابرات"
       }
   ]
}

<response>
    <return>
        <status>200</status>
        <message>تایید شد</message>
    </return>
    <entries>
        <item>
            <messageid>85463238</messageid>
            <status>10</status>
            <statustext>رسیده به گیرنده</statustext>
        </item>
        <item>
            <messageid>85463239</messageid>
            <status>4</status>
            <statustext>ارسال به مخابرات</statustext>
        </item>
    </entries>
</response>

شما علاوه بر واکشی وضعیت پیامک های ارسال توسط متد Status ، میتوانید توسط پارامتر LocalId که در هنگام ارسال پیامک پاس داده اید هم وضعیت پیامک ها را واکشی نمائید ، ساختار خروجی این متد همانند متد Status می باشد.
ممکن است به هر دلیلی ساختار پایگاه داده شما به نحوی باشد که توانائی ذخیره سازی شناسه یکتای پیامک MessageId را نداشته باشید ، آنگاه برای واکشی وضعیت پیامک های ارسالی میتوانید از این متد استفاده نمائید.
در نهایت پیامک های ارسالی یکی از مقادیر جدول 2 وضعیت پیامک ها را خواهند داشت.
در هر بار اجرای این متد می توانید از وضعیت 3،000 پیامک با خبر شوید . کافیست شناسه محلی پیامک ها LocalId را از طریق کاراکتر ویرگول «,» از هم جدا کنید .

{
    "return":
    {
        "status":200,
        "message":"تایید شد"
    },
    "entries": 
     [
        {
				        "messageid": 85463238, 
				        "localid": "450",
            "status" : 10 , 
            "statustext" : "رسیده به گیرنده"
       }
   ]
}

<response>
    <return>
        <status>200</status>
        <message>تایید شد</message>
    </return>
    <entries>
        <item>
            <messageid>85463238</messageid>
											 <localid>450</localid>
            <status>10</status>
            <statustext>رسیده به گیرنده</statustext>
        </item>
     </entries>
</response>

در صورتی که میخواهید اطلاعات پیامک ارسالی را بازیابی نمائید ، میتوانید با MessageId و استفاده از این متد اطلاعات رکورد را دریافت کنید .
در هر بار اجرای این متد می توانید از وضعیت 500 پیامک با خبر شوید . کافیست شناسه یکتای پیامک ها را از طریق کاراکتر ویرگول «,» از هم جدا کنید .

{
    "return":
    {
        "status":200,
        "message":"تایید شد"
    },
    "entries": 
   [
        {
            "messageid":30034577,
            "message":"خدمات پیام کوتاه کاوه نگار",
            "status":10,
            "statustext":"رسیده به گیرنده",
            "sender":"30001528961415",
            "receptor":"09125258596",
            "date":1356619709,
            "cost":120
        },
        {
            "messageid":30034578,
            "message":"خدمات پیام کوتاه کاوه نگار",
            "status":11,
            "statustext":"نرسیده به گیرنده",
            "sender":"30001528961415",
            "receptor":"09128585774",
            "date":1356619709,
            "cost":120
        }
    ]
}

<response>
    <return>
        <status>200</status>
        <message>تایید شد</message>
    </return>
    <entries>
        <item>
            <messageid>30034577</messageid>
            <message>خدمات پیام کوتاه کاوه نگار</message>
            <status>10</status>
            <statustext>رسیده به گیرنده</statustext>
            <sender>30001528961415</sender>
            <receptor>09125258596</receptor>
            <date>1356619709</date>
            <cost>120</cost>
        </item>
        <item>
            <messageid>30034578</messageid>
            <message>خدمات پیام کوتاه کاوه نگار</message>
            <status>11</status>
            <statustext>نرسیده به گیرنده</statustext>
            <sender>30001528961415</sender>
            <receptor>09128585774</receptor>
            <date>1356619709</date>
            <cost>120</cost>
        </item>
    </entries>
</response>

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

{
    "return":
    {
        "status":200,
        "message":"تایید شد"
    },
    "entries": 
   [
        {
            "messageid":30034577,
            "message":"خدمات پیام کوتاه کاوه نگار",
            "status":10,
            "statustext":"رسیده به گیرنده",
            "sender":"30002626",
            "receptor":"09125258596",
            "date":1409533200,
            "cost":120
        },
        {
            "messageid":30034578,
            "message":"خدمات پیام کوتاه کاوه نگار",
            "status":10,
            "statustext":"رسیده به گیرنده",
            "sender":"30002626",
            "receptor":"09128585774",
            "date":1409565600,
            "cost":120
        }
    ]
}

<response>
    <return>
        <status>200</status>
        <message>تایید شد</message>
    </return>
    <entries>
        <item>
            <messageid>30034577</messageid>
            <message>خدمات پیام کوتاه کاوه نگار</message>
            <status>10</status>
            <statustext>رسیده به گوشی</statustext>
            <sender>30002626</sender>
            <receptor>09125258596</receptor>
            <date>1409533200</date>
            <cost>120</cost>
        </item>
        <item>
            <messageid>30034578</messageid>
            <message>خدمات پیام کوتاه کاوه نگار</message>
            <status>10</status>
            <statustext>رسیده به گوشی</statustext>
            <sender>30002626</sender>
            <receptor>09128585774</receptor>
            <date>1409565600</date>
            <cost>120</cost>
        </item>
    </entries>
</response>

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

{
    "return":
    {
        "status":200,
        "message":"تایید شد"
    },
    "entries": 
   [
        {
            "messageid":30034577,
            "message":"خدمات پیام کوتاه کاوه نگار",
            "status":10,
            "statustext":"رسیده به گیرنده",
            "sender":"30002626",
            "receptor":"09125258596",
            "date":1409533200,
            "cost":120
        },
        {
            "messageid":30034578,
            "message":"خدمات پیام کوتاه کاوه نگار",
            "status":10,
            "statustext":"رسیده به گیرنده",
            "sender":"30002626",
            "receptor":"09128585774",
            "date":1409565600,
            "cost":120
        },
        {
            "messageid":30034579,
            "message":"خدمات پیام کوتاه کاوه نگار",
            "status":10,
            "statustext":"رسیده به گیرنده",
            "sender":"30002626",
            "receptor":"09124585774",
            "date":1409565600,
            "cost":120
        }
    ]
}

<response>
    <return>
        <status>200</status>
        <message>تایید شد</message>
    </return>
    <entries>
        <item>
            <messageid>30034577</messageid>
            <message>خدمات پیام کوتاه کاوه نگار</message>
            <status>10</status>
            <statustext>رسیده به گیرنده</statustext>
            <sender>30002626</sender>
            <receptor>09125258596</receptor>
            <date>1409533200</date>
            <cost>120</cost>
        </item>
        <item>
            <messageid>30034578</messageid>
            <message>خدمات پیام کوتاه کاوه نگار</message>
            <status>10</status>
            <statustext>رسیده به گیرنده</statustext>
            <sender>30002626</sender>
            <receptor>09128585774</receptor>
            <date>1409565600</date>
            <cost>120</cost>
        </item>
       <item>
          <messageid>30034579</messageid>
          <message>خدمات پیام کوتاه کاوه نگار</message>
          <status>10</status>
          <statustext>رسیده به گیرنده</statustext>
          <sender>30002626</sender>
          <receptor>09124585774</receptor>
          <date>1409565600</date>
          <cost>120</cost>
       </item>
    </entries>
</response>

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

{
    "return":
    {
        "status":200,
        "message":"تایید شد"
    },
    "entries": 
   [
        {
            "startdate":1409533200,
            "enddate":1409533200,
            "sumpart":45000,
            "sumcount":15000,
            "cost":5175000
        }
    ]
}

<response>
    <return>
        <status>200</status>
        <message>تایید شد</message>
    </return>
    <entries>
        <item>
            <startdate>1409533200</startdate>
            <enddate>1409533200</enddate>
            <sumpart>45000</sumpart>
            <sumcount>15000</sumcount>
            <cost>5175000</cost>
        </item>
    </entries>
</response>

شما می توانید در هنگام ارسال پیامک از طریق پارامتر Date تاریخ ارسال پیامک را مشخص نمایید . در صورتی که ارسال پیامک در تاریخ معینی تنظیم شود پیامک زمانبندی می شود ، حال شما مایل هستید این زمان بندی را لغو نمایید ، راه حل شما استفاده از این متد است .
در هر بار اجرای این متد می توانید ارسال حداکثر 3،000 پیامک را لغو نمائید، کافیست شناسه ها را از طریق کاراکتر ویرگول «,» از هم جدا کنید.

{
    "return":
    {
        "status":200,
        "message":"تایید شد"
    },
    "entries": 
    [
        {
            "messageid" : 31031212 , 
            "status" : 13 , 
            "statustext" : "لغو شده"
        },
        {
            "messageid" : 31031213 , 
            "status" : 13 , 
            "statustext" : "لغو شده"
        },
        {
            "messageid" : 31031214 , 
            "status" : 13 , 
            "statustext" : "لغو شده"
        }   
    ]
}

<response>
    <return>
        <status>200</status>
        <message>تایید شد</message>
    </return>
    <entries>
       <item>
          <messageid>31031212</messageid>
          <status>13</status>
          <statustext>لغو شده</statustext>
       </item> 
          <item>
          <messageid>31031213</messageid>
          <status>13</status>
          <statustext>لغو شده</statustext>
       </item> 
       <item>
          <messageid>31031214</messageid>
          <status>13</status>
          <statustext>لغو شده</statustext>
       </item> 
    </entries>
</response>

API کاوه نگار علاوه بر امکان ارسال پیامک های دریافت شده به URL شما Receive via Callback URL امکان این را دارد که شما از طریق فراخوانی این متد پیامک های دریافتی خط مورد نظر را واکشی کنید . بعد از فراخوانی این متد پیامک های که در خروجی قرار می گیرند وضعیت خوانده شده isRead = 1 را خواهند داشت.
علاوه بر این شما می توانید سیستم دریافت پیامک خود را با تنظیم URL در بخش تنظیمات به صورت Real-Time داشته باشید که به محظ دریافت پیامک از مخابرات آن را برای شما از طریق URL ارسال نماید ، در نهایت در صورتی که پیامک های دریافت شده از طریق URL به هر دلیلی به دست شما نرسد وضعیت خوانده نشده isRead = 0 خواهند داشت که می توانید با اجرای این متد کلیه پیام ها را دریافت کنید.

{
    "return":
    {
        "status":200,
        "message":"تایید شد"
    },
    "entries": [
        {
            "messageid" : 35850015 , 
            "message" : "خدمات پیام کوتاه کاوه نگار" , 
            "sender" : "09360462960" ,
            "receptor" : "3000202030" ,
            "date" : 1357206241 
        },
        {
            "messageid" : 35850016 , 
            "message" : "خدمات پیام کوتاه کاوه نگار" , 
            "sender" : "09123832441" ,
            "receptor" : "3000202030" ,
            "date" : 1357103281 
        }
    ]
}

<response>
    <return>
        <status>200</status>
        <message>تایید شد</message>
    </return>
    <entries>
        <item>
            <messageid>35850015</messageid>
            <message>خدمات پیام کوتاه کاوه نگار</message>
            <sender>09360462960</sender>
            <receptor>3000202030</receptor>
            <date>1357103281</date>
        </item>
        <item>
            <messageid>35850016</messageid>
            <message>خدمات پیام کوتاه کاوه نگار</message>
            <sender>09123832441</sender>
            <receptor>3000202030</receptor>
            <date>1357103281</date>
        </item>
    </entries>
</response>

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

{
    "return":
    {
        "status":200,
        "message":"تایید شد"
    },
    "entries": 
   [
        {
            "startdate":1409533200,
            "enddate":1409533200,
            "sumcount":15000
        }
    ]
}

<response>
    <return>
        <status>200</status>
        <message>تایید شد</message>
    </return>
    <entries>
        <item>
            <startdate>1409533200</startdate>
            <enddate>1409533200</enddate>
            <sumcount>15000</sumcount>
        </item>
    </entries>
</response>

در صورتی که میخواهید از تعداد شماره موبایل در منطقه پستی خاصی اطلاع داشته باشید از این متد استفاده کنید .
توجه نمائید بیشتر شماره های موجود براساس کد پستی 5رقمی می باشند در واقع 5 رقم شروع کد پستی نشان دهنده شهر،منطقه،خیابان و کوچه است و 5 رقم دیگر به شماره پلاک و طبقه و پلاک و... اشاره دارد که در اطلاعات 5 رقم دوم در دسترس نیست ، بنابراین برای دریافت استعلام درست کد پستی کافیست 5 یا 4 یا 3 رفم اول کد پستی منطقه مورد نظر را وارد کنید.

{
    "return":
    {
        "status":200,
        "message":"تایید شد"
    },
    "entries": 
    [
        {
            "section" : "MCI" , 
            "value" : 853654
        },
        {
            "section" : "MTN" , 
            "value" : 15234 
        }
    ]
}

<response>
    <return>
        <status>200</status>
        <message>تایید شد</message>
    </return>
    <entries>
       <item>
          <messageid>MCI</messageid>
          <status>853654</status>
       </item> 
          <item>
          <messageid>MTN</messageid>
          <status>15234</status>
       </item> 
    </entries>
</response>

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

{
    "return":
    {
        "status":200,
        "message":"تایید شد"
    },
    "entries": 
    [
        {
            "messageid":8792343,
            "message":"خدمات پیام کوتاه کاوه نگار",
            "status":1,
            "statustext":"در صف ارسال",
            "sender":"300002626",
            "receptor":"0912132111*",
            "date":1356619709,
            "cost":120
        },
        {
            "messageid":8792344,
            "message":"خدمات پیام کوتاه کاوه نگار",
            "status":1,
            "statustext":"در صف ارسال",
            "sender":"300002626",
            "receptor":"0912123000*",
            "date":1356619709,
            "cost":120
        },
        {
           "messageid":8792345,
           "message":"خدمات پیام کوتاه کاوه نگار",
           "status":1,
           "statustext":"در صف ارسال",
           "sender":"300002626",
           "receptor":"0938520525*",
           "date":1356619709,
           "cost":120
        },
        {
           "messageid":8792346,
           "message":"خدمات پیام کوتاه کاوه نگار",
           "status":1,
           "statustext":"در صف ارسال",
           "sender":"300002626",
           "receptor":"0938452142*",
           "date":1356619709,
           "cost":120
        }
    ]
}

<response>
    <return>
        <status>200</status>
        <message>تایید شد</message>
    </return>
    <entries>
        <item>
            <messageid>8792343</messageid>
            <message>خدمات پیام کوتاه کاوه نگار</message>
            <status>1</status>
            <statustext>در صف ارسال</statustext>
            <sender>300002626</sender>
            <receptor>0912132111*</receptor>
            <date>1356619709</date>
            <cost>120</cost>
        </item>
        <item>
            <messageid>8792344</messageid>
            <message>خدمات پیام کوتاه کاوه نگار</message>
            <status>1</status>
            <statustext>در صف ارسال</statustext>
            <sender>300002626</sender>
            <receptor>0912123000*</receptor>
            <date>1356619709</date>
            <cost>120</cost>
        </item>
      <item>
            <messageid>8792345</messageid>
            <message>خدمات پیام کوتاه کاوه نگار</message>
            <status>1</status>
            <statustext>در صف ارسال</statustext>
            <sender>300002626</sender>
            <receptor>0938520525*</receptor>
            <date>1356619709</date>
            <cost>120</cost>
        </item>
        <item>
            <messageid>8792346</messageid>
            <message>خدمات پیام کوتاه کاوه نگار</message>
            <status>1</status>
            <statustext>در صف ارسال</statustext>
            <sender>300002626</sender>
            <receptor>0938452142*</receptor>
            <date>1356619709</date>
            <cost>120</cost>
        </item>
    </entries>
</response>

از طریق این متد میتوانید برای احراز هویت کاربران با ارسال کد اعتبار سنجی و یا اطلاعات ضروری مانند ارسال رمزعبور،کد تایید عضویت ، شماره فاکتور، کدهای خرید و تخفیف و ... استفاده نمایید. فرق این متد با متد ارسال پیامک در این است که پیامک های این متد بالاترین اولویت را دارند و هیچ کدام از پیامک های آن فیلتر نخواهند شد ( ارسال پیامک به افرادی که پیامک تبلیغاتی خود را بسته اند ) همچنین این متد قابلیت ارسال پیامک به 148 کشور دنیا را دارد.
برای مشاهده ویژگی های این سرویس به صفحه معرفی آن مراجعه کنید. معرفی سرویس اعتبار سنجی
در ساختار این متد نیازی نیست فرستنده را ارسال کنید کافیست گیرنده و مقدار کد Token را ارسال نمایید. سیستم بهترین پیش شماره داخلی یا خارجی را انتخاب می کند و پیامک را ارسال می کند.
برای استفاده از این متد نیاز است ابتدا الگوی پیام خود را از طریق پنل مشخص نمایید.

{
    "return":
    {
        "status":200,
        "message":"تایید شد"
    },
    "entries": {
            "messageid":8792343,
		"message": "ممنون از ثبت نام شما کد تایید عضویت  : 852596	",
            "status":5,
            "statustext":"ارسال به مخابرات",
            "sender":"10004346",
            "receptor":"09361234567",
            "date":1356619709,
            "cost":120
   }    
    
}

<response>
    <return>
        <status>200</status>
        <message>تایید شد</message>
    </return>
    <entries>
        <item>
            <messageid>8792343</messageid>
            <message>ممنون از ثبت نام شما کد تایید عضویت  :852596</message>
            <status>5</status>
            <statustext>ارسال به مخابرات</statustext>
            <sender>10004346</sender>
            <receptor>09361234567</receptor>
            <date>1356620651</date>
            <cost>120</cost>
        </item>
    </entries>
</response>

از این متد برای ارسال تماس صوتی استفاده می کنیم ، امکان ارسال یک تماس صوتی خاص به چندین گیرنده ( Receptor ) در این متد وجود دارد کافیست آنها را از طریق کاراکتر ویرگول « , » از هم جدا کنید .

{
    "return":
    {
        "status":200,
        "message":"تایید شد"
    },
    "entries": {
            "messageid":8792343,
		"message": "ممنون از ثبت نام شما کد تایید عضویت  : 852596	",
            "status":5,
            "statustext":"ارسال به مخابرات",
            "sender":"10004346",
            "receptor":"09361234567",
            "date":1356619709,
            "cost":120
   }    
    
}

<response>
    <return>
        <status>200</status>
        <message>تایید شد</message>
    </return>
    <entries>
        <item>
            <messageid>8792343</messageid>
            <message>ممنون از ثبت نام شما کد تایید عضویت  :852596</message>
            <status>5</status>
            <statustext>ارسال به مخابرات</statustext>
            <sender>10004346</sender>
            <receptor>09361234567</receptor>
            <date>1356620651</date>
            <cost>120</cost>
        </item>
    </entries>
</response>

از این متد میتوانید برای دریافت تنظیمات حساب و یا تغییر مقادیر آن استفاده نمائید ، برای دریافت مقادیر کافیست درخواست GET بدون هیچ پارامتری ارسال نمائید ، همچنین برای تنظیم مقدار هر پارامتر نام پارامتر به همراه مقدار آن را توسط درخواست GET یا POST ارسال نمائید .

{
    "return":
    {
        "status":200,
        "message":"تایید شد"
    },
    "entries": {
	"apilogs": "justfaults",
	"dailyreport": "disabled",
         "debugmode":"enabled",
         "defaultsender":"10004535",
         "mincreditalarm":"50000",
         "resendfailed":"true"
   }    
    
}

<response>
    <return>
        <status>200</status>
        <message>تایید شد</message>
    </return>
    <entries>
        <item>
		<apilogs>justfaults</apilogs>
		<dailyreport>disabled</dailyreport>
		<debugmode>enabled</debugmode>
		<defaultsender>10004535</defaultsender>
		<mincreditalarm>50000</mincreditalarm>
		<resendfailed>true</resendfailed>
        </item>
    </entries>
</response>