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

جزئیات پیام

اطلاعات کامل پیام‌ها (متن، فرستنده، گیرنده، هزینه و وضعیت) را با messageid برمی‌گرداند.

GET POST
https://api.payamras.ir/v1/YOUR_API_KEY/sms/select.json
  • به دسترسی IP نیاز دارد؛ بدون آن خطای 407 برمی‌گردد (صفحه محدودیت‌ها و دسترسی).
  • کندتر از sms/status است. اگر فقط وضعیت تحویل لازم دارید، از sms/status استفاده کنید.
  • حداکثر ۵۰۰ شناسه در هر درخواست.

پارامترها

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

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

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

پاسخ

فیلدهای هر ردیف 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 برگرداند:

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