استعلام وضعیت پیامک با شناسه محلی

احراز هویت: این سرویس کلید API را از مسیر URL می‌خواند (/v1/{apiKey}/...) و هدر احراز هویتی ندارد. درخواست فقط از آی‌پی‌های وایت‌لیست‌شده پذیرفته می‌شود. به احراز هویت و وایت‌لیست IP نگاه کنید.

وضعیت پیامک‌ها را بر اساس شناسه‌ی محلی (localid) استعلام می‌کند؛ یعنی همان شناسه‌ای که خودِ شما هنگام ارسال به سامانه داده‌اید. ورودی رشته‌ای از اعداد جداشده با کاما است، شناسه‌های تکراری حذف می‌شوند و سقف هر فراخوانی ۵۰۰ شناسه‌ی یکتا است. پارامترها در هر دو روش GET و POST از query string خوانده می‌شوند. خروجی علاوه بر وضعیت، شناسه‌ی پیامک سامانه (messageid) را هم برمی‌گرداند؛ اگر شناسه‌ی محلی پیدا نشود، messageid برابر 0 و وضعیت 100 («شناسه پیامک نامعتبر است») خواهد بود.

نکتهٔ مهم: تمام پارامترها از query string خوانده می‌شوند. این مسیر برای POST هم ثبت شده، ولی حتی در POST هم باید پارامترها در انتهای نشانی بیایند؛ بدنهٔ form-urlencoded یا JSON خوانده نمی‌شود.

این مسیر با متد GET هم ثبت شده و رفتار یکسانی دارد؛ در مستندات فقط شکل POST نشان داده شده است.

{
  "return": {
    "status": 200,
    "message": "درخواست تایید شد."
  },
  "entries": [
    {
      "messageid": 8792343,
      "status": 4,
      "statustext": "ارسال شده به مخابرات",
      "localid": 1001
    },
    {
      "messageid": 0,
      "status": 100,
      "statustext": "شناسه پیامک نامعتبر است",
      "localid": 1002
    }
  ]
}