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

صندوق ارسال در یک بازه

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

GET POST
https://api.payamras.ir/v1/YOUR_API_KEY/sms/selectoutbox.json
  • به دسترسی IP نیاز دارد.
  • بازه حداکثر یک روز و startdate حداکثر ۳ روز قبل است.
  • حداکثر ۵۰۰ ردیف برمی‌گردد و صفحه‌بندی ندارد؛ اگر ۵۰۰ ردیف گرفتید، بازه را کوچک‌تر کنید.

پارامترها

نامنوعتوضیح
startdate الزامی UnixTime ابتدای بازه.
enddate اختیاری UnixTime انتهای بازه. خالی یعنی همین لحظه.
sender اختیاری String فقط پیام‌های این خط.

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

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

پاسخ

فیلدهای هر ردیف 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": 8792343,
            "message": "سفارش شما ثبت شد. کد پیگیری: 48213",
            "status": 10,
            "statustext": "رسیده به گیرنده",
            "sender": "10004346",
            "receptor": "09121234567",
            "date": 1760337000,
            "cost": 1200
        }
    ]
}

خطاهای رایج

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

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