لیست پیام ها در بازه ی زمانی
در این سرویس لیست پیامهای شما در بازه ی زمانی درخواستی شما برمیگردد
آدرس سرویس :
https://api.sabapayamak.com/api/v1/messages?StartDate=1398/01/01&EndDate=1399/01/01
خروجی این سرویس لیست پیامهای شما در بازه ی زمانی مشخص شده میباشد که در قسمت data به صورت لیستی از مدل زیر خواهد آمد
{
"MessageID" : 1,
"UserID" : 1,
"Body" : "Message Text",
"Sender" : "3000...",
"MessagePage" : 2,
"Credit" : 6,
"InsertDate" : "2020\02\02 14:14:14",
"IsUnicode" : true,
"MessageCount" : 3,
"Status" : 1,
"StatusDesc" : "ارسال شده",
"Deliveries" : [
{
"RecordID" : 123456789 ,
"MessageID" : 1 ,
"SendDate" : "2020\02\02 14:14:15" ,
"Number" : "912..." ,
"DeliveryFlag" : 0 ,
"DeliveryDesc" : "ارسال شده"
}
],
...
}
| پارامتر | توضیحات |
| MessageID | شناسه پیام |
| UserID | شناسه کاربر |
| Body | متن پیام |
| Sender | شماره ارسال |
| MessagePage | تعداد صفحات پیام |
| Credit | شارژ مورد استفاده |
| InsertDate | تاریخ درج |
| IsUnicode | فارسی بودن / نبودن |
| MessageCount | تعداد پیام |
| Status | وضعیت ارسال |
| StatusDesc | توضیح وضعیت ارسال |
| Deliveries | لیست جزییات پیام(توضیحات در جدول پایین) |
| پارامتر | توضیحات |
| RecordID | شناسه جزییات پیام |
| MessageID | شناسه پیام |
| SendDate | تاریخ ارسال |
| Number | شماره |
| DeliveryFlag | وضعیت دریافت |
| DeliveryDesc | توضیحات وضعیت دریافت |
لیست پیام ها در بازه ی زمانی
در این سرویس لیست پیامهای شما در بازه ی زمانی درخواستی شما برمیگردد،در این سرویس میبایست ساعت مد نظر هم ارسال شود :
آدرس سرویس :
https://api.sabapayamak.com/api/v1/messages/time?StartDate=1398/01/01&StartTime=10:00&EndDate=1399/01/01&EndTime=15:00
خروجی این سرویس لیست پیامهای شما در بازه ی زمانی مشخص شده میباشد که در قسمت data به صورت لیستی از مدل زیر خواهد آمد
{
"MessageID" : 1,
"UserID" : 1,
"Body" : "Message Text",
"Sender" : "3000...",
"MessagePage" : 2,
"Credit" : 6,
"InsertDate" : "2020\02\02 14:14:14",
"IsUnicode" : true,
"MessageCount" : 3,
"Status" : 1,
"StatusDesc" : "ارسال شده",
"Deliveries" : [
{
"RecordID" : 123456789 ,
"MessageID" : 1 ,
"SendDate" : "2020\02\02 14:14:15" ,
"Number" : "912..." ,
"DeliveryFlag" : 0 ,
"DeliveryDesc" : "ارسال شده"
}
],
...
}
| پارامتر | توضیحات |
| MessageID | شناسه پیام |
| UserID | شناسه کاربر |
| Body | متن پیام |
| Sender | شماره ارسال |
| MessagePage | تعداد صفحات پیام |
| Credit | شارژ مورد استفاده |
| InsertDate | تاریخ درج |
| IsUnicode | فارسی بودن / نبودن |
| MessageCount | تعداد پیام |
| Status | وضعیت ارسال |
| StatusDesc | توضیح وضعیت ارسال |
| Deliveries | لیست جزییات پیام(توضیحات در جدول پایین) |
| پارامتر | توضیحات |
| RecordID | شناسه جزییات پیام |
| MessageID | شناسه پیام |
| SendDate | تاریخ ارسال |
| Number | شماره |
| DeliveryFlag | وضعیت دریافت |
| DeliveryDesc | توضیحات وضعیت دریافت |
دریافت پیام بر اساس شناسه
در این سرویس جزییات مربوط به یک پیام با استفاده از شناسه که در انتهای آدرس آن ارسال میکنید به شما داده میشود
آدرس سرویس :
https://api.sabapayamak.com/api/v1/messages/1234567
خروجی این سرویس لیست پیامهای شما در بازه ی زمانی مشخص شده میباشد که در قسمت data به صورت مدل زیر خواهد آمد
{
"MessageID" : 1,
"UserID" : 1,
"Body" : "Message Text",
"Sender" : "3000...",
"MessagePage" : 2,
"Credit" : 6,
"InsertDate" : "2020\02\02 14:14:14",
"IsUnicode" : true,
"MessageCount" : 3,
"Status" : 1,
"StatusDesc" : "ارسال شده",
"Deliveries" : [
{
"RecordID" : 123456789 ,
"MessageID" : 1 ,
"SendDate" : "2020\02\02 14:14:15" ,
"Number" : "912..." ,
"DeliveryFlag" : 0 ,
"DeliveryDesc" : "ارسال شده"
}
]
}
آخرین ارسال به یک شماره
با این سرویس میتوانید آخرین ارسالی که در 30 روز گذشته به یک شماره داشته اید چک کنید
آدرس سرویس :
https://api.sabapayamak.com/api/v1/messages/number/0912...
خروجی این سرویس در قسمت data به صورت لیست از مدل زیر است
{
"MessageID" : 1,
"UserID" : 1,
"Body" : "Message Text",
"Sender" : "3000...",
"MessagePage" : 2,
"Credit" : 6,
"InsertDate" : "2020\02\02 14:14:14",
"IsUnicode" : true,
"MessageCount" : 3,
"Status" : 1,
"StatusDesc" : "ارسال شده",
}
ارسال یک پیام
با استفاده از این سرویس میتوانید ارسال داشته باشید
آدرس سرویس :
https://api.sabapayamak.com/api/v1/message
برای ارسال شما میبایست مدلی به شکل زیر را به سرویس ارسال کنید
{
"Text" : "Text for Sending Message",
"Numbers" : ["0912....","0913...."]
}
پس از ارسال شما خروجی به شکل زیر برای شما برخواهد گشت که وضعیت آن را در جدول صفحه ی توضیحات اولیه میتوانید ببینید
{
"ID" : 1,
"MessageStatus" : 1,
"Message" : "Status Description",
"Credit" : 6
"Detail" : [
{
"Status" : 0,
"Message" : "با موفقیت ارسال شد",
"Number" : "0912...",
"RecID" : 123456789
},
{
"Status" : 27,
"Message" : "شماره در لیست سیاه قرار دارد",
"Number" : "0912...",
"RecID" : 123456789
}
]
}
| پارامتر | توضیحات |
| ID | شناسه پیام |
| MessageStatus | وضعیت پیام |
| Message | توضیح وضعیت پیام |
| Credit | شارژ پیام |
| Detail | لیست جزییات پیام(در جدول پایین توضیحات داده شده) |
| پارامتر | توضیحات |
| Status | وضعیت ارسال |
| Number | شماره |
| RecID | شناسه جزییات ارسال |
ارسال پیام
با استفاده از این سرویس میتوانید بدون دریافت توکن و در لحظه پیام خود را ارسال کنید
آدرس سرویس :
https://api.sabapayamak.com/api/v1/message?UserName=YOUR_USERNAME&Password=YOUR_PASSWROD&From=YOUR_SENDER_NUMBER&To=YOUR_RECIVER,YOUR_RECIVER_2&Text=YOUR_SMS_TEXT
در این روش شما نیاز نیست مدل خاصی به سرویس ارسال کنید و تمام دیتای خود را در ادامه آدرس سرویس پر کنید
پس از ارسال شما خروجی به شکل زیر برای شما برخواهد گشت که وضعیت آن را در جدول صفحه ی توضیحات اولیه میتوانید ببینید
{
"ID" : 1,
"MessageStatus" : 1,
"Message" : "Status Description",
"Credit" : 6
"Detail" : [
{
"Status" : 0,
"Message" : "با موفقیت ارسال شد",
"Number" : "0912...",
"RecID" : 123456789
},
{
"Status" : 27,
"Message" : "شماره در لیست سیاه قرار دارد",
"Number" : "0912...",
"RecID" : 123456789
}
]
}
| پارامتر | توضیحات |
| ID | شناسه پیام |
| MessageStatus | وضعیت پیام |
| Message | توضیح وضعیت پیام |
| Credit | شارژ پیام |
| Detail | لیست جزییات پیام(در جدول پایین توضیحات داده شده) |
| پارامتر | توضیحات |
| Status | وضعیت ارسال |
| Number | شماره |
| RecID | شناسه جزییات ارسال |