صندوق دریافت

دریافت پیام‌های ورودی

پیامک‌هایی را که به خط اختصاصی شما فرستاده شده برمی‌گرداند؛ برای پاسخ خودکار، نظرسنجی یا لغو عضویت.

GET POST
https://api.payamras.ir/v1/YOUR_API_KEY/sms/receive.json
  • هر بار حداکثر ۱۰۰ پیام برمی‌گردد و پیام‌های برگشتی خوانده‌شده علامت می‌خورند.
  • تا وقتی تعداد نتیجه‌ها ۱۰۰ است، درخواست را تکرار کنید.

پارامترها

نامنوعتوضیح
linenumber الزامی String شماره خط دریافت‌کننده.
isread الزامی Integer 0 برای پیام‌های خوانده‌نشده، 1 برای خوانده‌شده.

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

curl -G "https://api.payamras.ir/v1/YOUR_API_KEY/sms/receive.json" \
  --data-urlencode "linenumber=10004346" \
  --data-urlencode "isread=0"

پاسخ

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

فیلدنوعتوضیح
messageid Long شناسه پیام دریافتی.
message String متن پیام.
sender String شماره فرستنده پیام.
receptor String خط شما که پیام را دریافت کرده.
date UnixTime زمان دریافت.
response.json
{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": [
        {
            "messageid": 22045121,
            "message": "لغو11",
            "sender": "09121234567",
            "receptor": "10004346",
            "date": 1760337500
        }
    ]
}

خطاهای رایج

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

  • 400 پارامترها ناقص هستند.