跳到内容
用户指南 支持 请求演示 登录
Pushwoosh.com

应用程序 API

createApplication

Anchor link to

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

在账户上创建一个新的应用程序。

请求正文

Anchor link to
名称类型描述
authorize_all_tokensboolean允许所有 API 令牌与此应用通信。
auth*string来自 Pushwoosh Control Panel 的 API 访问令牌。
iconstringpng 文件的 Base64 编码二进制内容。
sdk_iosstringiOS SDK 类型。可能的值：“pw” 或 “corona”。对于 Corona，推送有效负载是不同的。
sdk_androidstringAndroid SDK 类型。可能的值：“pw”、“corona”、“phonegap”。AppPresser 用户选择 “phonegap”。
title*string在 Pushwoosh 中为新应用设置的标题。

响应示例：

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "application": "1DC69-73EDB"
  }
}

代码示例：

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",          // 必需。来自 Pushwoosh Control Panel 的 API 访问令牌
    "icon": "iVBORw0KGgoAAAANSUhEUgAAA...",  // 可选。png 文件的 Base-64 编码二进制内容
    "authorize_all_tokens": true,            // 可选。如果为 true，则允许所有 API 令牌与此应用通信
    "sdk_ios": "pw",                         // 可选。可能的值为 “pw” 或 “corona”
    "sdk_android": "pw",                     // 可选。可能的值为 “pw”、“corona” 或 “phonegap”
    "title": "APP_TITLE"                     // 必需。在 Pushwoosh 中为新应用设置的标题
  }
}

updateApplication

Anchor link to

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

更新应用程序设置。

请求正文

Anchor link to
名称类型描述
auth*string来自 Pushwoosh Control Panel 的 API 访问令牌。
application*stringPushwoosh 应用程序代码
iconstringpng 文件的 Base64 编码二进制内容。
sdk_iosstringiOS SDK 类型。可能的值：“pw” 或 “corona”。对于 Corona，推送有效负载是不同的。
sdk_androidstringAndroid SDK 类型。可能的值：“pw”、“corona”、“phonegap”。AppPresser 用户选择 “phonegap”。
titlestring在 Pushwoosh 中为应用设置的新标题。
{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}
示例
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",     // 必需。来自 Pushwoosh Control Panel 的 API 访问令牌
    "application": "XXXXX-XXXXX",       // 必需。您要更新的应用的应用程序代码
    "icon": "iVBORw0KGgoAAAANSUD6...",  // 可选。png 文件的 Base-64 编码二进制内容
    "sdk_ios": "pw",                    // 可选。可能的值为 “pw” 或 “corona”
    "sdk_android": "pw",                // 可选。可能的值为 “pw”、“corona” 或 “phonegap”
    "title": "APP_TITLE"                // 可选。在 Pushwoosh 中为应用设置的新标题
  }
}

deleteApplication

Anchor link to

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

从账户中删除应用。

请求正文

Anchor link to
名称类型描述
auth*string来自 Pushwoosh Control Panel 的 API 访问令牌。
application*stringPushwoosh 应用程序代码
{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}
示例
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // 必需。来自 Pushwoosh Control Panel 的 API 访问令牌
    "application": "XXXXX-XXXXX"    // 必需。Pushwoosh 应用程序代码
  }
}

getApplication

Anchor link to

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

获取有关应用的详细信息。

请求正文

Anchor link to
名称类型描述
auth*string来自 Pushwoosh Control Panel 的 API 访问令牌。
application*stringPushwoosh 应用程序代码
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "application": {
      "adm_cid": "",
      "adm_secret": "",
      "android_api_type": "x31",
      "android_gcm_api_key": "x7836363631366236353566366236353739",
      "android_sdk": "x7077",
      "icon_url": null,
      "ios_gateway": "x783330",
      "ios_key_management_type": "x783631373537343666",
      "ios_key_password": "x7836353336363236353335333736353333",
      "ios_sdk": "x7077",
      "title": "0 Application For test",
      "providers": {
        "ios": true,
        "amazon": false,
        "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
      },
      "languages": {
        "en": "34",
        "zh": "12",
        "sv": "7",
        "de": "6",
        "pt": "6"
      }
    }
  }
}
 
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // 必需。来自 Pushwoosh Control Panel 的 API 访问令牌
    "application": "XXXXX-XXXXX"    // 必需。Pushwoosh 应用程序代码
  }
}

getApplications

Anchor link to

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

获取账户上的应用程序列表。可以返回带分页的结果。

请求正文

Anchor link to
名称类型描述
auth*string来自 Pushwoosh Control Panel 的 API 访问令牌。
pageinteger用于分页的页码。

请求示例

Anchor link to
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",  // 必需。来自 Pushwoosh Control Panel 的 API 访问令牌
    "page": 2                        // 可选。用于分页的页码
  }
}

响应

Anchor link to

如果账户中的应用程序超过 100 个，响应将包含 current page 和 total amount of pages。

响应示例

Anchor link to
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "page": 1,   // 当前页
    "total": 2,  // 总页数
    "applications": [{
      "APPLICATION_CODE": "MyApp1"
    }, {
      "APPLICATION_CODE": "MyApp2"
    }]
  }
}

getApplicationFile

Anchor link to

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

获取与应用相关的配置文件。

请求正文

Anchor link to
名称类型描述
auth*string来自 Pushwoosh Control Panel 的 API 访问令牌。
application*stringPushwoosh 应用程序代码
file*string要检索的文件的标识符。请参阅下面的值。
{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}
示例
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",  // 必需。来自 Pushwoosh Control Panel 的 API 访问令牌
    "application": "XXXXX-XXXXX",    // 必需。Pushwoosh 应用程序代码
    "file": "ios_auto_privatekey"    // 必需。要检索的文件的标识符。请参阅下面的值
  }
}

“file” 参数的可能值：

Anchor link to

`“ios_auto_privatekey” | “ios_manual_privatekey” | “ios_auto_certificate” | “ios_manual_certificate” | “ios_push_certificate” | “ios_provisioning_profile” | “macos_manual_privatekey” | “macos_manual_certificate” | “macos_push_certificate” | “safari_manual_privatekey” | “safari_push_certificate” | “safari_push_package” |

响应示例：

-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----
-----BEGIN RSA PRIVATE KEY-----
...
-----END RSA PRIVATE KEY-----

setApplicationPlatformStatus

Anchor link to

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

更改应用的平台状态。

请求正文

Anchor link to
名称类型描述
auth*string来自 Pushwoosh Control Panel 的 API 访问令牌。
application*stringPushwoosh 应用程序代码
platform*integer平台类型。请参阅下面的平台类型列表。
status*string“enable” 或 “disable”
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "message": "iOS pushes are disabled",
    "available_platforms": {
      "iOS": false,
      "Android": true,
      "OS X": false,
      "Windows": false,
      "Amazon": false,
      "Safari": false,
      "Chrome": true,
      "Firefox": false,
    }
  }
}
示例
{
  "request": {
    "application": "XXXXX-XXXXX",   // 必需。Pushwoosh 应用程序代码
    "auth": "yxoPUlwqm…………pIyEX4H", // 必需。来自 Pushwoosh Control Panel 的 API 访问令牌
    "platform": 1,                  // 必需。1 — iOS；3 — Android；7 — Mac OS X；8 — Windows；
                                    //           9 — Amazon；10 — Safari；11 — Chrome；12 — Firefox；
    "status": "disable"             // 必需。“disable” 或 “enable”
  }
}