لیست سیاه خط

فهرست شماره‌های مسدود

شماره‌هایی را که ارسال از یک خط به آن‌ها مسدود است، با دلیل مسدودی، صفحه به صفحه برمی‌گرداند.

GET
https://api.payamras.ir/v1/YOUR_API_KEY/line/blocked/list.json
  • هر صفحه حداکثر ۲۰۰ شماره.

پارامترها

نامنوعتوضیح
linenumber الزامی String شماره خط.
blockreason اختیاری Integer دلیل مسدودی: 0 وب‌سرویس، 1 پنل، 2 لغو ۱۱، 3 مدیر سیستم، 10 نامشخص.
startdate اختیاری UnixTime فقط مسدودی‌های بعد از این زمان.
pagenumber اختیاری Integer شماره صفحه؛ از ۱.

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

curl -G "https://api.payamras.ir/v1/YOUR_API_KEY/line/blocked/list.json" \
  --data-urlencode "linenumber=10004346" \
  --data-urlencode "pagenumber=1"

پاسخ

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

فیلدنوعتوضیح
number String شماره مسدود.
blockreason Integer دلیل مسدودی.
date UnixTime زمان مسدودی.
response.json
{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": [
        {
            "number": "09121234567",
            "blockreason": 2,
            "date": 1760337500
        }
    ],
    "metadata": {
        "totalcount": 1,
        "currentpage": 1,
        "totalpages": 1,
        "pagesize": 200
    }
}

خطاهای رایج

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

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