Notify

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

สร้างและกำหนดเวลาส่งข้อความเดียว

โครงสร้างคำขอ

ส่วนเนื้อหาของคำขอคือ NotifyRequest ซึ่งมีหนึ่งในสองชนิดนี้เท่านั้น:

• segment: กำหนดเป้าหมายไปยังกลุ่มเป้าหมาย (audience segment) ด้วยรหัส segment, นิพจน์ seglang หรือนิพจน์ตัวกรองที่มีโครงสร้าง
• transactional: ส่งไปยังรายการที่ระบุอย่างชัดเจนของ hwids, user IDs, push tokens หรืออุปกรณ์ทดสอบ

รูปแบบ

{
  "segment": { ... }       // หรือ
  "transactional": { ... }
}

NotifySegment

กำหนดเป้าหมายผู้ใช้ที่ตรงกับกลุ่มเป้าหมาย (audience segment) หรือนิพจน์ตัวกรอง

ฟิลด์	ประเภท	คำอธิบาย
schedule	Schedule	เวลาและวิธีการส่ง จำเป็นต้องระบุ
application	string	รหัสแอปพลิเคชัน
platforms	array of Platform	แพลตฟอร์มที่ข้อความจะส่งไปถึง
code	string	รหัส Segment ไม่สามารถใช้ร่วมกับ expression และ filter_expression ได้
expression	string	นิพจน์ Seglang
filter_expression	FilterExpression	นิพจน์ตัวกรองที่มีโครงสร้าง (ขั้นสูง)
payload	Payload	เพย์โหลดของ Push / SMS / Telegram / Kakao ไม่สามารถใช้ร่วมกับ email_payload ได้
email_payload	EmailPayload	เพย์โหลดของอีเมล
campaign	string	รหัสแคมเปญ เพื่อระบุว่าข้อความนี้เป็นของแคมเปญใด
frequency_capping	FrequencyCapping	การจำกัดความถี่ต่อผู้ใช้
send_rate	SendRate	การควบคุมอัตราการส่ง
message_type	MessageType	MESSAGE_TYPE_MARKETING (ค่าเริ่มต้น) หรือ MESSAGE_TYPE_TRANSACTIONAL ใช้ควบคุมการกรองกลุ่มควบคุม (control-group)
dynamic_content_placeholders	map<string, string>	แทนที่ตัวยึดตำแหน่งในเนื้อหา
meta_data	object	ข้อมูลเมตาแบบอิสระที่ส่งต่อไปยังระบบวิเคราะห์ข้อมูลปลายทาง

ตัวอย่าง: ส่งไปยัง 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!" },
              "android": { "body": "Hello!" }
            }
          }
        }
      },
      "schedule": { "at": "2026-05-01T12:00:00Z" },
      "message_type": "MESSAGE_TYPE_MARKETING"
    }
  }'

NotifyTransactional

ส่งไปยังรายชื่อผู้รับที่ระบุอย่างชัดเจน

ฟิลด์	ประเภท	คำอธิบาย
schedule	Schedule	จำเป็นต้องระบุ
application	string	รหัสแอปพลิเคชัน
platforms	array of Platform	แพลตฟอร์มที่ข้อความจะส่งไปถึง
test_devices	bool	หากเป็น true จะส่งไปยังอุปกรณ์ทดสอบของแอปเท่านั้น
hwids	{ "list": [string, ...] }	ส่งไปยัง hwids เหล่านี้เท่านั้น
users	{ "list": [string, ...] }	ส่งไปยัง user IDs เหล่านี้เท่านั้น
push_tokens	{ "list": [string, ...] }	ส่งไปยัง push tokens เหล่านี้เท่านั้น
payload	Payload	เพย์โหลดของ Push / SMS / Telegram / Kakao
email_payload	EmailPayload	เพย์โหลดของอีเมล
return_unknown_identifiers	bool	เมื่อเป็น true การตอบกลับในส่วน unknown_identifiers จะแสดงรายการตัวระบุที่ไม่พบ
campaign, frequency_capping, send_rate, message_type, dynamic_content_placeholders, meta_data		ดู NotifySegment ด้านบน

test_devices, hwids, users และ push_tokens ไม่สามารถใช้ร่วมกันได้ ต้องตั้งค่าเพียงหนึ่งอย่างเท่านั้น

ตัวอย่าง: การส่งแบบ Transactional ตาม user IDs

curl -X POST https://api.pushwoosh.com/messaging/v2/notify \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "transactional": {
      "application": "XXXXX-XXXXX",
      "platforms": ["IOS", "ANDROID"],
      "users": { "list": ["user-123", "user-456"] },
      "payload": {
        "content": {
          "localized_content": {
            "en": { "ios": { "body": "Your order has shipped." } }
          }
        }
      },
      "schedule": { "at": "2026-05-01T12:00:00Z" },
      "message_type": "MESSAGE_TYPE_TRANSACTIONAL",
      "return_unknown_identifiers": true
    }
  }'

การตอบกลับ

{
  "result": {
    "message_code": "XXXXX-XXXXX-XXXXX",
    "unknown_identifiers": []
  }
}

ฟิลด์	ประเภท	คำอธิบาย
message_code	string	รหัสข้อความ ที่ไม่ซ้ำกัน ใช้กับ /getMessageDetails และ endpoint สถิติข้อความ
unknown_identifiers	array of string	ตัวระบุที่ไม่พบบนบัญชี จะมีข้อมูลก็ต่อเมื่อตั้งค่า return_unknown_identifiers: true ในชนิด transactional เท่านั้น

ประเภทที่ใช้ร่วมกัน

Schedule

{
  "at": "2026-05-01T12:00:00Z",
  "follow_user_timezone": true,
  "past_timezones_behaviour": "PAST_TIMEZONES_BEHAVIOUR_SEND_IMMEDIATELY"
}

ฟิลด์	ประเภท	คำอธิบาย
at	timestamp	เวลาส่งแบบสมบูรณ์ (RFC 3339) หากเป็นเวลาในอดีต ข้อความจะถูกส่งทันที สามารถตั้งล่วงหน้าได้สูงสุด 14 วัน
after	duration	ทางเลือกแทน at ส่งหลังจากเวลาที่กำหนดนับจาก “ตอนนี้” (เช่น "3600s")
follow_user_timezone	bool	เมื่อเป็น true อุปกรณ์แต่ละเครื่องจะได้รับข้อความ ณ เวลา at ตามเขตเวลาท้องถิ่นของอุปกรณ์นั้น
past_timezones_behaviour	enum	PAST_TIMEZONES_BEHAVIOUR_SEND_IMMEDIATELY (ค่าเริ่มต้น), PAST_TIMEZONES_BEHAVIOUR_DO_NOT_SEND หรือ PAST_TIMEZONES_BEHAVIOUR_NEXT_DAY จะมีความหมายก็ต่อเมื่อ follow_user_timezone เป็น true เท่านั้น

FrequencyCapping

การจำกัดความถี่ต่อผู้ใช้สำหรับการส่งเพื่อการตลาด

{ "days": 7, "count": 3, "exclude": false, "avoid": true }

• days (int, 1–30): กรอบเวลาย้อนหลัง
• count (int): จำนวนข้อความสูงสุดที่อนุญาตภายใน days
• exclude (bool): ไม่รวมผู้ใช้ที่ถึงขีดจำกัดแล้วอย่างเด็ดขาด
• avoid (bool): หลีกเลี่ยงผู้ใช้ที่ถึงขีดจำกัดแล้ว (แต่ยังคงนับรวมในสถิติ)

SendRate

{ "value": 500, "bucket": "1s", "avoid": false }

ควบคุมอัตราการส่ง value คือจำนวนข้อความต่อ bucket; bucket ทั่วไปคือ "1s"

Platform enum

IOS, ANDROID, OSX, WINDOWS, AMAZON, SAFARI, CHROME, FIREFOX, IE, EMAIL, BAIDU_ANDROID, HUAWEI_ANDROID, SMS, WEB, KAKAO, TELEGRAM, LINE, WHATS_APP

MessageType enum

• MESSAGE_TYPE_UNSPECIFIED: เทียบเท่ากับ MESSAGE_TYPE_MARKETING
• MESSAGE_TYPE_MARKETING: อยู่ภายใต้การกรองกลุ่มควบคุม (control-group) และการจำกัดความถี่
• MESSAGE_TYPE_TRANSACTIONAL: ข้ามการกรองกลุ่มควบคุม (control-group) และการจำกัดความถี่ ใช้สำหรับการยืนยันคำสั่งซื้อ, OTPs และขั้นตอนที่สำคัญอื่นๆ ที่คล้ายกัน

เกี่ยวข้อง

การอ้างอิง Payload

การอ้างอิง Email payload

การย้ายจาก v1