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

وضعیت با شماره گیرنده

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

GET POST
https://api.payamras.ir/v1/YOUR_API_KEY/sms/statusbyreceptor.json
  • بازه حداکثر یک روز است. اگر enddate خالی باشد، یک روز پس از startdate در نظر گرفته می‌شود.

پارامترها

نامنوعتوضیح
receptor الزامی String شماره گیرنده.
startdate الزامی UnixTime ابتدای بازه.
enddate اختیاری UnixTime انتهای بازه؛ نباید قبل از startdate باشد.

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

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

پاسخ

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

فیلدنوعتوضیح
receptor String شماره گیرنده.
messageid Long شناسه پیام.
status Integer وضعیت پیام.
statustext String شرح وضعیت.
response.json
{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": [
        {
            "receptor": "09121234567",
            "messageid": 8792343,
            "status": 10,
            "statustext": "رسیده به گیرنده"
        }
    ]
}

خطاهای رایج

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

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