صندوق دریافت

شمارش پیام‌های دریافتی

تعداد پیام‌های دریافتی یک بازه را برمی‌گرداند.

GET POST
https://api.payamras.ir/v1/YOUR_API_KEY/sms/countinbox.json
  • بازه حداکثر یک روز و startdate حداکثر ۶۰ روز قبل است.

پارامترها

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

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

curl -G "https://api.payamras.ir/v1/YOUR_API_KEY/sms/countinbox.json" \
  --data-urlencode "startdate=1760300000" \
  --data-urlencode "linenumber=10004346"

پاسخ

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

فیلدنوعتوضیح
startdate UnixTime ابتدای بازه.
enddate UnixTime انتهای بازه.
sumcount Long تعداد پیام‌های دریافتی.
response.json
{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": [
        {
            "startdate": 1760300000,
            "enddate": 1760386400,
            "sumcount": 37
        }
    ]
}

خطاهای رایج

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

  • 417 تاریخ نامعتبر است یا فرمت آن اشتباه است.