Push Plan API

อัพเดทล่าสุด ：2025-07-22

API ในโมดูลนี้มุ่งเน้นไปที่การสร้าง แก้ไข และดำเนินการสอบถาม ID แผนการ Push เอง

การตรวจสอบการเรียกใช้งาน

สำหรับรายละเอียด โปรดดูคำอธิบายของ [Authentication Method](/en/docs/app-push/rest-api/rest-api-overview#Authentication Method) ในภาพรวม REST API

สร้างและอัปเดต Push Plan

อินเทอร์เฟซนี้ใช้สำหรับ สร้างหรืออัปเดตแผนการ Push โดยการส่ง plan_id และ plan_description ระบบจะดำเนินการสร้างหรืออัปเดตตามว่ามี plan_id อยู่หรือไม่

ที่อยู่การเรียกใช้งาน

POST v4/push_plan

              
              POST v4/push_plan

โค้ดนี้โชว์เป็นหน้าต่างลอย

พารามิเตอร์การร้องขอ

ชื่อพารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
plan_id	string	ใช่	ตัวระบุเฉพาะของแผนการ Push กฎรูปแบบ: การรวมกันของตัวอักษร (ตัวพิมพ์เล็ก-ใหญ่มีความแตกต่าง), ตัวเลข และขีดล่าง ห้ามเริ่มต้นด้วยขีดล่าง ข้อจำกัดความยาว: สูงสุด 50 ตัวอักษร ข้อจำกัดความเป็นเอกลักษณ์: ไม่สามารถแก้ไขได้หลังจากตั้งค่าแล้ว กลยุทธ์การอัปเดต: เมื่อ plan_id มีอยู่แล้ว ให้ปรับปรุง plan_description เมื่อไม่มีอยู่ ให้สร้างแผนใหม่
plan_description	string	ใช่	ข้อมูลคำอธิบายของแผนการ Push ข้อกำหนดเนื้อหา: จำเป็นต้องรวมข้อมูลธุรกิจสำคัญ เช่น สถานการณ์การ Push, ผู้ใช้เป้าหมาย และเนื้อหาการ Push ข้อกำหนดรูปแบบ: รองรับภาษาจีน, อังกฤษ, ตัวเลข และเครื่องหมายวรรคตอนทั่วไป คำแนะนำความยาว: ไม่เกิน 200 ตัวอักษร (ระบบไม่มีการกำหนดข้อจำกัดบังคับ)

ตัวอย่างการร้องขอ

{ "plan_id": "push_20231001_001", "plan_description": "แผนการ Push สำหรับกิจกรรมโปรโมชัน Double 11 ครอบคลุมผู้ใช้ทั้งหมด" }

              
              {
  "plan_id": "push_20231001_001",
  "plan_description": "แผนการ Push สำหรับกิจกรรมโปรโมชัน Double 11 ครอบคลุมผู้ใช้ทั้งหมด"
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายพารามิเตอร์การตอบกลับ

การตอบกลับสำเร็จ

{ "plan_id": "push_20231001_001" }

              
              {
  "plan_id": "push_20231001_001"
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

การตอบกลับล้มเหลว

{ "error": { "code": 27303, "message": "Empty plan id" } }

              
              {
  "error": {
    "code": 27303,
    "message": "Empty plan id"
  }
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

สอบถาม Push Plan

อินเทอร์เฟซนี้ใช้สำหรับ สอบถามรายการแผนการ Push แบบแบ่งหน้า และรองรับการกรองตามแหล่งที่มาของการส่งและการค้นหาแบบคลุมเครือสำหรับคำอธิบายแผน/ID แผน

ที่อยู่การเรียกใช้งาน

GET v4/push_plan/list?page_index=x&page_size=xx&send_source=x&search_description=xxx

              
              GET v4/push_plan/list?page_index=x&page_size=xx&send_source=x&search_description=xxx

โค้ดนี้โชว์เป็นหน้าต่างลอย

พารามิเตอร์การร้องขอ

ชื่อพารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
page_index	int	ใช่	หมายเลขหน้าสำหรับการแบ่งหน้า (เริ่มนับจาก `1`)
page_size	int	ใช่	จำนวนรายการข้อมูลต่อหน้า โดยรองรับสูงสุด `100` รายการ
send_source	int	ไม่	ตัวระบุแหล่งที่มาของการส่ง: `0`-API, `1`-Web Console
search_description	string	ไม่	การจับคู่แบบคลุมเครือของคำอธิบายแผน หรือ ID แผน (รองรับภาษาจีน, อังกฤษ, ตัวเลข และขีดล่าง)

ตัวอย่างการร้องขอ

GET /v4/push_plan/list?page_index=1&page_size=20&send_source=1&search_description=Double 11

              
              GET /v4/push_plan/list?page_index=1&page_size=20&send_source=1&search_description=Double 11

โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายพารามิเตอร์การตอบกลับ

การตอบกลับสำเร็จ

{ "push_plan_info": [ { "push_id": "push_20231111", "plan_description": "แผนการ Push ทั่วทั้งไซต์สำหรับ Double 11", "count": 15, "create_time": "2023-11-01T10:00:00Z", "last_used_time": "2023-11-11T20:30:00Z" } ], "total": 1 }

              
              {
  "push_plan_info": [
    {
      "push_id": "push_20231111",
      "plan_description": "แผนการ Push ทั่วทั้งไซต์สำหรับ Double 11",
      "count": 15,
      "create_time": "2023-11-01T10:00:00Z",
      "last_used_time": "2023-11-11T20:30:00Z"
    }
  ],
  "total": 1
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

การตอบกลับล้มเหลว

{ "error": { "code": 1003, "message": "Parameter value is invalid" } }

              
              {
    "error": {
        "code": 1003,
        "message": "Parameter value is invalid"
    }
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

สอบถาม Msgid ตาม Push Plan

อินเทอร์เฟซนี้ใช้สำหรับ รับ ID ข้อความที่เกี่ยวข้องกับแผนการ Push ที่ระบุภายในเดือนที่ผ่านมา และรองรับการสอบถามข้อมูลข้อความที่เกี่ยวข้องของหลายแผนแบบเป็นชุด

ที่อยู่การเรียกใช้งาน

GET /v4/status/plan/msg/?plan_ids=xxxxxx,xxxxxx&start_date=yyyy-MM-dd&end_date=yyyy-MM-dd

              
              GET /v4/status/plan/msg/?plan_ids=xxxxxx,xxxxxx&start_date=yyyy-MM-dd&end_date=yyyy-MM-dd

โค้ดนี้โชว์เป็นหน้าต่างลอย

พารามิเตอร์การร้องขอ

ชื่อพารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
plan_ids	string	ใช่	รายการ ID แผนการ Push แยกด้วยเครื่องหมายจุลภาคภาษาอังกฤษสำหรับหลาย ID รองรับสูงสุด 100 ID
start_date	string	ใช่	วันที่เริ่มต้น (รูปแบบ: `yyyy-MM-dd`) ซึ่งต้องเป็นไปตาม: 1. ภายใน 30 วันก่อนวันที่ปัจจุบัน 2. วันที่สิ้นสุด >= วันที่เริ่มต้น
end_date	string	ใช่	วันที่สิ้นสุด (รูปแบบ: `yyyy-MM-dd`) ซึ่งต้องเป็นไปตาม: 1. ช่วงระหว่างวันที่เริ่มต้นและวันที่สิ้นสุด ≤ 31 วัน 2. ไม่ก่อนวันที่เริ่มต้น

ตัวอย่างการร้องขอ

GET /v4/status/plan/msg/?plan_ids=push_20231101,push_20231102&start_date=2023-11-01&end_date=2023-11-15

              
              GET /v4/status/plan/msg/?plan_ids=push_20231101,push_20231102&start_date=2023-11-01&end_date=2023-11-15

โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายพารามิเตอร์การตอบกลับ

การตอบกลับสำเร็จ

{ "push_20231101": { "msg_ids": ["msg_001", "msg_002"] }, "push_20231102": { "msg_ids": ["msg_003"] } }

              
              {
  "push_20231101": {
    "msg_ids": ["msg_001", "msg_002"]
  },
  "push_20231102": {
    "msg_ids": ["msg_003"]
  }
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

การตอบกลับล้มเหลว

{ "error": { "code": 21044, "message": "The time interval exceeds one month." } }

              
              {
    "error": {
        "code": 21044,
        "message": "The time interval exceeds one month."
    }
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

ลบแผนการ Push

API นี้ใช้สำหรับ ลบแผนการ Push โดยการส่ง plan_id ระบบจะดำเนินการลบตามการมีอยู่ของ plan_id

Endpoint

POST v4/push_plan/{plan_id}

              
              POST v4/push_plan/{plan_id}

โค้ดนี้โชว์เป็นหน้าต่างลอย

พารามิเตอร์คำขอ

ชื่อพารามิเตอร์	ประเภท	จำเป็นต้องมี	คำอธิบาย
plan_id	string	ใช่	ตัวระบุเฉพาะของแผนการ Push

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

curl -X DELETE http://127.0.0.1/v4/push_plan/push_20231001_001 -u "appKey:appSecret"

              
              curl -X DELETE http://127.0.0.1/v4/push_plan/push_20231001_001 -u "appKey:appSecret"

โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายพารามิเตอร์การตอบกลับ

การตอบกลับเมื่อสำเร็จ

{ "plan_id": "push_20231001_001" }

              
              {
  "plan_id": "push_20231001_001"
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

การตอบกลับเมื่อเกิดข้อผิดพลาด

{ "error": { "code": 27305, "message": "Plan id does not exist" } }

              
              {
  "error": {
    "code": 27305,
    "message": "Plan id does not exist"
  }
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายรหัสข้อผิดพลาด

รหัสข้อผิดพลาด	คำอธิบาย	วิธีการจัดการที่แนะนำ
21015	พารามิเตอร์การร้องขอสำหรับการสร้างแผนการ Push ไม่ถูกต้อง	ตรวจสอบว่าประเภทของ `plan_id` หรือ `plan_description` ถูกต้องหรือไม่
27300	ตัวระบุแผนการ Push ไม่ถูกต้อง	ตรวจสอบ `plan_id` ให้สอดคล้องกับกฎการตั้งชื่อ
27301	คำอธิบายแผนการ Push ไม่ถูกต้อง	ตรวจสอบ `plan_description` ให้สอดคล้องกับกฎ
27303	ตัวระบุแผนการ Push ว่างเปล่า	ระบุตัวระบุแผนการ Push ที่ถูกต้องเมื่อสร้างแผนการ Push
27304	ความยาวของตัวระบุแผนการ Push เกินขีดจำกัด	ทำให้ความยาวของตัวระบุแผนการ Push น้อยกว่า 50
21004	การตรวจสอบสิทธิ์สำหรับการสร้างแผนการ Push ล้มเหลว	ยืนยันว่าผู้เรียกมีสิทธิ์เข้าถึงอินเทอร์เฟซหรือไม่
27000	ข้อผิดพลาดของเซิร์ฟเวอร์ภายใน	ติดต่อฝ่ายสนับสนุนทางเทคนิคหรือเรียกใช้งานใหม่
1003	พารามิเตอร์สำหรับการสอบถามแผนการ Push ไม่ถูกต้อง	ตรวจสอบว่า `page_index/page_size` มากกว่า 0 หรือไม่
21004	การตรวจสอบสิทธิ์สำหรับการสอบถามแผนการ Push ล้มเหลว	ยืนยันว่าผู้เรียกมีสิทธิ์เข้าถึงอินเทอร์เฟซหรือไม่
27302	เกินขีดจำกัดการใช้งานแผนการ Push	ติดต่อฝ่ายสนับสนุนทางเทคนิคเพื่อเพิ่มขีดจำกัด
21009	ข้อผิดพลาดของระบบภายใน ไม่สามารถเรียกใช้งานใหม่ได้	ติดต่อฝ่ายสนับสนุนทางเทคนิค
23001	การตรวจสอบสิทธิ์สำหรับการสอบถาม Msgid ตามแผนการ Push ล้มเหลว	ยืนยันว่าผู้เรียกมีสิทธิ์เข้าถึงอินเทอร์เฟซหรือไม่
3010	ปริมาณการเรียกใช้งาน API ของอินเทอร์เฟซการสอบถามเกินขีดจำกัด	ติดต่อฝ่ายสนับสนุนทางเทคนิค
23002	พารามิเตอร์ pl ที่ถูกต้องที่ส่งมาในการสอบถาม Msgid ตามแผนการ Push ไม่ถูกต้อง	ตรวจสอบความถูกต้องของ plan_ids หรือว่าพารามิเตอร์วันที่ถูกส่งมาหรือไม่
21003	วันที่ที่ส่งมาไม่ถูกต้อง	ตรวจสอบความถูกต้องของวันที่
21044	ช่วงระหว่างวันที่เริ่มต้นและวันที่สิ้นสุดเกินหนึ่งเดือน	ทำให้ช่วงระหว่างวันที่เริ่มต้นและวันที่สิ้นสุดน้อยกว่าหนึ่งเดือน