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

ภาพรวม Messaging API v2

Messaging API v2 เป็น REST/JSON endpoint เดียวสำหรับสร้างข้อความขาออกในทุกช่องทางที่ Pushwoosh รองรับ:

  • Push: iOS, Android, Huawei, Baidu, macOS, Amazon, Windows, Safari, Chrome, Firefox, IE
  • อีเมล
  • SMS
  • Telegram, Kakao, LINE, WhatsApp

Channel จะถูกเลือกตามประเภทของ payload (payload สำหรับ push / SMS / messengers, email_payload สำหรับอีเมล)

Targeting จะถูกเลือกตามประเภทของคำขอ (segment สำหรับกลุ่มเป้าหมาย, transactional สำหรับรายการอุปกรณ์หรือผู้ใช้ที่ระบุอย่างชัดเจน)

URL พื้นฐาน

Anchor link to
https://api.pushwoosh.com

หากคุณใช้ region เฉพาะหรือการปรับใช้แบบส่วนตัว โปรดยืนยัน URL พื้นฐานที่ถูกต้องกับผู้จัดการความสำเร็จของลูกค้า Pushwoosh ของคุณ

การยืนยันตัวตน

Anchor link to

ทุกคำขอต้องมีเฮดเดอร์ Authorization พร้อมด้วย API access token ฝั่งเซิร์ฟเวอร์ของ Pushwoosh:

Authorization: Token YOUR_API_TOKEN

ใช้โทเค็นเดียวกับที่คุณออกให้สำหรับการเรียก API แบบ server-to-server อยู่แล้ว อย่าเปิดเผยโทเค็นนี้ในแอปพลิเคชันฝั่งไคลเอ็นต์

เมธอด

Anchor link to
  • Notify: POST /messaging/v2/notify สร้างและส่งข้อความเดียว (แบบ segment หรือ transactional)

รูปแบบคำขอและการตอบกลับ

Anchor link to
  • ประเภทเนื้อหา: application/json
  • ชื่อฟิลด์ใช้ snake_case กลุ่ม oneof จะปรากฏเป็นอ็อบเจกต์ที่ซ้อนกันโดยมีการตั้งค่าคีย์เพียงหนึ่งคีย์เท่านั้น
  • ค่า Enum จะถูกทำให้เป็นอนุกรมเป็นชื่อสตริง (ตัวอย่างเช่น "IOS", "MESSAGE_TYPE_MARKETING")
  • การตอบกลับที่สำเร็จจะคืนค่า HTTP 200 พร้อมกับเนื้อหา JSON; ข้อผิดพลาดจะใช้รูปแบบข้อผิดพลาดมาตรฐานของ gRPC-Gateway — { "code": ..., "message": ..., "details": [...] }

เริ่มต้นใช้งานฉบับย่อ

Anchor link to
ส่ง push ไปยัง segment
curl -X POST https://api.pushwoosh.com/messaging/v2/notify \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "segment": {
      "application": "XXXXX-XXXXX",
      "platforms": ["IOS", "ANDROID"],
      "code": "active_users",
      "payload": {
        "content": {
          "localized_content": {
            "en": {
              "ios":     { "body": "Hello from v2!" },
              "android": { "body": "Hello from v2!" }
            }
          }
        }
      },
      "schedule": { "at": "2026-05-01T12:00:00Z" },
      "message_type": "MESSAGE_TYPE_MARKETING"
    }
  }'

ขั้นตอนถัดไป

Anchor link to
Notify
การอ้างอิง Payload
การอ้างอิง Email payload
การย้ายจาก v1