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

ภาพรวม Messaging API v2

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

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

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

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

URL พื้นฐาน

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

หากคุณใช้ภูมิภาคเฉพาะหรือการปรับใช้ส่วนตัว โปรดยืนยัน 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
ส่งพุชไปยัง 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": "สวัสดีจาก v2!" },
              "android": { "body": "สวัสดีจาก v2!" }
            }
          }
        }
      },
      "schedule": { "at": "2026-05-01T12:00:00Z" },
      "message_type": "MESSAGE_TYPE_MARKETING"
    }
  }'

การส่งอีเมลผ่าน SMTP

Anchor link to

หากบริการรองรับ SMTP อยู่แล้ว คุณสามารถส่งอีเมลธุรกรรมผ่าน SMTP gateway แทนการเรียก Notify โดยตรง เกตเวย์จะส่งต่อแต่ละข้อความไปยัง API นี้ในรูปแบบ Notify แบบธุรกรรม ดังนั้นกฎการยืนยันตัวตนและ payload ของอีเมลจึงเหมือนกัน

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

Anchor link to
Notify
การอ้างอิง Payload
การอ้างอิง Payload ของอีเมล
SMTP gateway
การย้ายจาก v1