सामग्री पर जाएं
उपयोगकर्ता गाइडसहायता डेमो अनुरोध करें साइन इन करें
Pushwoosh.com

ऐप कॉन्फ़िगरेशन API

iOS के लिए configureApplication

Anchor link to

ऐप के लिए iOS प्लेटफ़ॉर्म कॉन्फ़िगर करता है।

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

अनुरोध बॉडी

Anchor link to
नामप्रकारविवरण
authस्ट्रिंगPushwoosh कंट्रोल पैनल से API एक्सेस टोकन
applicationस्ट्रिंगPushwoosh एप्लिकेशन कोड
device_typeपूर्णांकiOS के लिए 1 होना चाहिए
ios_key_management_typeस्ट्रिंग”manual”
ios_key_fileस्ट्रिंगBase64-एन्कोडेड iOS कुंजी फ़ाइल सामग्री
ios_key_passwordस्ट्रिंगiOS कुंजी फ़ाइल के लिए पासवर्ड
ios_gatewayपूर्णांक”0” सैंडबॉक्स के लिए, “1” प्रोडक्शन के लिए
ios_frameworkस्ट्रिंगसंभावित मान: “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",      // required. API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX",        // required. Pushwoosh application code
    "device_type": 1,                    // required. 1 for iOS
    "ios_key_management_type": "manual", // required. "manual"
    "ios_key_file": "MIIMY...BAQ==",     // required. base64-encoded iOS key file content
    "ios_key_password": "password",      // required.
    "ios_gateway": 1,                    // required. "0" (sandbox) | "1" (production)
    "ios_framework": "native"            // required. possible values: "native", "cordova", "titanium",
                                         //           "marmalade", "adobeAir", "corona", "xamarin",
                                         //           "phoneGapBuild", "triggerIO", "unity"
  }
}

Android के लिए configureApplication

Anchor link to

ऐप के लिए Android प्लेटफ़ॉर्म कॉन्फ़िगर करता है।

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

अनुरोध बॉडी

Anchor link to
नामप्रकारविवरण
auth*स्ट्रिंगआपके Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
application*स्ट्रिंगPushwoosh एप्लिकेशन कोड
device_type*पूर्णांकAndroid के लिए 3 होना चाहिए।
android_framework*स्ट्रिंगAndroid फ़्रेमवर्क। संभावित मान: native, cordova, marmalade, adobeAir, corona, xamarin, phoneGapBuild, triggerIO, titanium, unity।
android_fcm_service_account*ऑब्जेक्टFCM सेवा खाता कुंजी (Firebase प्रोजेक्ट सेटिंग्स में उत्पन्न JSON फ़ाइल)।
{
  "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"
  }
}

Mac OS X के लिए configureApplication

Anchor link to

ऐप के लिए Mac OS X प्लेटफ़ॉर्म कॉन्फ़िगर करता है।

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

अनुरोध बॉडी

Anchor link to
नामप्रकारविवरण
auth*स्ट्रिंगPushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
application*स्ट्रिंगPushwoosh एप्लिकेशन कोड
device_type*पूर्णांकMac OS X के लिए 7 होना चाहिए।
macos_key_management_type*स्ट्रिंगवर्तमान में केवल “manual” प्रकार उपलब्ध है।
macos_cert_fileस्ट्रिंगBase64-एन्कोडेड Mac OS X प्रमाणपत्र फ़ाइल सामग्री।
macos_key_fileस्ट्रिंगBase64-एन्कोडेड Mac OS X कुंजी फ़ाइल सामग्री।
macos_key_passwordस्ट्रिंगकुंजी फ़ाइल पासवर्ड।
macos_gateway*पूर्णांकपुश गेटवे। “0” सैंडबॉक्स के लिए, “1” प्रोडक्शन के लिए।
{
  "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",                   // required. API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX",                     // required. Pushwoosh application code
    "device_type": 7,                                 // required. 7 for Mac OS X
    "macos_key_management_type": "manual",            // required. "manual"
    "macos_cert_file": "iVBORw0KGgoAAAANSUhEUgAABB…", // optional. Base64-encoded content of Mac OS X certificate file
    "macos_key_file": "iVBORw0KGgoAAAANSUhEUgAABB…",  // optional. Base64-encoded content of Mac OS X key file
    "macos_key_password": "PASSWORD",                 // optional. Key file password
    "macos_gateway": 1                                // required. push gateway. "0" for sandbox or "1" for production
  }
}

Windows के लिए configureApplication

Anchor link to

ऐप के लिए Windows प्लेटफ़ॉर्म कॉन्फ़िगर करता है।

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

अनुरोध बॉडी

Anchor link to
नामप्रकारविवरण
auth*स्ट्रिंगPushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
application*स्ट्रिंगPushwoosh एप्लिकेशन कोड
device_type*पूर्णांकWindows के लिए 8 होना चाहिए।
wns_psid*स्ट्रिंगऐप के लिए Windows Store से पैकेज सुरक्षा पहचानकर्ता। “ms-app://” से शुरू होता है।
wns_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",  // required. API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX",    // required. Pushwoosh application code
    "device_type": 8,                // required. 8 for Windows
    "wns_psid": "ms-app://…",        // required. package security identifier of the app from Windows Store
    "wns_secret": "CLIENT_SECRET"    // required. Windows client secret
  }
}

Amazon के लिए configureApplication

Anchor link to

ऐप के लिए Amazon प्लेटफ़ॉर्म कॉन्फ़िगर करता है।

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

अनुरोध बॉडी

Anchor link to
नामप्रकारविवरण
auth*स्ट्रिंगPushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
application*स्ट्रिंगPushwoosh एप्लिकेशन कोड
device_type*पूर्णांकAmazon के लिए 9 होना चाहिए।
adm_cid*स्ट्रिंगAmazon क्लाइंट आईडी।
adm_secret*स्ट्रिंगAmazon क्लाइंट सीक्रेट।
adm_framework*स्ट्रिंग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",  // required. API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX",    // required. Pushwoosh application code
    "device_type": 9,                // required. 9 for Amazon
    "adm_cid": "CLIENT_ID",          // required. Amazon client ID
    "adm_secret": "CLIENT_SECRET",   // required. Amazon Client Secret
    "adm_framework": "native"        // required. possible values: native, unity, adobeAir.
  }
}

Chrome के लिए configureApplication

Anchor link to

ऐप के लिए Chrome प्लेटफ़ॉर्म कॉन्फ़िगर करता है।

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

अनुरोध बॉडी

Anchor link to
नामप्रकारविवरणआवश्यक
auth*स्ट्रिंगPushwoosh कंट्रोल पैनल से API एक्सेस टोकन।आवश्यक
application*स्ट्रिंगPushwoosh एप्लिकेशन कोडआवश्यक
device_type*पूर्णांकChrome के लिए 11 होना चाहिए।आवश्यक
chrome_fcm_service_account*ऑब्जेक्टFCM सेवा खाता कुंजी (Firebase प्रोजेक्ट सेटिंग्स में उत्पन्न JSON फ़ाइल)।आवश्यक
chrome_vapid_key*स्ट्रिंगसार्वजनिक VAPID (स्वैच्छिक एप्लिकेशन सर्वर पहचान) कुंजी जिसका उपयोग Chrome में पुश नोटिफिकेशन प्रमाणीकरण के लिए किया जाता है।आवश्यक
chrome_vapid_private_key*स्ट्रिंगनिजी 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"
  }
}

Safari के लिए configureApplication

Anchor link to

ऐप के लिए Safari प्लेटफ़ॉर्म कॉन्फ़िगर करता है।

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

अनुरोध बॉडी

Anchor link to
नामप्रकारविवरण
auth*स्ट्रिंगPushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
application*स्ट्रिंगPushwoosh एप्लिकेशन कोड
device_type*पूर्णांकSafari के लिए 10 होना चाहिए।
safari_key_management_type*स्ट्रिंगवर्तमान में केवल “manual” प्रकार उपलब्ध है।
safari_website_nameस्ट्रिंगवेबसाइट का नाम।
safari_allowed_domainsऐरेउदा: https://site1.com”, https://site2.com”
safari_url_template*स्ट्रिंगSafari URL टेम्प्लेट “https://%@” के रूप में स्वरूपित।
safari_icon_fileस्ट्रिंग256x256px png फ़ाइल की Base64-एन्कोडेड सामग्री।
safari_key_file*स्ट्रिंगBase64-एन्कोडेड Safari .p12 कुंजी फ़ाइल सामग्री।
safari_key_passwordस्ट्रिंगकुंजी फ़ाइल का पासवर्ड।
{
  "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",                    // required. API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX",                      // required. Pushwoosh application code
    "device_type": 10,                                 // required. 10 for Safari
    "safari_key_management_type": "manual",            // required. "manual"
    "safari_website_name": "WEBSITE_NAME",             // optional.
    "safari_allowed_domains": [                        // optional.
      "https://site1.com",
      "https://site2.com"
    ],
    "safari_url_template": "https://%@",               // required.
    "safari_icon_file": "iVBORw0KGgoAAAANSUhEUgAABB…", // optional. Base64-encoded content of 256x256px png file
    "safari_key_file": "MIIMY...BAQ==",                // required. base64-encoded Safari .p12 key file content
    "safari_key_password": "PASSWORD"                  // optional. Password to the key file above
  }
}

Firefox के लिए configureApplication

Anchor link to

ऐप के लिए Firefox प्लेटफ़ॉर्म कॉन्फ़िगर करता है।

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

अनुरोध बॉडी

Anchor link to
नामप्रकारविवरणआवश्यक
auth*स्ट्रिंगPushwoosh कंट्रोल पैनल से API एक्सेस टोकन।आवश्यक
application*स्ट्रिंगPushwoosh एप्लिकेशन कोडआवश्यक
device_type*पूर्णांकFirefox के लिए 12 होना चाहिए।आवश्यक
firefox_is_enabledबूलियनFirefox के लिए पुश नोटिफिकेशन सक्षम करता है।वैकल्पिक
firefox_fcm_service_account*ऑब्जेक्टFirebase प्रोजेक्ट सेटिंग्स में उत्पन्न JSON।आवश्यक
firefox_vapid_key*स्ट्रिंगसार्वजनिक VAPID (स्वैच्छिक एप्लिकेशन सर्वर पहचान) कुंजी जिसका उपयोग Firefox में पुश नोटिफिकेशन प्रमाणीकरण के लिए किया जाता है।आवश्यक
firefox_vapid_private_key*स्ट्रिंगनिजी 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"
  }
}

Email के लिए configureApplication

Anchor link to

ऐप के लिए Email प्लेटफ़ॉर्म कॉन्फ़िगर करता है।

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

अनुरोध बॉडी

Anchor link to
नामप्रकारविवरण
auth*स्ट्रिंगPushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
application*स्ट्रिंगPushwoosh एप्लिकेशन कोड
device_type*पूर्णांकEmail के लिए 14 होना चाहिए।
email_from_email*स्ट्रिंगप्रेषक का ईमेल पता। वैध और सत्यापित होना चाहिए।
email_from_name*स्ट्रिंगप्रेषक का नाम।
email_reply*स्ट्रिंगजवाब देने के लिए ईमेल पता। वैध और सत्यापित होना चाहिए।
{
  "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",         // required. API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX",           // required. Pushwoosh application code
    "device_type": 14,                      // required. 14 for email
    "email_from_email": "email@domain.com", // required. Email address should be valid and verified
    "email_from_name": "SENDER_NAME",       // required. Name to display in the "From" email field
    "email_reply": "email@domain.com"       // required. Email address to reply should be valid and verified
  }
}