Audience API

bulkSetTags

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

กำหนดค่า Tag สำหรับรายการอุปกรณ์

Request Body

ชื่อ	ประเภท	คำอธิบาย
application*	String	Pushwoosh application code
auth*	String	API access token จาก Pushwoosh Control Panel
create_missing_tags	Boolean	หากเป็น true, Tag ที่ขาดหายไปจะถูกสร้างขึ้นโดยอัตโนมัติ
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	กำหนดวิธีการตั้งค่าสำหรับ Tag ประเภทรายการ (list type): set, append, หรือ remove
devices.tags*	Object	ค่าที่จะกำหนดสำหรับ Tag ที่ระบุ

OK
Error

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

{
  "message": "invalid request"
}

{
  "application": "application code",   // จำเป็น Pushwoosh app code
  "auth": "Pushwoosh auth token",      // จำเป็น API access token จาก Pushwoosh Control Panel
  "create_missing_tags": false,        // ไม่จำเป็น สร้าง Tag ที่ขาดหายไปโดยอัตโนมัติ
  "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",            // จำเป็น สำหรับ Tag แบบรายการ กำหนดวิธีการตั้งค่าสำหรับ
                                       //           Tag ประเภทรายการ: set, append, หรือ remove
    "tags": {                          // จำเป็น ค่าที่จะกำหนดสำหรับ Tag ที่ระบุ
      "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 ในคำขอเดียว นอกจากนี้ยังช่วยให้สามารถระบุ Tag ต่างๆ สำหรับแต่ละอุปกรณ์ได้

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

Request body parameters

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

Device object parameters

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

Request example

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

Response

วิธีการนี้จะตอบกลับด้วย 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` การตอบกลับจะรวมผลลัพธ์โดยละเอียดสำหรับอุปกรณ์แต่ละเครื่องที่ลงทะเบียน

Example response

{
  "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 parameters

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

Device object parameters

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

Request example

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

Response

วิธีการนี้จะตอบกลับด้วย 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` การตอบกลับจะรวมผลลัพธ์โดยละเอียดสำหรับอุปกรณ์แต่ละเครื่องที่ถูกยกเลิกการลงทะเบียน

Example response

{
  "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"
    }
  ]
}