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

وضعیت پیام

وضعیت تحویل پیام‌ها را با messageid برمی‌گرداند. سریع‌ترین راه برای پیگیری تحویل است.

GET POST
https://api.payamras.ir/v1/YOUR_API_KEY/sms/status.json
  • فقط پیام‌های ۴۸ ساعت اخیر را پوشش می‌دهد.
  • حداکثر ۵۰۰ شناسه در هر درخواست.
  • شناسه نامعتبر، بایگانی‌شده یا متعلق به حساب دیگر وضعیت 100 می‌گیرد.

پارامترها

نامنوعتوضیح
messageid الزامی Long شناسه پیام. چند شناسه را با ویرگول جدا کنید.

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

curl -G "https://api.payamras.ir/v1/YOUR_API_KEY/sms/status.json" \
  --data-urlencode "messageid=8792343,8792344"

پاسخ

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

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

خطاهای رایج

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

  • 400 پارامترها ناقص هستند.
  • 414 تعداد رکوردها از سقف مجاز یک درخواست بیشتر است.