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

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

وضعیت تحویل یک یا چند پیامک را بر اساس شناسه‌ی پیامک (messageid) که هنگام ارسال دریافت کرده‌اید برمی‌گرداند. شناسه‌ها به‌صورت رشته‌ای از اعداد صحیح جداشده با کاما ارسال می‌شوند؛ شناسه‌های تکراری حذف می‌شوند و در هر فراخوانی حداکثر ۵۰۰ شناسه‌ی یکتا پذیرفته می‌شود. پارامترها همیشه از query string خوانده می‌شوند (ctx.Query)، بنابراین در روش POST هم باید در انتهای URL قرار بگیرند و بدنه‌ی فرم خوانده نمی‌شود. برای هر شناسه دقیقاً یک رکورد و به همان ترتیب درخواست بازگردانده می‌شود؛ اگر شناسه‌ای وجود نداشته باشد یا متعلق به حساب شما نباشد، وضعیت 100 با متن «شناسه پیامک نامعتبر است» برمی‌گردد و اگر پیامک ثبت شده ولی هنوز رویدادی برای آن ثبت نشده باشد، وضعیت 1 («در صف ارسال») گزارش می‌شود.

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

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

{
  "return": {
    "status": 200,
    "message": "درخواست تایید شد."
  },
  "entries": [
    {
      "messageid": 8792343,
      "status": 10,
      "statustext": "رسیده به گیرنده"
    },
    {
      "messageid": 8792344,
      "status": 1,
      "statustext": "در صف ارسال"
    },
    {
      "messageid": 8792345,
      "status": 100,
      "statustext": "شناسه پیامک نامعتبر است"
    }
  ]
}