لیست سیاه خط

بررسی مسدود بودن

مشخص می‌کند هر شماره روی یک خط مسدود است یا نه؛ پیش از ارسال گروهی تا هزینه پیام‌های برگشتی را ندهید.

GET
https://api.payamras.ir/v1/YOUR_API_KEY/line/blocked/exists.json
  • حداکثر ۲۰۰ شماره در هر درخواست.

پارامترها

نامنوعتوضیح
linenumber الزامی String شماره خط.
receptor الزامی String شماره‌ها، جداشده با ویرگول.

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

curl -G "https://api.payamras.ir/v1/YOUR_API_KEY/line/blocked/exists.json" \
  --data-urlencode "linenumber=10004346" \
  --data-urlencode "receptor=09121234567,09351234567"

پاسخ

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

فیلدنوعتوضیح
linenumber String شماره خط.
receptor String شماره.
status String Active یعنی مسدود است؛ NotExists یعنی مسدود نیست.
response.json
{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": [
        {
            "linenumber": "10004346",
            "receptor": "09121234567",
            "status": "Active"
        },
        {
            "linenumber": "10004346",
            "receptor": "09351234567",
            "status": "NotExists"
        }
    ]
}

خطاهای رایج

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

  • 412 فرستنده نامعتبر است، یا تعداد آیتم‌ها از سقف مجاز بیشتر است.
  • 604 تعداد شماره‌ها در درخواست لیست سیاه بیش از ۲۰۰ است.