Audience API

bulkSetTags

POST https://api.pushwoosh.com/api/v2/audience/bulkSetTags

ตั้งค่าแท็กสำหรับรายการอุปกรณ์

Request Body

ชื่อ	ประเภท	คำอธิบาย
application*	String	รหัสแอปพลิเคชัน Pushwoosh
auth*	String	โทเค็นการเข้าถึง API จาก Pushwoosh Control Panel
create_missing_tags	Boolean	หากเป็น true แท็กที่ไม่มีอยู่จะถูกสร้างขึ้นโดยอัตโนมัติ
devices*	Object	อาร์เรย์ของอุปกรณ์
devices.hwid	String	สามารถใช้เพื่อระบุอุปกรณ์แทน user_id หรือ push_token ได้ เรียนรู้เพิ่มเติม
devices.user_id	String	สามารถใช้เพื่อระบุผู้ใช้แทน hwid หรือ push_token ได้ เรียนรู้เพิ่มเติม
devices.push_token	String	สามารถใช้เพื่อระบุอุปกรณ์แทน hwid หรือ user_id ได้ เรียนรู้เพิ่มเติม
devices.list_operator	String	กำหนดวิธีการตั้งค่าสำหรับ tags ประเภทรายการ: set, append หรือ remove
devices.tags*	Object	ค่าที่จะตั้งสำหรับแท็กที่ระบุ

สำเร็จ
ข้อผิดพลาด

{
  "request_id": "request_id to use in GET method to obtain job status",
  "status": "Pending"
}

{
  "message": "invalid request"
}

{
  "application": "application code",   // จำเป็น รหัสแอป Pushwoosh
  "auth": "Pushwoosh auth token",      // จำเป็น โทเค็นการเข้าถึง API จาก Pushwoosh Control Panel
  "create_missing_tags": false,        // ไม่จำเป็น ควรสร้างแท็กที่ไม่มีอยู่โดยอัตโนมัติหรือไม่
  "devices": [{                        // จำเป็น อาร์เรย์ของอุปกรณ์
    "hwid": "device hwid",             // ไม่จำเป็น สามารถใช้เพื่อระบุอุปกรณ์แทน "user_id" หรือ "push_token" ได้
    "user_id": "user ID",              // ไม่จำเป็น สามารถใช้เพื่อระบุผู้ใช้แทน "hwid" หรือ "push_token" ได้
    "push_token": "device push token", // ไม่จำเป็น สามารถใช้เพื่อระบุอุปกรณ์แทน "hwid" หรือ "user_id" ได้
    "list_operator": "set",            // จำเป็น สำหรับแท็กรายการ กำหนดวิธีการตั้งค่าสำหรับแท็กประเภทรายการ: set, append หรือ remove
    "tags": {                          // จำเป็น ค่าที่จะตั้งสำหรับแท็กที่ระบุ
      "tag_name": "tagvalue",          //           ใช้ประเภทค่าที่ถูกต้อง
      "tag_name2": "tagvalue2"
    }
  }]
}

{
  "request_id": "request_id to use in GET method to obtain job status",
  "status": "Pending"
}

bulkSetTags status

GET https://api.pushwoosh.com/api/v2/audience/bulkSetTags/{request_id}?detailed=false

ส่งคืนสถานะของการดำเนินการ /bulkSetTags

Path Parameters

ชื่อ	ประเภท	คำอธิบาย
request_id	String	request id จากการเรียก `/bulkSetTags` ก่อนหน้า

Query Parameters

ชื่อ	ประเภท	คำอธิบาย
detailed	Boolean	(true/false) จะส่งคืนข้อมูลโดยละเอียดต่ออุปกรณ์หรือไม่

{
  "request_id": "id of the request",
  "status": "Completed",          // อาจเป็น "Pending", "Failed"
  "progress": 100,                // ความคืบหน้าของงาน 0-100
  "devices_success": 100,         // อุปกรณ์ที่สำเร็จ
  "devices_not_found": 0,         // ไม่พบอุปกรณ์ใน Pushwoosh
  "devices_failed": 0,            // เกิดข้อผิดพลาด
  "devices": [{                   // รายงานอุปกรณ์ (เฉพาะเมื่อ detailed = true)
    "hwid": "device hwid",
    "status": "done",             // อาจเป็น "failed", "not found"
    "tags": {
      "tagName": "ok",
      "tagName2": "tag not found",
      "tagName3": "wrong value. expect :string"
    }
  }]
}

bulkRegisterDevice

ลงทะเบียนอุปกรณ์หลายเครื่องใน Pushwoosh ในคำขอเดียว นอกจากนี้ยังอนุญาตให้ระบุแท็กต่างๆ สำหรับแต่ละอุปกรณ์ได้

POST https://api.pushwoosh.com/api/v2/audience/bulkRegisterDevice

พารามิเตอร์ของ Request body

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
application	string	ใช่	รหัสแอปพลิเคชัน Pushwoosh
auth	string	ใช่	โทเค็นการเข้าถึง API
devices	array	ใช่	อาร์เรย์ของอ็อบเจกต์อุปกรณ์ แต่ละอ็อบเจกต์แทนอุปกรณ์และข้อมูลที่เกี่ยวข้อง ดูรายละเอียดในตาราง พารามิเตอร์ของอ็อบเจกต์อุปกรณ์ ด้านล่าง

พารามิเตอร์ของอ็อบเจกต์อุปกรณ์

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
hwid	string	ใช่	The hardware ID หรือตัวระบุที่ไม่ซ้ำกันสำหรับอุปกรณ์
push_token	string	ใช่	Push token สำหรับอุปกรณ์
platform	integer	ใช่	ตัวระบุแพลตฟอร์ม เรียนรู้เพิ่มเติม
list_operator	string	ไม่	กำหนดการดำเนินการสำหรับแท็กประเภทรายการ: - “append”: เพิ่มค่าที่ระบุลงในรายการแท็ก - “remove”: ลบค่าที่ระบุออกจากรายการแท็ก หมายเหตุ: หากไม่ได้ระบุพารามิเตอร์ `list_operator` ค่าที่มีอยู่ทั้งหมดในรายการแท็กจะถูกแทนที่ด้วยค่าที่ให้มา
tags	object	ไม่	tags ที่กำหนดเองซึ่งกำหนดให้กับอุปกรณ์ แท็กคือคู่คีย์-ค่าที่ใช้สำหรับการแบ่งกลุ่ม

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

{
  "application": "application code",   // จำเป็น รหัสแอป Pushwoosh
  "auth": "Pushwoosh auth token",      // จำเป็น โทเค็นการเข้าถึง API จาก Pushwoosh Control Panel
  "devices": [{                        // จำเป็น อาร์เรย์ของอุปกรณ์
    "hwid": "device hwid",             // จำเป็น ตัวระบุที่ไม่ซ้ำกันสำหรับอุปกรณ์ (อาจเป็นอีเมล)
    "push_token": "device push token", // จำเป็น โทเค็นการแจ้งเตือนแบบพุชสำหรับอุปกรณ์
    "platform": 14,                    // จำเป็น แพลตฟอร์มอุปกรณ์ (เช่น 14 สำหรับอีเมล)
    "list_operator": "append",         // ไม่จำเป็น สำหรับแท็กรายการ เพิ่มหรือลบค่าที่ระบุจากแท็กประเภทรายการ
    "tags": {                          // ไม่จำเป็น ค่าที่จะตั้งสำหรับแท็กที่ระบุ
      "language": "en",                //           ใช้ประเภทค่าที่ถูกต้อง
      "CSV_Import": "summer_camp"
    }
  },
  {
    "hwid": "device hwid 2",           // จำเป็น ตัวระบุที่ไม่ซ้ำกันสำหรับอุปกรณ์ที่สอง
    "push_token": "device push token 2", // จำเป็น โทเค็นการแจ้งเตือนแบบพุชสำหรับอุปกรณ์
    "platform": 14,                    // จำเป็น แพลตฟอร์มอุปกรณ์
    "list_operator": "remove",         // ไม่จำเป็น เพิ่มหรือลบค่าจากแท็กประเภทรายการ
    "tags": {                          // ไม่จำเป็น ค่าที่จะลบออกจากแท็กที่ระบุ
      "language": "en",
      "CSV_Import": "summer_camp2"
    }
  },
  {
    "hwid": "device hwid 3",           // จำเป็น ตัวระบุที่ไม่ซ้ำกันสำหรับอุปกรณ์ที่สาม
    "push_token": "device push token 3", // จำเป็น โทเค็นการแจ้งเตือนแบบพุชสำหรับอุปกรณ์
    "platform": 14,                    // จำเป็น แพลตฟอร์มอุปกรณ์
    "tags": {                          // ไม่จำเป็น ค่าที่จะตั้งสำหรับแท็กที่ระบุ
      "language": "en",
      "CSV_Import": "summer_camp3"
    }
  }]
}

การตอบกลับ

เมธอดจะตอบกลับด้วย ID การดำเนินการ ซึ่งสามารถใช้เพื่อติดตามสถานะและผลลัพธ์ของกระบวนการลงทะเบียนจำนวนมากได้

{
  "request_id": "request_id to use in GET method to obtain job status",
  "status": "Pending"
}

bulkRegisterDevice status

คุณสามารถตรวจสอบสถานะของกระบวนการลงทะเบียนจำนวนมากได้โดยการส่งคำขอ GET ต่อไปนี้:

GET https://api.pushwoosh.com/api/v2/audience/bulkRegisterDevice/{request_id}?detailed=true

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
request_id	string	ใช่	request ID ที่ส่งคืนโดยคำขอ POST
detailed	boolean	ไม่	หากตั้งค่าเป็น `true` การตอบกลับจะรวมผลลัพธ์โดยละเอียดสำหรับแต่ละอุปกรณ์ที่ลงทะเบียน

ตัวอย่างการตอบกลับ

{
  "request_id": "9a2e1a14-XXXX-46c3-XXXX-c254b25d3782",
  "status": "Completed",
  "progress": 100,
  "devices_success": 4,
  "devices": [
    {
      "hwid": "user1@example.com",
      "status": "done"
    },
    {
      "hwid": "user2@example.com",
      "status": "done"
    },
    {
      "hwid": "user3@example.com",
      "status": "done"
    },
    {
      "hwid": "invalid_email@example.com",
      "status": "failed"
    }
  ]
}

bulkUnregisterDevice

ยกเลิกการลงทะเบียนอุปกรณ์หลายเครื่องจาก Pushwoosh ในคำขอเดียว

POST https://api.pushwoosh.com/api/v2/audience/bulkUnregisterDevice

พารามิเตอร์ของ Request body

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
application	string	ใช่	รหัสแอปพลิเคชัน Pushwoosh
auth	string	ใช่	โทเค็นการเข้าถึง API
devices	array	ใช่	อาร์เรย์ของอ็อบเจกต์อุปกรณ์ แต่ละอ็อบเจกต์แทนอุปกรณ์และข้อมูลที่เกี่ยวข้อง ดูรายละเอียดในตาราง พารามิเตอร์ของอ็อบเจกต์อุปกรณ์ ด้านล่าง

พารามิเตอร์ของอ็อบเจกต์อุปกรณ์

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
hwid	string	ใช่	The hardware ID หรือตัวระบุที่ไม่ซ้ำกันสำหรับอุปกรณ์ เรียนรู้เพิ่มเติม

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

{
  "application": "application code",   // จำเป็น รหัสแอป Pushwoosh
  "auth": "Pushwoosh auth token",      // จำเป็น โทเค็นการเข้าถึง API จาก Pushwoosh Control Panel
  "devices": [{                        // จำเป็น อาร์เรย์ของอุปกรณ์
    "hwid": "device hwid",             // จำเป็น ตัวระบุที่ไม่ซ้ำกันสำหรับอุปกรณ์ (อาจเป็นอีเมล)
  },
  {
    "hwid": "device hwid 2",           // จำเป็น ตัวระบุที่ไม่ซ้ำกันสำหรับอุปกรณ์ที่สอง
  },
  {
    "hwid": "device hwid 3",           // จำเป็น ตัวระบุที่ไม่ซ้ำกันสำหรับอุปกรณ์ที่สาม
  }]
}

การตอบกลับ

เมธอดจะตอบกลับด้วย ID การดำเนินการ ซึ่งสามารถใช้เพื่อติดตามสถานะและผลลัพธ์ของกระบวนการจำนวนมากได้

{
  "request_id": "request_id to use in GET method to obtain job status",
  "status": "Pending"
}

bulkUnregisterDevice status

คุณสามารถตรวจสอบสถานะของกระบวนการยกเลิกการลงทะเบียนจำนวนมากได้โดยการส่งคำขอ GET ต่อไปนี้:

GET https://api.pushwoosh.com/api/v2/audience/bulkUnregisterDevice/{request_id}?detailed=true

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
request_id	string	ใช่	request ID ที่ส่งคืนโดยคำขอ POST
detailed	boolean	ไม่	หากตั้งค่าเป็น `true` การตอบกลับจะรวมผลลัพธ์โดยละเอียดสำหรับแต่ละอุปกรณ์ที่ยกเลิกการลงทะเบียน

ตัวอย่างการตอบกลับ

{
  "request_id": "9a2e1a14-XXXX-46c3-XXXX-c254b25d3782",
  "status": "Completed",
  "progress": 100,
  "devices_success": 4,
  "devices": [
    {
      "hwid": "user1@example.com",
      "status": "done"
    },
    {
      "hwid": "user2@example.com",
      "status": "done"
    },
    {
      "hwid": "user3@example.com",
      "status": "done"
    },
    {
      "hwid": "invalid_email@example.com",
      "status": "failed"
    }
  ]
}