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

Audience API

bulkSetTags

Anchor link to

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

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

เนื้อหาของคำขอ (Request Body)

Anchor link to
ชื่อประเภทคำอธิบาย
application*Stringรหัสแอปพลิเคชัน Pushwoosh
auth*Stringโทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
create_missing_tagsBooleanหากเป็น true แท็กที่ไม่มีอยู่จะถูกสร้างขึ้นโดยอัตโนมัติ
devices*Objectอาร์เรย์ของอุปกรณ์
devices.hwidStringสามารถใช้เพื่อระบุอุปกรณ์แทน user_id หรือ push_token ได้ เรียนรู้เพิ่มเติม
devices.user_idStringสามารถใช้เพื่อระบุผู้ใช้แทน hwid หรือ push_token ได้
devices.push_tokenStringสามารถใช้เพื่อระบุอุปกรณ์แทน hwid หรือ user_id ได้
devices.list_operatorStringกำหนดวิธีการตั้งค่าสำหรับแท็กประเภทรายการ: set, append หรือ remove
devices.tags*Objectค่าที่ต้องการตั้งสำหรับแท็กที่ระบุ
{
  "request_id": "request_id ที่จะใช้ในเมธอด GET เพื่อรับสถานะของงาน",
  "status": "รอดำเนินการ"
}
คำขอ:
{
  "application": "รหัสแอปพลิเคชัน",   // จำเป็น รหัสแอป Pushwoosh
  "auth": "โทเค็นยืนยันตัวตน Pushwoosh",      // จำเป็น โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
  "create_missing_tags": false,        // ไม่จำเป็น ควรสร้างแท็กที่ขาดหายไปโดยอัตโนมัติหรือไม่
  "devices": [{                        // จำเป็น อาร์เรย์ของอุปกรณ์
    "hwid": "hwid ของอุปกรณ์",             // ไม่จำเป็น สามารถใช้เพื่อระบุอุปกรณ์แทน
                                       //           "user_id" หรือ "push_token" ได้
    "user_id": "ID ผู้ใช้",              // ไม่จำเป็น สามารถใช้เพื่อระบุผู้ใช้แทน "hwid" หรือ "push_token" ได้
    "push_token": "โทเค็นพุชของอุปกรณ์", // ไม่จำเป็น สามารถใช้เพื่อระบุอุปกรณ์แทน "hwid" หรือ "user_id" ได้
    "list_operator": "set",            // จำเป็น สำหรับแท็กประเภทรายการ กำหนดวิธีการตั้งค่าสำหรับ
                                       //           แท็กประเภทรายการ: set, append หรือ remove
    "tags": {                          // จำเป็น ค่าที่ต้องการตั้งสำหรับแท็กที่ระบุ
      "tag_name": "tagvalue",          //           ใช้ประเภทค่าที่ถูกต้อง
      "tag_name2": "tagvalue2"
    }
  }]
}
การตอบกลับ:
{
  "request_id": "request_id ที่จะใช้ในเมธอด GET เพื่อรับสถานะของงาน",
  "status": "รอดำเนินการ"
}

สถานะ bulkSetTags

Anchor link to

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

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

พารามิเตอร์ของเส้นทาง (Path Parameters)

Anchor link to
ชื่อประเภทคำอธิบาย
request_idStringrequest id จากการเรียก /bulkSetTags ก่อนหน้า

พารามิเตอร์ของคิวรี (Query Parameters)

Anchor link to
ชื่อประเภทคำอธิบาย
detailedBoolean(true/false) ว่าจะคืนค่าข้อมูลอย่างละเอียดของแต่ละอุปกรณ์หรือไม่
การตอบกลับ:
{
  "request_id": "id ของคำขอ",
  "status": "เสร็จสมบูรณ์",          // หรือ "รอดำเนินการ", "ล้มเหลว"
  "progress": 100,                // ความคืบหน้าของงาน 0-100
  "devices_success": 100,         // อุปกรณ์ที่สำเร็จ
  "devices_not_found": 0,         // อุปกรณ์ที่ไม่พบใน Pushwoosh
  "devices_failed": 0,            // เกิดข้อผิดพลาด
  "devices": [{                   // รายงานอุปกรณ์ (เฉพาะเมื่อ detailed = true)
    "hwid": "hwid ของอุปกรณ์",
    "status": "เรียบร้อย",             // หรือ "ล้มเหลว", "ไม่พบ"
    "tags": {
      "tagName": "ok",
      "tagName2": "ไม่พบแท็ก",
      "tagName3": "ค่าไม่ถูกต้อง คาดหวัง :string",
    }
  }]
}

bulkRegisterDevice

Anchor link to

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

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

พารามิเตอร์ของคำขอ

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

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

Anchor link to
พารามิเตอร์ประเภทจำเป็นคำอธิบาย
hwidstringใช่Hardware ID หรือตัวระบุที่ไม่ซ้ำกันสำหรับอุปกรณ์
push_tokenstringใช่Push token สำหรับอุปกรณ์
platformintegerใช่ตัวระบุแพลตฟอร์ม เรียนรู้เพิ่มเติม
list_operatorstringไม่กำหนดการดำเนินการสำหรับแท็กประเภทรายการ:
- “append”: เพิ่มค่าที่ระบุลงในรายการแท็ก
- “remove”: ลบค่าที่ระบุออกจากรายการแท็ก
หมายเหตุ: หากไม่ได้ระบุพารามิเตอร์ list_operator ค่าที่มีอยู่ทั้งหมดในรายการแท็กจะถูกแทนที่ด้วยค่าที่ให้มา
tagsobjectไม่แท็กที่กำหนดเองซึ่งกำหนดให้กับอุปกรณ์ แท็กคือคู่ของคีย์-ค่าที่ใช้สำหรับการแบ่งกลุ่ม

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

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

การตอบกลับ

Anchor link to

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

{
  "request_id": "request_id ที่จะใช้ในเมธอด GET เพื่อรับสถานะของงาน",
  "status": "รอดำเนินการ"
}

สถานะ bulkRegisterDevice

Anchor link to

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

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

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

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

Anchor link to
{
  "request_id": "9a2e1a14-XXXX-46c3-XXXX-c254b25d3782",
  "status": "เสร็จสมบูรณ์",
  "progress": 100,
  "devices_success": 4,
  "devices": [
    {
      "hwid": "user1@example.com",
      "status": "เรียบร้อย"
    },
    {
      "hwid": "user2@example.com",
      "status": "เรียบร้อย"
    },
    {
      "hwid": "user3@example.com",
      "status": "เรียบร้อย"
    },
    {
      "hwid": "invalid_email@example.com",
      "status": "ล้มเหลว"
    }
  ]
}

bulkUnregisterDevice

Anchor link to

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

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

พารามิเตอร์ของคำขอ

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

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

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

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

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

การตอบกลับ

Anchor link to

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

{
  "request_id": "request_id ที่จะใช้ในเมธอด GET เพื่อรับสถานะของงาน",
  "status": "รอดำเนินการ"
}

สถานะ bulkUnregisterDevice

Anchor link to

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

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

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

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

Anchor link to
{
  "request_id": "9a2e1a14-XXXX-46c3-XXXX-c254b25d3782",
  "status": "เสร็จสมบูรณ์",
  "progress": 100,
  "devices_success": 4,
  "devices": [
    {
      "hwid": "user1@example.com",
      "status": "เรียบร้อย"
    },
    {
      "hwid": "user2@example.com",
      "status": "เรียบร้อย"
    },
    {
      "hwid": "user3@example.com",
      "status": "เรียบร้อย"
    },
    {
      "hwid": "invalid_email@example.com",
      "status": "ล้มเหลว"
    }
  ]
}