با خرید پنل پیامک، شماره اختصاصی هدیه دریافت کنید
بعد از انتخاب پنل پیامک خود در SMS.ir یک خط پیامکی اختصاصی بهصورت هدیه دریافت خواهید کرد!
var data = JSON.stringify({ "lineNumber": 300000000000, "messageText": "Your Text", "mobiles": [ "Your Mobile 1", "Your Mobile 2" ], "sendDateTime": null }); var config = { method: 'post', url: 'https://api.sms.ir/v1/send/bulk', headers: { 'X-API-KEY': 'YOURAPIKEY', 'Content-Type': 'application/json' }, data : data }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
مناسب برای ارسال پیامکهای تکی و گروهی
اگر قصد دارید از طریق سایت یا نرمافزار خودتان، با وب سرویس پیامکهای ساده تکی و گروهی ارسال کنید، استفاده از متد Bulk به شما پیشنهاد میشود. این متد ارسالهای شما را از خط اختصاصی خودتان ارسال میکند. درصورتی که خط اختصاصی شما خدماتی نشده باشد با این متد پیامکهای شما به لیست سیاه ارسال نخواهد شد.
var data = JSON.stringify({ "mobile": "Your Mobile", "templateId": "YourTemplateID", "parameters": [ {name: 'PARAMETER1' , value: '000000'}, {name: 'PARAMETER2' , value: '000000'} ], }); var config = { method: 'post', url: 'https://api.sms.ir/v1/send/verify', headers: { 'Content-Type': 'application/json', 'Accept': 'text/plain', 'x-api-key': 'YOURAPIKEY' }, data : data }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
مناسب برای ارسال کدتائید و فاکتور سفارشات
با استفاده از این متد شما میتوانید پیامکهایی مانند کدتائید ورود به سایت، اطلاعرسانی وضعیت سفارشات و دیگر موارد مشابه را در ظرف چندثانیه به تمام شمارهها ارسال کنید. برای استفاده از این متد ابتدا میبایست متن خود را بهصورت قالب(پترن) در سامانه تعریف کنید. از مزایای این متد میتوان به ارسال سریع و امکان ارسال به لیست سیاه اشاره کرد.
در این بخش مفاهیم و قراردادهای کلی مربوط به استفاده از وب سرویس sms.ir، شرح داده خواهند شد.
شما میتوانید برای انجام تنظیمات ضروری و یا شخصی سازی شده، از هدرهای مشخص شده در جدول زیر استفاده نمایید.
عملکرد | مقدار | کلید |
---|---|---|
دریافت خروجی با فرمت Json یا Xml | application/json یا application/xml | ACCEPT |
احراز هویت | کلید تعریف شده در پنل | X-API-KEY |
تمامی درخواست های ارسالی دارای HTTP status code های بازگشتی مطابق جدول زیر میباشند..
توضیح | کد وضعیت |
---|---|
عملیات موفقیت آمیز | 200 |
وقوع خطای منطقی | 400 |
وجود خطا در فرآیند احراز هویت | 401 |
تعداد درخواست غیر مجاز | 429 |
خطای غیر منتظره | 500 |
واحد مقادیر مربوط به زمان در سطح این سامانه به صورت Unix Time و بر حسب ساعت هماهنگ جهانی (UTC) لحاظ شده است.
تمامی درخواست های ارسالی دارای مدل بازگشتی یکپارچه با ساختار زیر میباشند.
{
"status":1,
"message":"موفق",
"data":[
30004505000027,
10002166593818
]
}
توضیح | مشخصه |
---|---|
کد وضعیت | Status |
توضیحات وضعیت درخواست | Message |
دیتای بازگشتی | Data |
شبه منظور هویت سنجی در هنگام استفاده از وب سرویسهای پیامک سفید ملزم به ارسال کلید خصوصی در بخش هدر درخواست مورد نظر میباشید. کلید های خصوصی شما در پنل برنامه نویسان قابل مشاهده و مدیریت میباشند.در هنگام فراخوانی متدهای سامانه کلید خصوصی را با عنوان X-API-KEY در هدر درخواست قرار دهید.
PN1TVeBeaAehFLJAKU4XdfpsFXsQguYfleO0bV4ceh6diTZid2hRXza3uSkBbDef
این متد برای ارسال یک متن پیامک به گروهی از شماره موبایل ها مورد استفاده قرار میگیرد. همچنین شما میتوانید با مقداردهی به پارامتر زمان ارسال، از قابلیت ارسال پیامک زمانبندی شده نیز استفاده نمایید.
URL: https://api.sms.ir/v1/send/bulk
Request Method : POST
حداکثر تعداد مجاز شمارههای مقصد 100 میباشد.برای ارسال زمانبندی شده ، زمان معتبر می تواند در بازه یک ساعت آینده تا حداکثر 365 روز آینده در نظر گرفته شود.برای ارسال زمانبندی شده، انتخاب زمان گذشته نامعتبر میباشد.
توضیح | نوع | ارسال | مشخصه |
---|---|---|---|
شماره خط ارسالی | Long | اجباری | lineNumber |
متن پیام کوتاه | String | اجباری | MessageText |
شماره موبایلها | Array of String | اجباری | Mobiles |
زمان ارسال پیامک (در صورت خالی بودن، ارسال در لحظه انجام میشود) | UnixTime | اختیاری | SendDateTime |
توضیح | نوع | مشخصه |
---|---|---|
شناسه یکتای مجموعه ارسال | Guid | PackId |
آرایه ای از شناسه های یکتای هر پیامک | Array of Integer | MessageIds |
اعتبار مصرفی مجموعه ارسال | Decimal | Cost |
{
"status": 1,
"message": "موفق",
"data": {
"packId": "2b99e63c-9bf8-4a21-9bfe-3f72dc1b46f1",
"messageIds": [
86522023,
86522024
],
"cost": 2.0
}
}
{
"status": 1,
"message": "موفق",
"data": {
"packId": "2b99e63c-9bf8-4a21-9bfe-3f72dc1b46f1",
"messageIds": [
86522023,
86522024
],
"cost": 2.0
}
}
در دیتای بازگشتی، مقادیر آرایه MessageIds میتواند شامل مقادیر id متناظر آن، Null و یا صفر باشد.مقدار صفر به این معناست که شماره متناظر، در لیست سیاه میباشد.مقدار Null به این معناست که شماره متناظر، غلط است یا متن بیش از حد می باشد.
این متد برای ارسال یک متن پیامک به گروهی از شماره موبایل ها مورد استفاده قرار میگیرد. همچنین شما میتوانید با مقداردهی به پارامتر زمان ارسال، از قابلیت ارسال پیامک زمانبندی شده نیز استفاده نمایید.
URL: https://api.sms.ir/v1/send/likeToLike
Request Method : POST
تعداد شماره موبایلها و متنهای پیامک باید برابر باشند.
برای ارسال زمانبدی شده ، زمان معتبر می تواند در بازه یک ساعت آینده تا حداکثر 365 روز آیندهدر نظر گرفته شود.حداکثر تعداد مجاز شمارههای مقصد 100 میباشد.
ارسال نظیر به نظیر
این متد برای ارسال یک متن پیامک به گروهی از شماره موبایل ها مورد استفاده قرار میگیرد. همچنین شما میتوانید با مقداردهی به پارامتر زمان ارسال، از قابلیت ارسال پیامک زمانبندی شده نیز استفاده نمایید.
URL: https://api.sms.ir/v1/send/likeToLike
Request Method : POST
حداکثر تعداد مجاز شمارههای مقصد 100 میباشد.برای ارسال زمانبدی شده ، زمان معتبر می تواند در بازه یک ساعت آینده تا حداکثر 365 روز آینده در نظر گرفته شود.تعداد شماره موبایلها و متنهای پیامک باید برابر باشند.برای ارسال زمانبندی شده، انتخاب زمان گذشته نامعتبر میباشد.
توضیح | نوع | ارسال | مشخصه |
---|---|---|---|
شماره خط ارسالی | Long | اجباری | lineNumber |
متن پیام کوتاه | Array of String | اجباری | MessageTexts |
شماره موبایلها | Array of String | اجباری | Mobiles |
زمان ارسال پیامک (در صورت خالی بودن، ارسال در لحظه انجام میشود) |
UnixTime | اختیاری | SendDateTime |
توضیح | نوع | مشخصه |
---|---|---|
شناسه یکتای مجموعه ارسال | Guid | PackId |
آرایه ای از شناسه های یکتای هر پیامک | Array of Integer | MessageIds |
اعتبار مصرفی مجموعه ارسال | Decimal | Cost |
{
"lineNumber": "30004505000017",
"messageTexts": [
"سرویس پیامکی ایده پردازان با 10 سال سابقه همراه شماست",
"ipdemy.ir پلتفرم آموزش آنلاین، آکادمی ایده پردازان"
],
"mobiles": [
"912xxxx677",
"+98919xxxx904"
]
}
{
"status": 1,
"message": "موفق",
"data": {
"packId": "2b99e63c-9bf8-4a21-9bfe-3f72dc1b46f1",
"messageIds": [
86522023,
86522024
],
"cost": 2.0
}
}
مقدار Null به این معناست که شماره متناظر، غلط است یا متن بیش از حد می باشد.در دیتای بازگشتی، مقادیر آرایه MessageIds میتواند شامل مقادیر id متناظر آن، Null و یا صفر باشد.مقدار صفر به این معناست که شماره متناظر، در لیست سیاه میباشد.
بهمنظور حذف و انصراف از ارسال زمانبندی شده میتوانید از متد زیر استفاده نمایید. در این متد، شناسه مجموعه ارسال (packId) دریافتی از خروجی ارسال گروهی یا نظیر به نظیر، مورد استفاده قرار میگیرد.
Request Method : DELETE
حداکثر تا 3 دقیقه مانده به زمان ارسال زمانبندی شده، مجاز به لغو آن میباشید.
توضیح | نوع | ارسال | مشخصه |
---|---|---|---|
شناسه مجموعه ارسال | Guid | اجباری | PackId |
توضیح | نوع | مشخصه |
---|---|---|
مقدار اعتبار بازگشتی | Decimal | ReturnedCreditCount |
تعداد پیامک ها | Integer | SmsCount |
{ "status": 1, "message": "موفق", "data": { "returnedCreditCount": 10.0, "smsCount": 5 } }
با استفاده از این متد شما قادر به ارسال پیامک به منظور ارسال کد اعتبارسنجی (verification code)، کد تایید، فاکتور خرید و به طور کلی پیامکهایی با اولویت بالا و پارامترهای پویا میباشید. از آنجایی که این نوع از ارسال با خطوط خدماتی ارسال میشود امکان دریافت آن توسط افرادی که پیامکهای تبلیغاتی خود را مسدود کردهاند نیز وجود دارد و با اولویت بالایی ارسال خواهد شد.برای استفاده از این نوع ارسال ابتدا قالب پیامک خود را در پنل (بخش ارسال سریع) مشخص نمایید.
Request Method : POST
توضیح | نوع | ارسال | مشخصه |
---|---|---|---|
شماره موبایل | String | اجباری | Mobile |
شناسه قالب (قالب ها از طریق پنل قابل تعریف و مدیریت میباشند) | Integer | اجباری | TemplateId |
آرایه ای از مدل parameter برای تعیین مقادیر جایگزین شونده در قالب تعریف شده (ساختار مدل parameter در جدول زیر ذکر شده است) | Array of Parameter Model | اجباری | Parameters |
توضیح | نوع | ارسال | مشخصه |
---|---|---|---|
کلید تعیین شده در قالب (بدون در نظر گرفتن # در ابتدا و انتهای آن) | String | اجباری | Name |
مقدار کلید تعیین شده برای جایگزینی در قالب پیامک | String | اجباری | Value |
توضیح | نوع | مشخصه |
---|---|---|
شناسه یکتای پیامک | Integer | MessageId |
اعتبار مصرفی ارسال | Decimal | Cost |
{ "mobile": "919xxxx904", "templateId": 123456, "parameters": [ { "name": "Code", "value": "12345" } ] }
{ "status": 1, "message": "موفق", "data": { "messageId": 89545112, "cost": 1.0 } }
این متد برای ارسال پیامک از طریق URL مورد استفاده قرار میگیرد. برای ارسال کافی است پارامترهای مورد نیاز را در قالب Query Params در آدرس مشخص شده قرار دهید.
URL: https://api.sms.ir/v1/send
Request Method : GET, POST
توضیح | نوع | ارسال | مشخصه |
---|---|---|---|
نام کاربری | String | اجباری | Username |
کلید خصوصی (کلیدهای خصوصی شما در پنل برنامهنویسان قابل مشاهده و مدیریت میباشند.) | String | اجباری | Password |
شماره خط | Long | اجباری | Line |
شماره موبایل | String | اجباری | Mobile |
متن پیامک | String | اجباری | Text |
توضیح | نوع | مشخصه |
---|---|---|
شناسه یکتای پیامک | Integer | MessageId |
اعتبار مصرفی ارسال | Decimal | Cost |
https://api.sms.ir/v1/send?username=MY_USERNAME&password=MY_APIKEY&line=LINE_NUMBER&mobile=MOBILE&text="MESSAGE_TEXT"
{ "status": 1, "message": "موفق", "data": { "messageId": 89545112, "cost": 1.0 } }
شما میتوانید با استفاده از شناسه یکتای پیامک که پس از انجام هریک از ارسالها دریافت کردهاید، با فراخوانی این متد، به دریافت اطلاعات پیامک و همینطور اطلاع از وضعیت (Delivery) آن اقدام نمایید.
Request Method: GET
توضیح | نوع | مشخصه |
---|---|---|
شناسه یکتای پیامک | Integer | MessageId |
شماره موبایل | Long | Mobile |
متن پیامک | String | MessageText |
زمان ارسال | Integer (UnixTime) | SendDateTime |
شماره خط | Long | LineNumber |
اعتبار کسر شده | Decimal | Cost |
وضعیت دلیوری | Nullable Byte | DeliveryState |
زمان دلیوری | Nullable Integer (UnixTime) | DeliveryDateTime |
URL: https://api.sms.ir/v1/send/89545112
{ "status": 1, "message": "موفق", "data": { "messageId": 89545112, "mobile": 912xxxx677, "messageText": "سرویس پیامکی ایده پردازان با 10 سال سابقه همراه شماست", "sendDateTime": 1628683626, "lineNumber": 30004505000017, "cost": 1.0, "deliveryState": 1, "deliveryDateTime": 1628683629 } }
شما میتوانید با استفاده از این گزارش اطلاعات کلی مجموعه ارسالهای روز جاری را دریافت نمایید.
URL: https://api.sms.ir/v1/send/pack
Request Method : GET
توضیح | نوع | ارسال | مشخصه |
---|---|---|---|
تعداد آیتمهای در صفحه (مقدار پیشفرض 100 میباشد) | Integer | اختیاری | PageSize |
شماره صفحه درخواستی (مقدار پیشفرض 1 میباشد) | Integer | اختیاری | PageNumber |
توضیح | نوع | مشخصه |
---|---|---|
شناسه مجموعه | GUID | packId |
تعداد مخاطبان | Number | recipientCount |
زمان ایجاد | Number | creationDateTime |
URL: https://api.sms.ir/v1/send/pack
{ "status": 1, "message": "موفق", "data": [{ "packId": e7c09e23f0db4834b9bcb79e7b054f4c, "recipientCount": 100, "creationDateTime": 1628683626, },{ "packId": 0cf3017fd9d84babbb5ed5579104dab2, "recipientCount": 200, "creationDateTime": 1628683626, }] }
شما میتوانید با استفاده از شناسه مجموعه ارسال، گزارشی از پیامکهای ارسالی در آن درخواست به همراه وضعیتهایشان را دریافت نمایید.
URL: https://api.sms.ir/v1/send/pack/{packId}
Request Method : GET
توضیح | نوع | ارسال | مشخصه |
---|---|---|---|
شناسه مجموعه ارسال | Guid | اجباری | PackId |
توضیح | نوع | مشخصه |
---|---|---|
شناسه یکتای پیامک | Integer | MessageId |
شماره موبایل | Long | Mobile |
متن پیامک | String | MessageText |
زمان ارسال | Integer (UnixTime) | SendDateTime |
شماره خط | Long | LineNumber |
اعتبار کسر شده | Decimal | Cost |
وضعیت دلیوری | Nullable Byte | DeliveryState |
زمان دلیوری | Nullable Integer (UnixTime) | DeliveryDateTime |
{ "status": 1, "message": "موفق", "data": [{ "messageId": 89545112, "mobile": 912xxxx677, "messageText": "سرویس پیامکی ایده پردازان با 10 سال سابقه همراه شماست", "sendDateTime": 1628683626, "lineNumber": 30004505000017, "cost": 1.0, "deliveryState": 1, "deliveryDateTime": 1628683629 },{ "messageId": 89545113, "mobile": 919xxxx378, "messageText": "ipdemy.ir پلتفرم آموزش آنلاین، آکادمی ایده پردازان", "sendDateTime": 1628683626, "lineNumber": 30004505000017, "cost": 1.0, "deliveryState": 3, "deliveryDateTime": 1628683625 }] }
شما استفاده از متد زیر، گزارشی از ارسالهای انجام شده در روز جاری قابل دریافت است.
URL: https://api.sms.ir/v1/send/live
Request Method : GET
توضیح | نوع | ارسال | مشخصه |
---|---|---|---|
تعداد آیتمهای در صفحه (حداکثر:100 ، پیش فرض: 100) | Integer | اختیاری | PageSize |
شماره صفحه درخواستی (مقدار پیشفرض 1 میباشد) | Integer | اختیاری | PageNumber |
توضیح | نوع | مشخصه |
---|---|---|
شناسه یکتای پیامک | Integer | MessageId |
شماره موبایل | Long | Mobile |
متن پیامک | String | MessageText |
زمان ارسال | Integer (UnixTime) | SendDateTime |
شماره خط | Long | LineNumber |
اعتبار کسر شده | Decimal | Cost |
وضعیت دلیوری | Nullable Byte | DeliveryState |
زمان دلیوری | Nullable Integer (UnixTime) | DeliveryDateTime |
URL: https://api.sms.ir/v1/send/live?pageSize=25&pageNumber=3
{ "status": 1, "message": "موفق", "data": [{ "messageId": 89545112, "mobile": 912xxxx677, "messageText": "سرویس پیامکی ایده پردازان با 10 سال سابقه همراه شماست", "sendDateTime": 1628683626, "lineNumber": 30004505000017, "cost": 1.0, "deliveryState": 1, "deliveryDateTime": 1628683629 },{ "messageId": 89545113, "mobile": 919xxxx378, "messageText": "ipdemy.ir پلتفرم آموزش آنلاین، آکادمی ایده پردازان", "sendDateTime": 1628683626, "lineNumber": 30004505000017, "cost": 1.0, "deliveryState": 3, "deliveryDateTime": 1628683625 }] }
شما فراخوانی متد زیر، گزارشی از ارسالهای انجام شده در گذشته (تا انتهای روز قبل)، را دریافت خواهید نمود.
URL: https://api.sms.ir/v1/send/archive
Request Method : GET
توضیح | نوع | ارسال | مشخصه |
---|---|---|---|
از تاریخ | Integer (UnixTime) | اختیاری | FromDate |
تا تاریخ | Integer (UnixTime) | اختیاری | ToDate |
تعداد آیتمهای در صفحه (حداکثر:100 ، پیش فرض: 100) | Integer | اختیاری | PageSize |
شماره صفحه درخواستی (مقدار پیشفرض 1 میباشد) | Integer | اختیاری | PageNumber |
توضیح | نوع | مشخصه |
---|---|---|
شناسه یکتای پیامک | Integer | MessageId |
شماره موبایل | Long | Mobile |
متن پیامک | String | MessageText |
زمان ارسال | Integer (UnixTime) | SendDateTime |
شماره خط | Long | LineNumber |
اعتبار کسر شده | Decimal | Cost |
وضعیت دلیوری | Nullable Byte | DeliveryState |
زمان دلیوری | Nullable Integer (UnixTime) | DeliveryDateTime |
URL: https://api.sms.ir/v1/send/archive?fromDate=1613465574&toDate=1623805200
{ "status": 1, "message": "موفق", "data": [{ "messageId": 89545112, "mobile": 912xxxx677, "messageText": "سرویس پیامکی ایده پردازان با 10 سال سابقه همراه شماست", "sendDateTime": 1628583626, "lineNumber": 30004505000017, "cost": 1.0, "deliveryState": 1, "deliveryDateTime": 1628683629 },{ "messageId": 89545113, "mobile": 919xxxx378, "messageText": "ipdemy.ir پلتفرم آموزش آنلاین، آکادمی ایده پردازان", "sendDateTime": 1628583626, "lineNumber": 30004505000017, "cost": 1.0, "deliveryState": 3, "deliveryDateTime": 1628683625 },{ "messageId": 89545114, "mobile": 921xxxx432, "messageText": "HyperBox.irفروشگاه اینترنتی اسباب بازی و عروسک ", "sendDateTime": 1628583626, "lineNumber": 30004505000017, "cost": 1.0, "deliveryState": 1, "deliveryDateTime": 1628683669 }] ] }
شما میتوانید با استفاده از این متد، تازهترین پیامکهای دریافتی را مشاهده نمایید. لازم به ذکر است هر پیامک دریافتی تنها یک مرتبه توسط این متد قابل دستیابی میباشد و پس از آن به دلیل قرار گرفتن در حالت خوانده شده قابل دسترسی مجدد توسط این متد نمیباشند.
URL: https://api.sms.ir/v1/receive/latest
Request Method : GET
توضیح | نوع | ارسال | مشخصه |
---|---|---|---|
تعداد درخواستی (حداکثر تعداد درخواستی و مقدار پیشفرض 100 میباشد) | Integer | اختیاری | Count |
توضیح | نوع | مشخصه |
---|---|---|
شماره موبایل ارسال کننده | Long | Mobile |
متن پیامک | String | MessageText |
شماره خط دریافت کننده | Long | Number |
زمان دریافت | Integer (UnixTime) | ReceivedDateTime |
شناسه یکتای پیامک دریافتی | Long | ReceiveReturnId |
URL: https://api.sms.ir/v1/receive/latest?count=50
{ "status": 1, "message": "موفق", "data": [ { "receiveReturnId": 123456789, "messageText": "HyperBox.irفروشگاه اینترنتی اسباب بازی و عروسک", "number": 30004505000017, "mobile": 912xxxx002, "receivedDateTime": 1628683625 } ] }
با فراخوانی متد زیر، گزارش پیامکهای دریافتی روز جاری (اعم از خوانده شده و نشده) قابل دستیابی میباشد.
در آغازین ساعات روز، گزارش پیام های دریافتی روز گذشته نیز با فراخوانی این متد قابل دریافت میباشد.
URL: https://api.sms.ir/v1/receive/live
Request Method : GET
توضیح | نوع | ارسال | مشخصه |
---|---|---|---|
تعداد آیتمهای در صفحه (حداکثر:100 ، پیش فرض: 100) | Integer | اختیاری | PageSize |
شماره صفحه درخواستی (مقدار پیشفرض 1 میباشد) | Integer | اختیاری | PageNumber |
مرتب سازی بر اساس تاریخ دریافت (پیش فرض به صورت صعودی، با مقدار False) | Boolean | اختیاری | sortByNewest |
توضیح | نوع | مشخصه |
---|---|---|
شماره موبایل ارسال کننده | Long | Mobile |
متن پیامک | String | MessageText |
شماره خط دریافت کننده | Long | Number |
زمان دریافت | Integer (UnixTime) | ReceivedDateTime |
URL: https://api.sms.ir/v1/receive/live?pageSize=20&pageNumber=3&sortByNewest=false
{ "status": 1, "message": "موفق", "data": [ { "messageText": "HyperBox.irفروشگاه اینترنتی اسباب بازی و عروسک", "number": 30004505000017, "mobile": 912xxxx002, "receivedDateTime": 1628683625 } ] }
با فراخوانی متد زیر، گزارشی از پیامکهای دریافتی در گذشته (تا انتهای روز قبل)، را مشاهده خواهید نمود.
URL: https://api.sms.ir/v1/receive/archive
Request Method : GET
توضیح | نوع | ارسال | مشخصه |
---|---|---|---|
از تاریخ | Integer (UnixTime) | اختیاری | FromDate |
تا تاریخ | Integer (UnixTime) | اختیاری | ToDate |
تعداد آیتمهای در صفحه (حداکثر:100 ، پیش فرض: 100) | Integer | اختیاری | PageSize |
شماره صفحه درخواستی (مقدار پیشفرض 1 میباشد) | Integer | اختیاری | PageNumber |
توضیح | نوع | مشخصه |
---|---|---|
شماره موبایل ارسال کننده | Long | Mobile |
متن پیامک | String | MessageText |
شماره خط دریافت کننده | Long | Number |
زمان دریافت | Integer (UnixTime) | ReceivedDateTime |
شناسه پیامک دریافتی | Long | ReceiveReturnId |
URL: https://api.sms.ir/v1/receive/archive?fromDate=1613465574&toDate=1623805200
{ "status": 1, "message": "موفق", "data": [ { "receiveReturnId": 12345678987, "messageText": "HyperBox.irفروشگاه اینترنتی اسباب بازی و عروسک", "number": 30004505000017, "mobile": 912xxxx002, "receivedDateTime": 1628683625 } ] }
برای مشاهده مقدار اعتبار فعلی از متد زیر استفاده نمایید.
Request Method : GET
توضیح | نوع |
---|---|
مقدار اعتبار | Decimal |
{
"status": 1,
"message": "موفق",
"data": 165.3
}
با استفاده از این متد، لیست خطوط آماده استفاده برای ارسال، قابل مشاهده است.
Request Method : GET
توضیح | نوع |
---|---|
شماره خط | Long |
{
"status": 1,
"message": "موفق",
"data": [10002155613464, 30004505000017]
}
Sandbox محیطی تستی برای کاربران و توسعهدهندگان است که امکان آزمایش عملکرد درخواستها را پیش از استفاده در محیط اصلی (Production) فراهم میکند. این محیط با دادههای شبیهسازیشده به کاربران کمک میکند تا بدون ارسال پیامک واقعی یا کسر اعتبار، درخواستهای خود را بررسی و بهینه کنند.
برای استفاده از Sandbox باید از API Key مخصوص این محیط استفاده شود.
ساختار URLها، ورودیها و خروجیها مشابه محیط اصلی است.
کلید Sandbox از مسیر زیر قابل ایجاد است: برنامهنویسان ← لیست کلیدهای API ← ایجاد کلید جدید
پاسخهای بازگشتی شبیهسازیشده و فاقد اعتبار واقعی هستند.
خطاهای بازگشتی مشابه محیط اصلی هستند و صحت ورودیها را بررسی میکنند.
در محیط Sandbox، فقط یک قالب پیشفرض برای متد Verify فعال است:
شناسه قالب: 123456
متن قالب: کد تایید شما: #CODE#
این قالب پیشفرض به کاربران این امکان را میدهد که در شرایطی مانند عدم راهاندازی کامل سایت، نبود اینماد، یا توسعه محیط آزمایشی، کدهای خود را با استفاده از کلید وبسرویس نوع Sandbox در محیط تست بررسی و آزمایش کنند.
اطلاعات بازگشتی تنها در پاسخ به درخواستها نمایش داده میشود و گزارشی در سامانه ثبت نمیشود.
کلید مخصوص Sandbox: ارسالها در این محیط بهصورت شبیهسازیشده انجام میشوند، بدون اینکه پیامکی واقعی ارسال شود یا هزینهای کسر گردد.
عدم ثبت گزارشات: گزارشی از ارسالها در سامانه ثبت نمیشود و فقط پاسخها در همان لحظه نمایش داده میشوند.
تطابق با محیط اصلی: ورودیها، خروجیها و پیامهای خطا مشابه محیط اصلی هستند.
دادههای شبیهسازیشده: تمامی دادههای بازگشتی صرفاً برای شبیهسازی عملکرد API ارائه میشوند و اعتبار واقعی ندارند.
به بخش برنامهنویسان ← لیست کلیدهای API ← ایجاد کلید جدید (نوع: Sandbox) مراجعه کنید.
کلید ایجادشده را در هدر درخواستها وارد کنید.
درخواستها را با همان ساختار و URLهای محیط اصلی ارسال کنید.
URL: https://api.sms.ir/v1/send/verify
Request Method : GET
{
'Content-Type': 'application/json',
'Accept': 'text/plain',
'x-api-key': 'YOUR_SANDBOX_API_KEY'
}
{
"mobile": "919xxxx904",
"templateId": 123456,
"parameters": [
{
"name": "Code",
"value": "12345"
}
]
}
در صورت موفقیت:
{
"status": 1,
"message": "موفق",
"data": {
"messageId": 89545112,
"cost": 1.0
}
}
توضیح | کد وضعیت |
---|---|
عملیات با موفقیت انجام شد | 1 |
مشکلی در سامانه رخ داده است، لطفا با پشتیبانی در تماس باشید | 0 |
کلیدوب سرویس نامعتبر است شد | 10 |
کلید وب سرویس غیرفعال است | 11 |
کلیدوب سرویس محدود به IPهای تعریف شده میباشد | 12 |
حساب کاربری غیر فعال است | 13 |
حساب کاربری در حالت تعلیق قرار دارد | 14 |
تعداد درخواست بیشتر از حد مجاز است | 20 |
شماره خط نامعتبر میباشد | 101 |
اعتبار کافی نمیباشد | 102 |
درخواست شما دارای متن(های) خالی است | 103 |
درخواست شما دارای موبایل(های) نادرست است | 104 |
تعداد موبایل ها بیشتر از حد مجاز (100عدد)میباشد | 105 |
تعداد متن ها بیشتر ازحد مجاز (100عدد) میباشد | 106 |
لیست موبایل ها خالی میباشد | 107 |
لیست متن ها خالی میباشد | 108 |
زمان ارسال نامعتبر میباشد | 109 |
تعداد شماره موبایل ها و تعداد متن ها برابر نیستند | 110 |
با این شناسه ارسالی ثبت نشده است | 111 |
رکوردی برای حذف یافت نشد | 112 |
قالب یافت نشد | 113 |
طول رشته مقدار پارامتر، بیش از حد مجاز (25 کاراکتر) میباشد | 114 |
شماره موبایل(ها) در لیست سیاه سامانه میباشند | 115 |
نام پارامتر نمیتواند خالی باشد | 116 |
متن ارسال شده مورد تایید نمیباشد | 117 |
تعداد پیام ها بیش از حد مجاز می باشد. | 118 |
توضیح | کد وضعیت |
---|---|
رسیده به گوشی | 1 |
نرسیده به گوشی | 2 |
پردازش در مخابرات | 3 |
نرسیده به مخابرات | 4 |
رسیده به مخابرات | 5 |
خطا | 6 |
لیست سیاه | 7 |
بعد از انتخاب پنل پیامک خود در SMS.ir یک خط پیامکی اختصاصی بهصورت هدیه دریافت خواهید کرد!
بدون هیچ هزینه اولیهای ثبتنام کنید، یک خط پیامکی رایگان دریافت کنید و اولین پیامک خود را ارسال کنید...