ข้ามไปยังเนื้อหา
คู่มือผู้ใช้การสนับสนุน ขอสาธิต เข้าสู่ระบบ
Pushwoosh.com

ยกเลิก

POST https://api.pushwoosh.com/messaging/v2/cancel

ยกเลิกข้อความที่สร้างไว้ก่อนหน้านี้ โดยระบุด้วย message_code ของข้อความนั้น การยกเลิกจะทำได้ก็ต่อเมื่อข้อความอยู่ในสถานะใดสถานะหนึ่งต่อไปนี้:

  • pending: สร้างแล้ว แต่ยังไม่ถูกนำไปส่ง
  • waiting: กำหนดเวลาส่งในอนาคต
  • processing: กำลังเตรียมการจัดส่ง

หากต้องการตรวจสอบว่าข้อความยังอยู่ในสถานะที่สามารถยกเลิกได้หรือไม่ โปรดดูที่ การตรวจสอบสถานะข้อความ

คำขอ (Request)

Anchor link to

ยืนยันตัวตนด้วย Server API token ของคุณในส่วนหัว Authorization: Token <API_TOKEN>

ฟิลด์ประเภทจำเป็นคำอธิบาย
message_codestringใช่Message code ของข้อความที่ต้องการยกเลิก ซึ่งได้มาจาก Notify ใน result.message_code

ตัวอย่างคำขอ

Anchor link to
Terminal window
curl -X POST https://api.pushwoosh.com/messaging/v2/cancel \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "message_code": "XXXX-XXXXXXXX-XXXXXXXX"
  }'

การตอบกลับ (Response)

Anchor link to

เมื่อสำเร็จ จะส่งคืน HTTP 200 พร้อมกับเนื้อหา JSON ที่ว่างเปล่า

{}

ข้อผิดพลาด (Errors)

Anchor link to

ข้อผิดพลาดใช้รูปแบบข้อผิดพลาดมาตรฐานของ gRPC-Gateway: { "code": ..., "message": ..., "details": [...] }

สถานะ HTTPเงื่อนไข
400message_code หายไป
400ข้อความไม่อยู่ในสถานะที่สามารถยกเลิกได้ (ไม่อยู่ในสถานะ pending, waiting หรือ processing อีกต่อไป)
403ข้อความนี้เป็นของบัญชีอื่น
404ไม่มีข้อความสำหรับ message_code ที่ให้มา
500เกิดข้อผิดพลาดภายในขณะโหลดข้อความหรือเผยแพร่การยกเลิก โปรดลองส่งคำขออีกครั้ง

ตัวอย่าง

การยกเลิกข้อความที่ไม่มีอยู่อีกต่อไปจะส่งคืน HTTP 404:

{
  "code": 5,
  "message": "message not found",
  "details": []
}

การตรวจสอบสถานะข้อความ

Anchor link to

ก่อนทำการยกเลิก คุณสามารถตรวจสอบได้ว่าข้อความยังอยู่ในสถานะที่สามารถยกเลิกได้หรือไม่ นอกจากการอ่านคอลัมน์ สถานะ (Status) ในตารางข้อความใน Control Panel (Campaigns → One-time messages) แล้ว คุณยังสามารถสอบถามสถานะผ่านโปรแกรมได้ด้วย messages:list:

  • ส่ง message_code ในอาร์เรย์ filters.messages_codes (พร้อมกับ filters.application ที่จำเป็น)
  • อ่านฟิลด์ status ของรายการที่ตรงกันใน items[]

หัวข้อที่เกี่ยวข้อง

Anchor link to
Notify
Update
สถิติข้อความ
ภาพรวม Messaging API v2
การย้ายจาก v1