وضعیت و گزارش ارسال

شمارش پیام‌های ارسالی

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

GET POST
https://api.payamras.ir/v1/YOUR_API_KEY/sms/countoutbox.json
  • بازه حداکثر یک روز و startdate حداکثر ۳ روز قبل است.
  • cost برابر است با sumpart ضرب در تعرفه هر بخش.

پارامترها

نامنوعتوضیح
startdate الزامی UnixTime ابتدای بازه.
enddate اختیاری UnixTime انتهای بازه. خالی یعنی همین لحظه.
status اختیاری Integer فقط پیام‌های این وضعیت، مثلا 10 برای تحویل‌شده‌ها.

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

curl -G "https://api.payamras.ir/v1/YOUR_API_KEY/sms/countoutbox.json" \
  --data-urlencode "startdate=1760300000" \
  --data-urlencode "enddate=1760380000"

پاسخ

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

فیلدنوعتوضیح
startdate UnixTime ابتدای بازه.
enddate UnixTime انتهای بازه.
sumpart Long مجموع بخش‌ها (هر پیام بلند چند بخش حساب می‌شود).
sumcount Long تعداد پیام‌ها.
cost Long هزینه کل به ریال.
response.json
{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": [
        {
            "startdate": 1760300000,
            "enddate": 1760380000,
            "sumpart": 1840,
            "sumcount": 1512,
            "cost": 2208000
        }
    ]
}

خطاهای رایج

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

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