پرش به مطلب اصلی

لغو پیام زمان‌بندی شده

از این API برای لغو پیام زمان‌بندی شده برای تحویل آینده استفاده کنید.

توجه: تنها تا 5 دقیقه قبل از زمان ارسال میتوانید ارسال را لغو نمایید و بعد از آن امکان لغو ارسال وجود نداشته و ارسال انجام خواهد شد.

📍 لینک دسترسی​

POST {base_url}/api/send/cancel

🧾 هدرها​

کلیدمقدار
Authorizationتوکن یا کلید دسترسی
Content-Typeapplication/json

📤 بدنه درخواست​

{
  "message_outbox_id": 1148303263
}

📝 پارامترها​

پارامترنوعضروریتوضیحات
message_outbox_idintegerبلهشناسه پیامی که می‌خواهید لغو کنید. این شناسه هنگام ارسال پیام بازگردانده می‌شود.

📝 نکات​

  • فقط می‌توانید پیام‌هایی را لغو کنید که برای ارسال در آینده زمان‌بندی شده‌اند.
  • باید حداقل 5 دقیقه قبل از زمان ارسال زمان‌بندی شده، درخواست لغو را ارسال کنید.
  • پس از لغو موفق، پیام ارسال نخواهد شد.

✅ پاسخ موفق​

{
  "data": null,
  "meta": {
    "status": true,
    "message": "انجام شد",
    "message_parameters": [],
    "message_code": "200-1"
  }
}

❌ پاسخ خطا — توکن نامعتبر یا منقضی شده (401)​

{
  "data": null,
  "meta": {
    "status": false,
    "message": "اطلاعات وارد شده صحیح نمی باشد",
    "message_parameters": [],
    "message_code": "400-1",
    "errors": {}
  }
}

❌ پاسخ خطا — پیام یافت نشد یا قابل لغو نیست (404)​

{
  "data": null,
  "meta": {
    "status": false,
    "message": "پیام یافت نشد یا قابل لغو نیست",
    "message_parameters": [],
    "message_code": "404-1",
    "errors": {}
  }
}

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

curl --location '{base_url}/api/send/cancel' \
--header 'Content-Type: application/json' \
--header 'Authorization: API TOKEN' \
--data '{
    "message_outbox_id": 1148303263
}'