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

API การตั้งค่าแอป

configureApplication สำหรับ iOS

Anchor link to

ตั้งค่าแพลตฟอร์ม iOS สำหรับแอป

POST https://api.pushwoosh.com/json/1.3/configureApplication

Request Body

Anchor link to
ชื่อประเภทคำอธิบาย
authstringโทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
applicationstringรหัสแอปพลิเคชัน Pushwoosh
device_typeintegerต้องเป็น 1 สำหรับ iOS
ios_key_management_typestring”manual”
ios_key_filestringเนื้อหาไฟล์คีย์ iOS ที่เข้ารหัสแบบ Base64
ios_key_passwordstringรหัสผ่านสำหรับไฟล์คีย์ iOS
ios_gatewaystring”0” สำหรับ sandbox, “1” สำหรับ production
ios_frameworkstringค่าที่เป็นไปได้: “native”, “cordova”, “titanium”
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": true,
      "amazon": false,
      "android": false,
      "baidu_android": false,
      "chrome": false,
      "email": false,
      "firefox": false,
      "huawei_android": false,
      "internet_explorer": false,
      "osx": false,
      "safari": false,
      "sms": false,
      "web": false,
      "whats_app": false,
      "windows": false
    }
  }
}
ตัวอย่าง
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",      // จำเป็น โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
    "application": "XXXXX-XXXXX",        // จำเป็น รหัสแอปพลิเคชัน Pushwoosh
    "device_type": 1,                    // จำเป็น 1 สำหรับ iOS
    "ios_key_management_type": "manual", // จำเป็น "manual"
    "ios_key_file": "MIIMY...BAQ==",     // จำเป็น เนื้อหาไฟล์คีย์ iOS ที่เข้ารหัสแบบ base64
    "ios_key_password": "password",      // จำเป็น
    "ios_gateway": "1",                  // จำเป็น "0" (sandbox) | "1" (production)
    "ios_framework": "native"            // จำเป็น ค่าที่เป็นไปได้: "native", "cordova", "titanium",
                                         //           "marmalade", "adobeAir", "corona", "xamarin",
                                         //           "phoneGapBuild", "triggerIO", "unity"
  }
}

configureApplication สำหรับ Android

Anchor link to

ตั้งค่าแพลตฟอร์ม Android สำหรับแอป

POST https://api.pushwoosh.com/json/1.3/configureApplication

Request Body

Anchor link to
ชื่อประเภทคำอธิบาย
auth*stringโทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh ของคุณ
application*stringรหัสแอปพลิเคชัน Pushwoosh
device_type*integerต้องเป็น 3 สำหรับ Android
android_framework*stringเฟรมเวิร์ก Android ค่าที่เป็นไปได้: native, cordova, marmalade, adobeAir, corona, xamarin, phoneGapBuild, triggerIO, titanium, unity.
android_fcm_service_account*objectคีย์บัญชีบริการ FCM (ไฟล์ JSON ที่สร้างขึ้นในการตั้งค่าโปรเจกต์ Firebase)
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": false,
      "amazon": false,
      "android": true,
      "baidu_android": false,
      "chrome": false,
      "email": false,
      "firefox": false,
      "huawei_android": false,
      "internet_explorer": false,
      "osx": false,
      "safari": false,
      "sms": false,
      "web": false,
      "whats_app": false,
      "windows": false
    }
  }
}
{
  "request": {
    "auth": "Z2PLR....IRwTqHwCr",
    "application": "87E33-XXXXX",
    "device_type": 3,
    "android_fcm_service_account": {
      "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
      "auth_uri": "https://accounts.google.com/o/oauth2/auth",
      "client_email": "****@foobar.iam.gserviceaccount.com",
      "client_id": "115********6584854983",
      "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/firebase-adminsdk-zffgu%40foobar.iam.gserviceaccount.com",
      "private_key": "-----BEGIN PRIVATE KEY-----\nuH/OU/fIL+i6Wm8as...\n-----END PRIVATE KEY-----\n",
      "private_key_id": "e3749********6d9",
      "project_id": "app-android",
      "token_uri": "https://oauth2.googleapis.com/token",
      "type": "service_account",
      "universe_domain": "googleapis.com"
    },
    "android_framework": "native"
  }
}

configureApplication สำหรับ Mac OS X

Anchor link to

ตั้งค่าแพลตฟอร์ม Mac OS X สำหรับแอป

POST https://api.pushwoosh.com/json/1.3/configureApplication

Request Body

Anchor link to
ชื่อประเภทคำอธิบาย
auth*stringโทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
application*stringรหัสแอปพลิเคชัน Pushwoosh
device_type*integerต้องเป็น 7 สำหรับ Mac OS X
macos_key_management_type*stringปัจจุบันมีเฉพาะประเภท “manual” เท่านั้น
macos_cert_filestringเนื้อหาไฟล์ใบรับรอง Mac OS X ที่เข้ารหัสแบบ Base64
macos_key_filestringเนื้อหาไฟล์คีย์ Mac OS X ที่เข้ารหัสแบบ Base64
macos_key_passwordstringรหัสผ่านไฟล์คีย์
macos_gateway*integerเกตเวย์พุช “0” สำหรับ sandbox, “1” สำหรับ production
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": false,
      "amazon": false,
      "android": false,
      "baidu_android": false,
      "chrome": false,
      "email": false,
      "firefox": false,
      "huawei_android": false,
      "internet_explorer": false,
      "osx": true,
      "safari": false,
      "sms": false,
      "web": false,
      "whats_app": false,
      "windows": false
    }
  }
}
ตัวอย่าง
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H",                   // จำเป็น โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
    "application": "XXXXX-XXXXX",                     // จำเป็น รหัสแอปพลิเคชัน Pushwoosh
    "device_type": 7,                                 // จำเป็น 7 สำหรับ Mac OS X
    "macos_key_management_type": "manual",            // จำเป็น "manual"
    "macos_cert_file": "iVBORw0KGgoAAAANSUhEUgAABB…", // ไม่บังคับ เนื้อหาไฟล์ใบรับรอง Mac OS X ที่เข้ารหัสแบบ Base64
    "macos_key_file": "iVBORw0KGgoAAAANSUhEUgAABB…",  // ไม่บังคับ เนื้อหาไฟล์คีย์ Mac OS X ที่เข้ารหัสแบบ Base64
    "macos_key_password": "PASSWORD",                 // ไม่บังคับ รหัสผ่านไฟล์คีย์
    "macos_gateway": 1                                // จำเป็น เกตเวย์พุช "0" สำหรับ sandbox หรือ "1" สำหรับ production
  }
}

configureApplication สำหรับ Windows

Anchor link to

ตั้งค่าแพลตฟอร์ม Windows สำหรับแอป

POST https://api.pushwoosh.com/json/1.3/configureApplication

Request Body

Anchor link to
ชื่อประเภทคำอธิบาย
auth*stringโทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
application*stringรหัสแอปพลิเคชัน Pushwoosh
device_type*integerต้องเป็น 8 สำหรับ Windows
wns_psid*stringตัวระบุความปลอดภัยของแพ็กเกจจาก Windows Store สำหรับแอป เริ่มต้นด้วย “ms-app://“
wns_secret*stringClient Secret จาก Windows Store สำหรับแอป
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": false,
      "amazon": false,
      "android": false,
      "baidu_android": false,
      "chrome": false,
      "email": false,
      "firefox": false,
      "huawei_android": false,
      "internet_explorer": false,
      "osx": false,
      "safari": false,
      "sms": false,
      "web": false,
      "whats_app": false,
      "windows": true
    }
  }
}
ตัวอย่าง
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",  // จำเป็น โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
    "application": "XXXXX-XXXXX",    // จำเป็น รหัสแอปพลิเคชัน Pushwoosh
    "device_type": 8,                // จำเป็น 8 สำหรับ Windows
    "wns_psid": "ms-app://…",        // จำเป็น ตัวระบุความปลอดภัยของแพ็กเกจของแอปจาก Windows Store
    "wns_secret": "CLIENT_SECRET"    // จำเป็น Windows client secret
  }
}

configureApplication สำหรับ Amazon

Anchor link to

ตั้งค่าแพลตฟอร์ม Amazon สำหรับแอป

POST https://api.pushwoosh.com/json/1.3/configureApplication

Request Body

Anchor link to
ชื่อประเภทคำอธิบาย
auth*stringโทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
application*stringรหัสแอปพลิเคชัน Pushwoosh
device_type*integerต้องเป็น 9 สำหรับ Amazon
adm_cid*stringID ไคลเอ็นต์ของ Amazon
adm_secret*stringรหัสลับไคลเอ็นต์ของ Amazon
adm_framework*stringเฟรมเวิร์ก Amazon ค่าที่เป็นไปได้: native, unity, adobeAir.
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": false,
      "amazon": true,
      "android": false,
      "baidu_android": false,
      "chrome": false,
      "email": false,
      "firefox": false,
      "huawei_android": false,
      "internet_explorer": false,
      "osx": false,
      "safari": false,
      "sms": false,
      "web": false,
      "whats_app": false,
      "windows": false
    }
  }
}
ตัวอย่าง
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",  // จำเป็น โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
    "application": "XXXXX-XXXXX",    // จำเป็น รหัสแอปพลิเคชัน Pushwoosh
    "device_type": 9,                // จำเป็น 9 สำหรับ Amazon
    "adm_cid": "CLIENT_ID",          // จำเป็น ID ไคลเอ็นต์ของ Amazon
    "adm_secret": "CLIENT_SECRET",   // จำเป็น รหัสลับไคลเอ็นต์ของ Amazon
    "adm_framework": "native"        // จำเป็น ค่าที่เป็นไปได้: native, unity, adobeAir.
  }
}

configureApplication สำหรับ Chrome

Anchor link to

ตั้งค่าแพลตฟอร์ม Chrome สำหรับแอป

POST https://api.pushwoosh.com/json/1.3/configureApplication

Request Body

Anchor link to
ชื่อประเภทคำอธิบายจำเป็น
auth*stringโทเค็นการเข้าถึง API จากแผงควบคุม Pushwooshจำเป็น
application*stringรหัสแอปพลิเคชัน Pushwooshจำเป็น
device_type*integerต้องเป็น 11 สำหรับ Chromeจำเป็น
chrome_fcm_service_account*objectคีย์บัญชีบริการ FCM (ไฟล์ JSON ที่สร้างขึ้นในการตั้งค่าโปรเจกต์ Firebase)จำเป็น
chrome_vapid_key*stringคีย์ VAPID (Voluntary Application Server Identification) สาธารณะที่ใช้สำหรับการยืนยันตัวตนของการแจ้งเตือนแบบพุชใน Chromeจำเป็น
chrome_vapid_private_key*stringคีย์ VAPID ส่วนตัวที่ใช้สำหรับการลงนามและส่งการแจ้งเตือนแบบพุชใน Chromeจำเป็น
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": false,
      "amazon": false,
      "android": false,
      "baidu_android": false,
      "chrome": true,
      "email": false,
      "firefox": false,
      "huawei_android": false,
      "internet_explorer": false,
      "osx": false,
      "safari": false,
      "sms": false,
      "web": false,
      "whats_app": false,
      "windows": false
    }
  }
}
{
  "request": {
    "auth": "Z2PLR....IRwTqHwCr",
    "application": "87E33-XXXXX",
    "device_type": 11,
    "chrome_fcm_service_account": {
      "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
      "auth_uri": "https://accounts.google.com/o/oauth2/auth",
      "client_email": "****@foobar.iam.gserviceaccount.com",
      "client_id": "11529......6584854983",
      "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/****foobar.iam.gserviceaccount.com",
      "private_key": "-----BEGIN PRIVATE KEY-----\nuH/OU/fIm8as...\n-----END PRIVATE KEY-----\n",
      "private_key_id": "e3749......e66d9",
      "project_id": "app-chrome",
      "token_uri": "https://oauth2.googleapis.com/token",
      "type": "service_account",
      "universe_domain": "googleapis.com"
    },
    "chrome_vapid_key": "BEr....KPqQvCbU",
    "chrome_vapid_private_key": "ee....flOqmSo"
  }
}

configureApplication สำหรับ Safari

Anchor link to

ตั้งค่าแพลตฟอร์ม Safari สำหรับแอป

POST https://api.pushwoosh.com/json/1.3/configureApplication

Request Body

Anchor link to
ชื่อประเภทคำอธิบาย
auth*stringโทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
application*stringรหัสแอปพลิเคชัน Pushwoosh
device_type*integerต้องเป็น 10 สำหรับ Safari
safari_key_management_type*stringปัจจุบันมีเฉพาะประเภท “manual” เท่านั้น
safari_website_namestringชื่อเว็บไซต์
safari_allowed_domainsarrayเช่น: https://site1.com”, https://site2.com”
safari_url_template*stringเทมเพลต URL ของ Safari ในรูปแบบ “https://%@“
safari_icon_filestringเนื้อหาไฟล์ png ขนาด 256x256px ที่เข้ารหัสแบบ Base64
safari_key_file*stringเนื้อหาไฟล์คีย์ .p12 ของ Safari ที่เข้ารหัสแบบ Base64
safari_key_passwordstringรหัสผ่านสำหรับไฟล์คีย์
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": false,
      "amazon": false,
      "android": false,
      "baidu_android": false,
      "chrome": false,
      "email": false,
      "firefox": false,
      "huawei_android": false,
      "internet_explorer": false,
      "osx": false,
      "safari": true,
      "sms": false,
      "web": false,
      "whats_app": false,
      "windows": false
    }
  }
}
ตัวอย่าง
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",                    // จำเป็น โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
    "application": "XXXXX-XXXXX",                      // จำเป็น รหัสแอปพลิเคชัน Pushwoosh
    "device_type": 10,                                 // จำเป็น 10 สำหรับ Safari
    "safari_key_management_type": "manual",            // จำเป็น "manual"
    "safari_website_name": "WEBSITE_NAME",             // ไม่บังคับ
    "safari_allowed_domains": [                        // ไม่บังคับ
      "https://site1.com",
      "https://site2.com"
    ],
    "safari_url_template": "https://%@",               // จำเป็น
    "safari_icon_file": "iVBORw0KGgoAAAANSUhEUgAABB…", // ไม่บังคับ เนื้อหาไฟล์ png ขนาด 256x256px ที่เข้ารหัสแบบ Base64
    "safari_key_file": "MIIMY...BAQ==",                // จำเป็น เนื้อหาไฟล์คีย์ .p12 ของ Safari ที่เข้ารหัสแบบ base64
    "safari_key_password": "PASSWORD"                  // ไม่บังคับ รหัสผ่านสำหรับไฟล์คีย์ด้านบน
  }
}

configureApplication สำหรับ Firefox

Anchor link to

ตั้งค่าแพลตฟอร์ม Firefox สำหรับแอป

POST https://api.pushwoosh.com/json/1.3/configureApplication

Request Body

Anchor link to
ชื่อประเภทคำอธิบายจำเป็น
auth*stringโทเค็นการเข้าถึง API จากแผงควบคุม Pushwooshจำเป็น
application*stringรหัสแอปพลิเคชัน Pushwooshจำเป็น
device_type*integerต้องเป็น 12 สำหรับ Firefoxจำเป็น
firefox_is_enabledbooleanเปิดใช้งานการแจ้งเตือนแบบพุชสำหรับ Firefoxไม่บังคับ
firefox_fcm_service_account*objectJSON ที่สร้างขึ้นในการตั้งค่าโปรเจกต์ Firebaseจำเป็น
firefox_vapid_key*stringคีย์ VAPID (Voluntary Application Server Identification) สาธารณะที่ใช้สำหรับการยืนยันตัวตนของการแจ้งเตือนแบบพุชใน Firefoxจำเป็น
firefox_vapid_private_key*stringคีย์ VAPID ส่วนตัวที่ใช้สำหรับการลงนามและส่งการแจ้งเตือนแบบพุชใน Firefoxจำเป็น
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": false,
      "amazon": false,
      "android": false,
      "baidu_android": false,
      "chrome": false,
      "email": false,
      "firefox": true,
      "huawei_android": false,
      "internet_explorer": false,
      "osx": false,
      "safari": false,
      "sms": false,
      "web": false,
      "whats_app": false,
      "windows": false
    }
  }
}
{
  "request": {
    "auth": "Z2PLR....IRwTqHwCr",
    "application": "87E33-XXXXX",
    "device_type": 12,
    "firefox_fcm_service_account": {
      "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
      "auth_uri": "https://accounts.google.com/o/oauth2/auth",
      "client_email": "****@foobar.iam.gserviceaccount.com",
      "client_id": "115........6584854983",
      "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/****@foobar.iam.gserviceaccount.com",
      "private_key": "-----BEGIN PRIVATE KEY-----\n****uH/OU/fILL****fMJZ+i6****um8as.....\n-----END PRIVATE KEY-----\n",
      "private_key_id": "e3........8e66d9",
      "project_id": "app-firefox",
      "token_uri": "https://oauth2.googleapis.com/token",
      "type": "service_account",
      "universe_domain": "googleapis.com"
    },
    "firefox_vapid_key": "BEr....KPqQvCbU",
    "firefox_vapid_private_key": "ee....flOqmSo"
  }
}

configureApplication สำหรับ Email

Anchor link to

ตั้งค่าแพลตฟอร์ม Email สำหรับแอป

POST https://api.pushwoosh.com/json/1.3/configureApplication

Request Body

Anchor link to
ชื่อประเภทคำอธิบาย
auth*stringโทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
application*stringรหัสแอปพลิเคชัน Pushwoosh
device_type*integerต้องเป็น 14 สำหรับ Email
email_from_email*stringที่อยู่อีเมลผู้ส่ง ควรเป็นที่อยู่ที่ใช้งานได้และได้รับการยืนยันแล้ว
email_from_name*stringชื่อผู้ส่ง
email_reply*stringที่อยู่อีเมลสำหรับตอบกลับ ควรเป็นที่อยู่ที่ใช้งานได้และได้รับการยืนยันแล้ว
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": false,
      "amazon": false,
      "android": false,
      "baidu_android": false,
      "chrome": false,
      "email": true,
      "firefox": false,
      "huawei_android": false,
      "internet_explorer": false,
      "osx": false,
      "safari": false,
      "sms": false,
      "web": false,
      "whats_app": false,
      "windows": false
    }
  }
}
ตัวอย่าง
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H",         // จำเป็น โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
    "application": "XXXXX-XXXXX",           // จำเป็น รหัสแอปพลิเคชัน Pushwoosh
    "device_type": 14,                      // จำเป็น 14 สำหรับอีเมล
    "email_from_email": "email@domain.com", // จำเป็น ที่อยู่อีเมลควรใช้งานได้และได้รับการยืนยันแล้ว
    "email_from_name": "SENDER_NAME",       // จำเป็น ชื่อที่จะแสดงในช่อง "จาก" ของอีเมล
    "email_reply": "email@domain.com"       // จำเป็น ที่อยู่อีเมลสำหรับตอบกลับควรใช้งานได้และได้รับการยืนยันแล้ว
  }
}