لغو ارسال پیامک (پیاده‌سازی نشده)

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

هشدار: این مسیر در حال حاضر پیاده‌سازی نشده است. هندلری که در روتر به این مسیر متصل شده (Controller.Cancel) هیچ پارامتری را نمی‌خواند، هیچ عملیاتی روی پیام‌ها انجام نمی‌دهد و همیشه با کد ۲۰۰ و بدنهٔ null پاسخ می‌دهد — یعنی خروجی آن ساختار استاندارد return/entries را ندارد.

پیاده‌سازی کامل لغو ارسال به‌صورت sms.CancelSending در مخزن وجود دارد اما به هیچ مسیری متصل نیست و اجرا نمی‌شود. میان‌افزارهای احراز هویت و فهرست سفید IP همچنان روی این مسیر اعمال می‌شوند، بنابراین خطاهای ۴۰۳، ۴۰۱، ۴۱۶ و ۵۰۰ پیش از رسیدن به هندلر قابل بازگشت هستند.

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

پارامترهای مسیر

نام	نوع	الزامی	توضیح
`apiKey`*	string	الزامی	کلید API حساب کاربری که به‌صورت بخشی از مسیر URL ارسال می‌شود (نه به‌صورت هدر). نمونه`a1b2c3d4e5f60718293a4b5c6d7e8f90`

پاسخ‌ها

ساختار پاسخ

نام	نوع	الزامی	توضیح
`return`	ApiStatus	اختیاری	وضعیت پاسخ. مقدار `status` با کد وضعیت HTTP پاسخ یکسان است.
`status`*	integer	الزامی	کد وضعیت — همان کد وضعیت HTTP پاسخ. نمونه`200`
`message`*	string	الزامی	پیام فارسی قابل نمایش به کاربر. نمونه`درخواست تایید شد.`
`entries`	object	اختیاری	ساختار پاسخ در کد سرویس تعریف نشده است.

نمونهٔ پاسخ

{
  "return": {
    "status": 200,
    "message": "درخواست تایید شد."
  },
  "entries": {}
}