صندوق دریافت

صندوق دریافت صفحه‌بندی‌شده

پیام‌های دریافتی یک بازه را صفحه به صفحه برمی‌گرداند، با اطلاعات صفحه‌بندی در metadata.

GET POST
https://api.payamras.ir/v1/YOUR_API_KEY/sms/inboxpaged.json
  • هر صفحه حداکثر ۲۰۰ پیام. بازه حداکثر دو روز و اگر خالی باشد، دو روز اخیر.

پارامترها

نامنوعتوضیح
linenumber الزامی String شماره خط دریافت‌کننده.
isread الزامی Integer 0 خوانده‌نشده، 1 خوانده‌شده.
startdate اختیاری UnixTime ابتدای بازه.
enddate اختیاری UnixTime انتهای بازه.
pagenumber اختیاری Integer شماره صفحه؛ از ۱.

نمونه درخواست

curl -G "https://api.payamras.ir/v1/YOUR_API_KEY/sms/inboxpaged.json" \
  --data-urlencode "linenumber=10004346" \
  --data-urlencode "isread=0" \
  --data-urlencode "pagenumber=1"

پاسخ

فیلدهای هر ردیف entries:

فیلدنوعتوضیح
messageid Long شناسه پیام دریافتی.
message String متن پیام.
sender String شماره فرستنده پیام.
receptor String خط شما که پیام را دریافت کرده.
date UnixTime زمان دریافت.
response.json
{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": [
        {
            "messageid": 22045121,
            "message": "لغو11",
            "sender": "09121234567",
            "receptor": "10004346",
            "date": 1760337500
        }
    ],
    "metadata": {
        "totalcount": 1,
        "currentpage": 1,
        "totalpages": 1,
        "pagesize": 200
    }
}

خطاهای رایج

علاوه بر خطاهای عمومی مثل 403 و 418، این متد ممکن است این کدها را در return.status برگرداند:

  • 400 پارامترها ناقص هستند.
  • 417 تاریخ نامعتبر است یا فرمت آن اشتباه است.