เปลี่ยนชื่อ
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_code | string | ใช่ | Message code ของข้อความที่จะเปลี่ยนชื่อ ซึ่งส่งคืนโดย Notify ใน result.message_code |
campaign_name | string | ใช่ | ชื่อแคมเปญใหม่ ถูกตัดช่องว่างและตัดให้เหลือไม่เกิน 255 ตัวอักษร สตริงว่างจะล้างชื่อ |
ตัวอย่างคำขอ
Anchor link tocurl -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 | เงื่อนไข |
|---|---|
400 | message_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[]