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

آخرین پیام‌های ارسالی

جدیدترین پیام‌های ارسال‌شده را، از جدید به قدیم، برمی‌گرداند.

GET POST
https://api.payamras.ir/v1/YOUR_API_KEY/sms/latestoutbox.json
  • به دسترسی IP نیاز دارد.
  • pagesize بزرگ‌تر از ۵۰۰ نامعتبر حساب می‌شود و خطای 400 می‌گیرد.

پارامترها

نامنوعتوضیح
pagesize اختیاری Long تعداد ردیف‌ها؛ حداکثر و پیش‌فرض ۵۰۰.
sender اختیاری String فقط پیام‌های این خط.

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

curl -G "https://api.payamras.ir/v1/YOUR_API_KEY/sms/latestoutbox.json" \
  --data-urlencode "pagesize=50"

پاسخ

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

فیلدنوعتوضیح
messageid Long شناسه یکتای پیام؛ برای پیگیری وضعیت ذخیره کنید.
message String متن پیام.
status Integer وضعیت پیام (صفحه وضعیت پیام‌ها).
statustext String شرح وضعیت.
sender String خط فرستنده.
receptor String شماره گیرنده.
date UnixTime زمان ثبت یا زمان‌بندی ارسال.
cost Integer هزینه پیام به ریال.
response.json
{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": [
        {
            "messageid": 8792344,
            "message": "سفارش شما ثبت شد. کد پیگیری: 48213",
            "status": 11,
            "statustext": "نرسیده به گیرنده",
            "sender": "10004346",
            "receptor": "09351234567",
            "date": 1760337000,
            "cost": 1200
        }
    ]
}

خطاهای رایج

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

  • 400 پارامترها ناقص هستند.
  • 407 دسترسی به این اطلاعات مجاز نیست.
  • 412 فرستنده نامعتبر است، یا تعداد آیتم‌ها از سقف مجاز بیشتر است.