ข้ามไปยังเนื้อหา

เปลี่ยนชื่อ

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

กำหนดหรือล้าง ชื่อแคมเปญ ของข้อความที่สร้างไว้ก่อนหน้านี้ ซึ่งระบุโดย message_code ไม่มีสิ่งอื่นใดในข้อความเปลี่ยนแปลง เนื้อหา กลุ่มเป้าหมาย และกำหนดการยังคงเหมือนเดิมทุกประการ

การเปลี่ยนชื่อทำได้ก็ต่อเมื่อข้อความยังคง รอดำเนินการ — สร้างแล้วแต่ยังไม่ถูกนำไปส่ง ข้อความที่เปลี่ยนไปอยู่ในสถานะ waiting, processing หรือสถานะถัดไปใดๆ จะไม่สามารถเปลี่ยนชื่อได้อีกต่อไป ใน Control Panel สถานะนี้จะแสดงเป็น Scheduled ในคอลัมน์ สถานะ ไม่ใช่ “Pending” ตามตัวอักษร ดู สถานะของข้อความ

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

คำขอ

Anchor link to

รับรองความถูกต้องด้วย Server API token ของคุณในส่วนหัว Authorization: Token <API_TOKEN>

ฟิลด์ประเภทจำเป็นคำอธิบาย
message_codestringใช่Message code ของข้อความที่จะเปลี่ยนชื่อ ซึ่งส่งคืนโดย Notify ใน result.message_code
campaign_namestringใช่ชื่อแคมเปญใหม่ ถูกตัดช่องว่างและตัดให้เหลือไม่เกิน 255 ตัวอักษร สตริงว่างจะล้างชื่อ

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

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

การตอบกลับ

Anchor link to

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

{}

ข้อผิดพลาด

Anchor link to

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

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

ตัวอย่าง

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

{
"code": 9,
"message": "message status \"waiting\" is not renamable",
"details": []
}

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

Anchor link to

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

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

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

Anchor link to