Mobile Platform as a Service：服務端 API

廠商通道的參數特殊限制，請參考：

訊息推送提供以下服務端 API，具體描述見下表。

SDK 準備

訊息推送支援 Java、Python、Node.js、PHP 四種語言版本。針對不同的語言版本，在調用上述推送方式前，需要進行相應的推送準備。

下面分別對各個語言版本的 SDK 準備工作進行說明。

Java

<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>aliyun-java-sdk-mpaas</artifactId>
  <version>3.0.10</version>
</dependency>

<dependency>
<groupId>com.aliyun</groupId>
  <artifactId>aliyun-java-sdk-core</artifactId>
  <optional>true</optional>
  <version>[4.3.2,5.0.0)</version>
</dependency>

Python

執行以下命令添加 SDK 相關依賴。

## 阿里雲SDK
pip install aliyun-python-sdk-core
## mpaas SDK 
pip install aliyun-python-sdk-mpaas

Node.js

執行以下命令添加 SDK 相關依賴。

npm i @alicloud/mpaas20190821

PHP

執行以下命令添加 SDK 相關依賴。

composer require alibabacloud/sdk

環境變數配置

配置環境變數 MPAAS_AK_ENV 和 MPAAS_SK_ENV。

• Linux 和 macOS 系統配置方法執行以下命令：

  export MPAAS_AK_ENV=<access_key_id>
  export MPAAS_SK_ENV=<access_key_secret>

  說明

  access_key_id 替換為已準備好的 AccessKey ID，access_key_secret 替換為 AccessKey Secret。

• Windows 系統配置方法

  1. 建立環境變數，添加環境變數 MPAAS_AK_ENV 和 MPAAS_SK_ENV，並寫入已準備好的 AccessKey ID 和 AccessKey Secret。

  2. 重啟 Windows 系統。

極簡推送

對一個推送 ID 推送一條訊息。

在調用本介面之前，您需要引入依賴，詳見 SDK 準備。

請求參數

StrategyContent 欄位說明

JSON 格式轉化為 String 傳值。

返回參數

程式碼範例

請確保您的 AccessKey 擁有 AliyunMPAASFullAccess 許可權，詳情請參考 對 RAM 帳號進行應用層級的存取控制。

Java 程式碼範例

單擊此處 查看下方程式碼範例中 AccessKeyId 與 AccessKeySecret 的擷取方式 。

 DefaultProfile.addEndpoint("cn-hangzhou", "mpaas", "mpaas.cn-hangzhou.aliyuncs.com");
        // 建立 DefaultAcsClient 執行個體並初始化
        // 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
        // 強烈建議不要把AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。
        // 本樣本以將AccessKey ID和AccessKey Secret儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡。
        // 建議先完成環境變數配置
        String accessKeyId = System.getenv("MPAAS_AK_ENV");
        String accessKeySecret = System.getenv("MPAAS_SK_ENV");
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // 地區 ID
            accessKeyId,      
            accessKeySecret); 

        IAcsClient client = new DefaultAcsClient(profile);
        // Create an API request and set parameters
        PushSimpleRequest request = new PushSimpleRequest();
        request.setAppId("ONEX570DA89211721");
        request.setWorkspaceId("test");
        request.setTaskName("測試工作");
        request.setTitle("測試");
        request.setContent("測試");
        request.setDeliveryType(3L);
        Map<String,String> extendedParam = new HashMap<String, String>();
        extendedParam.put("key1","value1");
        request.setExtendedParams(JSON.toJSONString(extendedParam));
        request.setExpiredSeconds(300L);

        request.setPushStyle(2);
        String imageUrls = "{\"defaultUrl\":\"https://pre-mpaas.oss-cn-hangzhou.aliyuncs.com/tmp/test.png\",\"oppoUrl\":\"https://pre-mpaas.oss-cn-hangzhou.aliyuncs.com/tmp/test.png\",\"miuiUrl\":\"https://pre-mpaas.oss-cn-hangzhou.aliyuncs.com/tmp/test.png\",\"fcmUrl\":\"https://pre-mpaas.oss-cn-hangzhou.aliyuncs.com/tmp/test.png\",\"iosUrl\":\"https://pre-mpaas.oss-cn-hangzhou.aliyuncs.com/tmp/test.png\"}";
        String iconUrls = "{\"defaultUrl\":\"https://pre-mpaas.oss-cn-hangzhou.aliyuncs.com/tmp/test.png\",\"hmsUrl\":\"https://pre-mpaas.oss-cn-hangzhou.aliyuncs.com/tmp/test.png\",\"oppoUrl\":\"https://pre-mpaas.oss-cn-hangzhou.aliyuncs.com/tmp/test.png\",\"miuiUrl\":\"https://pre-mpaas.oss-cn-hangzhou.aliyuncs.com/tmp/test.png\"}";
        request.setImageUrls(imageUrls);
        request.setIconUrls(iconUrls);

        request.setStrategyType(2);
        request.setStrategyContent("{\"fixedTime\":1630303126000,\"startTime\":1625673600000,\"endTime\":1630303126000,\"circleType\":1,\"circleValue\":[1, 7],\"time\":\"13:45:11\"}");

        Map<String,String> target = new HashMap<String, String>();
        String msgKey = String.valueOf(System.currentTimeMillis());
        target.put("user1024",msgKey);
        request.setTargetMsgkey(JSON.toJSONString(target));
        // Initiate the request and handle the response or exceptions
        PushSimpleResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }

Python 程式碼範例

from aliyunsdkcore.client import AcsClient
from aliyunsdkmpaas.request.v20190821 import PushSimpleRequest
import json

        // 阿里雲帳號 AccessKey 擁有所有 API 的存取權限，風險很高。強烈建議您建立並使用 RAM 使用者進行 API 訪問或日常營運，請登入 RAM 控制台建立 RAM 使用者
        // 此處以把 AccessKey 和 AccessKeySecret 儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡
        // 強烈建議不要把 AccessKey 和 AccessKeySecret 儲存到代碼裡，會存在密鑰泄漏風險
        // 建議先完成環境變數配置
String accessKeyId = System.getenv("MPAAS_AK_ENV");
String accessKeySecret = System.getenv("MPAAS_SK_ENV");
# Initialize AcsClient instance
client = AcsClient(
"cn-hangzhou",
accessKeyId,      
accessKeySecret 
);

# Initialize a request and set parameters
request = PushSimpleRequest.PushSimpleRequest()
request.set_endpoint("mpaas.cn-hangzhou.aliyuncs.com")
request.set_AppId("ONEX570DA89211721")
request.set_WorkspaceId("test")
request.set_Title( "python測試")
request.set_Content( "測試2")
request.set_DeliveryType(3)
request.set_TaskName("python測試工作")
request.set_ExpiredSeconds(600)
target = {"user1024":str(time.time())}
request.set_TargetMsgkey(json.dumps(target))

# Print response
response = client.do_action_with_exception(request)
print response

Node.js 程式碼範例

const sdk = require('@alicloud/mpaas20190821');

const { default: Client, PushSimpleRequest } = sdk;
// 建立用戶端
// 阿里雲帳號 AccessKey 擁有所有 API 的存取權限，風險很高。強烈建議您建立並使用 RAM 使用者進行 API 訪問或日常營運，請登入 RAM 控制台建立 RAM 使用者
// 此處以把 AccessKey 和 AccessKeySecret 儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡
// 強烈建議不要把 AccessKey 和 AccessKeySecret 儲存到代碼裡，會存在密鑰泄漏風險
// 建議先完成環境變數配置
String accessKeyId = System.getenv("MPAAS_AK_ENV");
String accessKeySecret = System.getenv("MPAAS_SK_ENV");
const client = new Client({
  accessKeyId,      
  accessKeySecret, 
  endpoint: 'mpaas.cn-hangzhou.aliyuncs.com',
  apiVersion: '2019-08-21'
});
// 初始化 request
  const request = new PushSimpleRequest();
  request.appId = "ONEX570DA89211721";
  request.workspaceId = "test";
  request.title = "Node測試";
  request.content = "測試";
  request.deliveryType = 3;
  request.taskName = "Node測試工作";
  request.expiredSeconds=600;
  const extendedParam = {
    test: '自訂擴充參數'
  };
  request.extendedParams = JSON.stringify(extendedParam);
// value 為業務方訊息id，請保持唯一
  const target = {
    "userid1024": String(new Date().valueOf())
  };
  request.targetMsgkey = JSON.stringify(target);

// 調用 API
try {
  client.pushSimple(request).then(res => {
    console.log('SUCCESS', res);
  }).catch(e => {
    console.log('FAIL', e);
  });
} catch(e) {
  console.log('ERROR', e);
}

PHP 程式碼範例

<?php

use AlibabaCloud\Client\AlibabaCloud;
use AlibabaCloud\MPaaS\MPaaS;
AlibabaCloud::accessKeyClient('accessKeyId', 'accessKeySecret')
    ->regionId('cn-hangzhou')
    ->asDefaultClient();

class Demo {
    public function run() {
        try {
               $this->simplePush();
        } catch (\Exception $e) {
        }
    }


    public function simplePush() {
        $request = MPaaS::v20190821()->pushSimple();
        $result = $request->withAppId("ONEX570DA89211721")
            ->withWorkspaceId("test")
            ->withTitle("PHP 測試")
            ->withContent("測試3")
            ->withDeliveryType(3)
            ->withTaskName("PHP 測試工作")
            ->withExpiredSeconds(600)
            ->withTargetMsgkey(
                json_encode(["userid1024" => "".time() ]
            ))
            // endpoint
            ->host("mpaas.cn-hangzhou.aliyuncs.com")
            // 是否開啟 debug 模式
            ->debug(true)
            ->request();
    }
}

模板推送

模板推送指標對單個目標 ID 的訊息推送，訊息通過模板建立。多個 ID 可以使用同一個模板。

在調用本介面之前，確保已完成以下操作：

• 在訊息推送控制台上建立好目標模板，詳細操作參見 建立模板。

• 引入 SDK 依賴，詳見 SDK 準備。

請求參數

StrategyContent 欄位說明

JSON 格式轉化為 String 傳值。

返回參數

程式碼範例

請確保您的 AccessKey 擁有 AliyunMPAASFullAccess 許可權，詳情請參考 對 RAM 帳號進行應用層級的存取控制。

Java 程式碼範例

單擊此處 查看下方程式碼範例中 AccessKeyId 與 AccessKeySecret 的擷取方式 。

 DefaultProfile.addEndpoint("cn-hangzhou", "mpaas", "mpaas.cn-hangzhou.aliyuncs.com");
        // 建立 DefaultAcsClient 執行個體並初始化
        // 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
        // 強烈建議不要把AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。
        // 本樣本以將AccessKey ID和AccessKey Secret儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡。
        // 建議先完成環境變數配置
        String accessKeyId = System.getenv("MPAAS_AK_ENV");
        String accessKeySecret = System.getenv("MPAAS_SK_ENV");
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // 地區 ID
            accessKeyId,      
            accessKeySecret); 

        IAcsClient client = new DefaultAcsClient(profile);
        // Create an API request and set parameters
        PushTemplateRequest request = new PushTemplateRequest();
        request.setAppId("ONEX570DA89211721");
        request.setWorkspaceId("test");
        request.setTemplateName("測試模板");
        //你好#name#,恭喜中獎#money#元
        Map<String,String> templatekv = new HashMap<String, String>();
        templatekv.put("name","張三");
        templatekv.put("money","200");
        request.setTemplateKeyValue(JSON.toJSONString(templatekv));
        request.setExpiredSeconds(600L);
        request.setTaskName("模板測試");
        request.setDeliveryType(3L);
        Map<String,String> target = new HashMap<String, String>();
        String msgKey = String.valueOf(System.currentTimeMillis());
        target.put("userid1024",msgKey);
        request.setTargetMsgkey(JSON.toJSONString(target));

        request.setStrategyType(2);
        request.setStrategyContent("{\"fixedTime\":1630303126000,\"startTime\":1625673600000,\"endTime\":1630303126000,\"circleType\":1,\"circleValue\":[1, 7],\"time\":\"13:45:11\"}");

        PushTemplateResponse response;
        try {
            response = client.getAcsResponse(request);

            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }

Python 程式碼範例

from aliyunsdkcore.client import AcsClient
from aliyunsdkmpaas.request.v20190821 import PushTemplateRequest
import json
import time

        // 阿里雲帳號 AccessKey 擁有所有 API 的存取權限，風險很高。強烈建議您建立並使用 RAM 使用者進行 API 訪問或日常營運，請登入 RAM 控制台建立 RAM 使用者
        // 此處以把 AccessKey 和 AccessKeySecret 儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡
        // 強烈建議不要把 AccessKey 和 AccessKeySecret 儲存到代碼裡，會存在密鑰泄漏風險
        // 建議先完成環境變數配置
# Initialize AcsClient instance
String accessKeyId = System.getenv("MPAAS_AK_ENV");
String accessKeySecret = System.getenv("MPAAS_SK_ENV");
client = AcsClient(
accessKeyId,      
accessKeySecret, 
"cn-hangzhou"
);

# Initialize a request and set parameters
request = PushTemplateRequest.PushTemplateRequest()
request.set_endpoint("mpaas.cn-hangzhou.aliyuncs.com")
request.set_AppId("ONEX570DA89211721")
request.set_WorkspaceId("test")
request.set_TemplateName("template1024")
templatekv = {"name":"張三","money":"200"}
request.set_TemplateKeyValue(json.dumps(templatekv))
request.set_DeliveryType(3)
request.set_TaskName("python模板測試工作")
request.set_ExpiredSeconds(600)
target = {"userid1024":str(time.time())}
request.set_TargetMsgkey(json.dumps(target))

# Print response
response = client.do_action_with_exception(request)
print response

Node.js 程式碼範例

const sdk = require('@alicloud/mpaas20190821');

const { default: Client, PushTemplateRequest } = sdk;
// 建立用戶端
// 阿里雲帳號 AccessKey 擁有所有 API 的存取權限，風險很高。強烈建議您建立並使用 RAM 使用者進行 API 訪問或日常營運，請登入 RAM 控制台建立 RAM 使用者
// 此處以把 AccessKey 和 AccessKeySecret 儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡
// 強烈建議不要把 AccessKey 和 AccessKeySecret 儲存到代碼裡，會存在密鑰泄漏風險
// 建議先完成環境變數配置
String accessKeyId = System.getenv("MPAAS_AK_ENV");
String accessKeySecret = System.getenv("MPAAS_SK_ENV");
const client = new Client({
  accessKeyId,      
  accessKeySecret, 
  endpoint: 'mpaas.cn-hangzhou.aliyuncs.com',
  apiVersion: '2019-08-21'
});
// 初始化 request
  const request = new PushTemplateRequest();
  request.appId = "ONEX570DA89211721";
  request.workspaceId = "test";
  request.templateName= "template1024";
  const templatekv = {
    name: '張三',
    money:'300'
  };
  request.templateKeyValue = JSON.stringify(templatekv);
  request.deliveryType = 3;
  request.taskName = "Node測試工作";
  request.expiredSeconds=600;
  const extendedParam = {
    test: '自訂擴充參數'
  };
  request.extendedParams = JSON.stringify(extendedParam);
  const target = {
    "userid1024": String(new Date().valueOf())
  };
  request.targetMsgkey = JSON.stringify(target);

// 調用 API
try {
  client.pushTemplate(request).then(res => {
    console.log('SUCCESS', res);
  }).catch(e => {
    console.log('FAIL', e);
  });
} catch(e) {
  console.log('ERROR', e);
}

PHP 程式碼範例

<?php

use AlibabaCloud\Client\AlibabaCloud;
use AlibabaCloud\MPaaS\MPaaS;
AlibabaCloud::accessKeyClient('accessKeyId', 'accessKeySecret')
    ->regionId('cn-hangzhou')
    ->asDefaultClient();

class Demo {
    public function run() {
        try {
              $this->templatePush();
        } catch (\Exception $e) {
        }
    }

    public function templatePush() {
        $request = MPaaS::v20190821()->pushTemplate();
        $result = $request->host("mpaas.cn-hangzhou.aliyuncs.com")
            // 是否開啟 debug 模式
            ->debug(true)
            ->withAppId("ONEX570DA89211721")
            ->withWorkspaceId("test")
            ->withTemplateName("template1024")
            ->withTemplateKeyValue(json_encode(["name" => "張三", "money" => "200"]))
            ->withDeliveryType(3)
            ->withTaskName("PHP 測試工作")
            ->withExpiredSeconds(600)
            ->withTargetMsgkey(
                json_encode(["userid1024" => "".time() ])
            )
            ->request();
    }
}

批量推送

對各個推送 ID 推送不同訊息。通過替換模板預留位置的方式，建立針對某一推送 ID 的個人化訊息。與模板推送的區別在於，每一個推送 ID 可以收到內容不相同的訊息。

在調用本介面之前，確保已完成以下操作：

• 在訊息推送控制台上建立好目標模板，並確保模板中存在預留位置，否則將無法實現訊息的個人化推送（即對不同推送 ID 推送不同訊息）。詳細操作參見 建立模板。

• 引入 SDK 依賴，詳見 SDK 準備。

請求參數

targetMsgs 對象說明

StrategyContent 欄位說明

JSON 格式轉化為 String 傳值。

返回參數

程式碼範例

請確保您的 AccessKey 擁有 AliyunMPAASFullAccess 許可權，詳情請參考 對 RAM 帳號進行應用層級的存取控制。

Java 程式碼範例

單擊此處 查看下方程式碼範例中 AccessKeyId 與 AccessKeySecret 的擷取方式。

 DefaultProfile.addEndpoint("cn-hangzhou", "mpaas", "mpaas.cn-hangzhou.aliyuncs.com");
        // 建立 DefaultAcsClient 執行個體並初始化
        // 阿里雲帳號 AccessKey 擁有所有 API 的存取權限，風險很高。強烈建議您建立並使用 RAM 使用者進行 API 訪問或日常營運，請登入 RAM 控制台建立 RAM 使用者
        // 此處以把 AccessKey 和 AccessKeySecret 儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡
        // 強烈建議不要把 AccessKey 和 AccessKeySecret 儲存到代碼裡，會存在密鑰泄漏風險
        // 建議先完成環境變數配置。
        String accessKeyId = System.getenv("MPAAS_AK_ENV");
        String accessKeySecret = System.getenv("MPAAS_SK_ENV");
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // 地區 ID
            accessKeyId,      
            accessKeySecret); 

        IAcsClient client = new DefaultAcsClient(profile);
        // Create an API request and set parameters
        PushMultipleRequest request = new PushMultipleRequest();
        request.setAppId("ONEX570DA89211721");
        request.setWorkspaceId("test");
        request.setDeliveryType(3L);
        request.setTaskName("批量測試");
        request.setTemplateName("測試模板");
        //你好#name#,恭喜中獎#money#元
        List<PushMultipleRequest.TargetMsg> targetMsgs = new ArrayList<PushMultipleRequest.TargetMsg>();
        PushMultipleRequest.TargetMsg targetMsg = new PushMultipleRequest.TargetMsg();
        targetMsg.setTarget("userid1024");
        targetMsg.setMsgKey(String.valueOf(System.currentTimeMillis()));
        Map<String, String> templatekv = new HashMap<String, String>();
        templatekv.put("name", "張三");
        templatekv.put("money", "200");
        targetMsg.setTemplateKeyValue(JSON.toJSONString(templatekv));
        //目標數量不要超過 100 個
        targetMsgs.add(targetMsg);
        request.setTargetMsgs(targetMsgs);
        request.setExpiredSeconds(600L);

        request.setStrategyType(2);
        request.setStrategyContent("{\"fixedTime\":1630303126000,\"startTime\":1625673600000,\"endTime\":1630303126000,\"circleType\":1,\"circleValue\":[1, 7],\"time\":\"13:45:11\"}");

        PushMultipleResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
            System.out.println(response.getPushResult().getData());  // 推送任務 ID 或定時推送任務 ID
        } catch (ClientException e) {
            e.printStackTrace();
        }

Python 程式碼範例

# -*- coding: utf8 -*-

from aliyunsdkcore.client import AcsClient
from aliyunsdkmpaas.request.v20190821 import PushMultipleRequest
import json
import time

// 阿里雲帳號 AccessKey 擁有所有 API 的存取權限，風險很高。強烈建議您建立並使用 RAM 使用者進行 API 訪問或日常營運，請登入 RAM 控制台建立 RAM 使用者
// 此處以把 AccessKey 和 AccessKeySecret 儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡
// 強烈建議不要把 AccessKey 和 AccessKeySecret 儲存到代碼裡，會存在密鑰泄漏風險
// 建議先完成環境變數配置
# Initialize AcsClient instance
String accessKeyId = System.getenv("MPAAS_AK_ENV");
String accessKeySecret = System.getenv("MPAAS_SK_ENV");
client = AcsClient(
accessKeyId,      
accessKeySecret,  
"cn-hangzhou"
);

# Initialize a request and set parameters
request = PushMultipleRequest.PushMultipleRequest()
request.set_endpoint("mpaas.cn-hangzhou.aliyuncs.com")
request.set_AppId("ONEX570DA89211721")
request.set_WorkspaceId("test")
request.set_TemplateName("template1024")
request.set_DeliveryType(3)
request.set_TaskName("python測試工作")
request.set_ExpiredSeconds(600)
msgkey = str(time.time())
targets = [
  {
    "Target": "user1024",
    "MsgKey": msgkey,
    "TemplateKeyValue": {
      "name": "張三",
      "money": "200"
    }
  }
]
request.set_TargetMsgs(targets)
# Print response
response = client.do_action_with_exception(request)
print response

Node.js 程式碼範例

const sdk = require('@alicloud/mpaas20190821');

const { default: Client, PushMultipleRequest,PushMultipleRequestTargetMsg } = sdk;
// 建立用戶端
// 阿里雲帳號 AccessKey 擁有所有 API 的存取權限，風險很高。強烈建議您建立並使用 RAM 使用者進行 API 訪問或日常營運，請登入 RAM 控制台建立 RAM 使用者
// 此處以把 AccessKey 和 AccessKeySecret 儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡
// 強烈建議不要把 AccessKey 和 AccessKeySecret 儲存到代碼裡，會存在密鑰泄漏風險
// 建議先完成環境變數配置
String accessKeyId = System.getenv("MPAAS_AK_ENV");
String accessKeySecret = System.getenv("MPAAS_SK_ENV");
const client = new Client({
  accessKeyId,      
  accessKeySecret, 
  endpoint: 'mpaas.cn-hangzhou.aliyuncs.com',
  apiVersion: '2019-08-21'
});
// 初始化 request
  const request = new PushMultipleRequest();
  request.appId = "ONEX570DA89211721";
  request.workspaceId = "test";
  request.templateName= "template1024";
  const templatekv = {
    name: '張三',
    money:'300'
  };
  //request.templateKeyValue = JSON.stringify(templatekv);

  request.deliveryType = 3;
  request.taskName = "Node 測試工作";
  request.expiredSeconds=600;
  const extendedParam = {
    test: '自訂擴充參數'
  };
  request.extendedParams = JSON.stringify(extendedParam);

  const targetMsgkey = new PushMultipleRequestTargetMsg();
  targetMsgkey.target = "userid1024";
  targetMsgkey.msgKey = String(new Date().valueOf());
  targetMsgkey.templateKeyValue = JSON.stringify(templatekv);;
  request.targetMsg = [targetMsgkey];

// 調用 API
try {
  client.pushMultiple(request).then(res => {
    console.log('SUCCESS', res);
  }).catch(e => {
    console.log('FAIL', e);
  });
} catch(e) {
  console.log('ERROR', e);
}

PHP 程式碼範例

<?php

use AlibabaCloud\Client\AlibabaCloud;
use AlibabaCloud\MPaaS\MPaaS;
AlibabaCloud::accessKeyClient('accessKeyId', 'accessKeySecret')
    ->regionId('cn-hangzhou')
    ->asDefaultClient();

class Demo {
    public function run() {
        try {
              $this->multiPush();
        } catch (\Exception $e) {
        }
    }


   public function multiPush() {
        $request = MPaaS::v20190821()->pushMultiple();
        $result = $request->host("mpaas.cn-hangzhou.aliyuncs.com")
            // 是否開啟 debug 模式
            ->debug(true)
            ->withAppId("ONEX570DA89211721")
            ->withWorkspaceId("test")
            ->withTemplateName("template1024")
            ->withDeliveryType(3)
            ->withTaskName("PHP測試批量任務")
            ->withExpiredSeconds(600)
            ->withTargetMsg(
                [
                    [
                        "Target" => "userid1024",
                        "MsgKey" => "" . time(),
                        "TemplateKeyValue" => json_encode([
                            "name" => "張三",
                            "money" => "200",
                        ])
                    ]
                ]
            )
            ->request();
    }
}

群發推送

對全網裝置推送相同訊息，訊息通過模板建立。

在調用本介面之前，確保已完成以下操作：

• 在訊息推送控制台上建立好目標模板，並確保模板中存在預留位置，否則將無法實現訊息的個人化推送（即對不同推送 ID 推送不同訊息）。詳細操作參見 建立模板。

• 引入 SDK 依賴，詳見 SDK 準備。

請求參數

StrategyContent 欄位說明

JSON 格式轉化為 String 傳值。

返回參數

程式碼範例

請確保您的 AccessKey 擁有 AliyunMPAASFullAccess 許可權，詳情請參考 對 RAM 帳號進行應用層級的存取控制。

Java 程式碼範例

單擊此處 查看下方程式碼範例中 AccessKeyId 與 AccessKeySecret 的擷取方式 。

DefaultProfile.addEndpoint("cn-hangzhou", "mpaas", "mpaas.cn-hangzhou.aliyuncs.com");
        // 建立 DefaultAcsClient 執行個體並初始化
        // 阿里雲帳號 AccessKey 擁有所有 API 的存取權限，風險很高。強烈建議您建立並使用 RAM 使用者進行 API 訪問或日常營運，請登入 RAM 控制台建立 RAM 使用者
        // 此處以把 AccessKey 和 AccessKeySecret 儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡
        // 強烈建議不要把 AccessKey 和 AccessKeySecret 儲存到代碼裡，會存在密鑰泄漏風險
        // 建議先完成環境變數配置
        String accessKeyId = System.getenv("MPAAS_AK_ENV");
        String accessKeySecret = System.getenv("MPAAS_SK_ENV");
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // 地區 ID
            accessKeyId,      
            accessKeySecret); 

        IAcsClient client = new DefaultAcsClient(profile);

        PushBroadcastRequest request = new PushBroadcastRequest();
        request.setAppId("ONEX570DA89211720");
        request.setWorkspaceId("test");
        request.setDeliveryType(2L);
        request.setMsgkey(String.valueOf(System.currentTimeMillis()));
        request.setExpiredSeconds(600L);
        request.setTaskName("群發任務");
        request.setTemplateName("群發測試");
        //這是一個公告:#content#
        Map<String, String> templatekv = new HashMap<String, String>();
        templatekv.put("content", "公告內容");
        request.setTemplateKeyValue(JSON.toJSONString(templatekv));

        request.setStrategyType(2);
        request.setStrategyContent("{\"fixedTime\":1630303126000,\"startTime\":1625673600000,\"endTime\":1630303126000,\"circleType\":1,\"circleValue\":[1, 7],\"time\":\"13:45:11\"}");    

        PushBroadcastResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
            System.out.println(response.getPushResult().getData());  // 推送任務 ID或定時推送任務 ID
        } catch (ClientException e) {
            e.printStackTrace();
        }

Python 程式碼範例

# -*- coding: utf8 -*-

from aliyunsdkcore.client import AcsClient
from aliyunsdkmpaas.request.v20190821 import PushBroadcastRequest
import json
import time

// 阿里雲帳號 AccessKey 擁有所有 API 的存取權限，風險很高。強烈建議您建立並使用 RAM 使用者進行 API 訪問或日常營運，請登入 RAM 控制台建立 RAM 使用者
// 此處以把 AccessKey 和 AccessKeySecret 儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡
// 強烈建議不要把 AccessKey 和 AccessKeySecret 儲存到代碼裡，會存在密鑰泄漏風險
// 建議先完成環境變數配置
# Initialize AcsClient instance
String accessKeyId = System.getenv("MPAAS_AK_ENV");
String accessKeySecret = System.getenv("MPAAS_SK_ENV");
client = AcsClient(
accessKeyId,      
accessKeySecret, 
"cn-hangzhou"
);

# Initialize a request and set parameters
request = PushBroadcastRequest.PushBroadcastRequest()
request.set_endpoint("mpaas.cn-hangzhou.aliyuncs.com")
request.set_AppId("ONEX570DA89211720")
request.set_WorkspaceId("test")
request.set_TemplateName("broadcastTemplate")
templatekv = {"content":"這個一個公告"}
request.set_TemplateKeyValue(json.dumps(templatekv))
request.set_DeliveryType(1)
request.set_TaskName("python測試群發任務")
request.set_ExpiredSeconds(600)
request.set_Msgkey(str(time.time()))

# Print response
response = client.do_action_with_exception(request)
print response

Node.js 程式碼範例

const sdk = require('@alicloud/mpaas20190821');

const { default: Client, PushBroadcastRequest } = sdk;
// 建立用戶端
// 阿里雲帳號 AccessKey 擁有所有 API 的存取權限，風險很高。強烈建議您建立並使用 RAM 使用者進行 API 訪問或日常營運，請登入 RAM 控制台建立 RAM 使用者
// 此處以把 AccessKey 和 AccessKeySecret 儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡
// 強烈建議不要把 AccessKey 和 AccessKeySecret 儲存到代碼裡，會存在密鑰泄漏風險
// 建議先完成環境變數配置
String accessKeyId = System.getenv("MPAAS_AK_ENV");
String accessKeySecret = System.getenv("MPAAS_SK_ENV");
const client = new Client({
  accessKeyId,      
  accessKeySecret, 
  endpoint: 'mpaas.cn-hangzhou.aliyuncs.com',
  apiVersion: '2019-08-21'
});
// 初始化 request

  const request = new PushBroadcastRequest();
  request.appId = "ONEX570DA89211720";
  request.workspaceId = "test";
  request.templateName= "broadcastTemplate";
  const templatekv = {
    content: '這是公告哦',
  };
  request.templateKeyValue = JSON.stringify(templatekv);
  request.deliveryType = 1;
  request.taskName = "Node測試工作";
  request.expiredSeconds=600;
  const extendedParam = {
    test: '自訂擴充參數'
  };
  request.extendedParams = JSON.stringify(extendedParam);

  request.msgkey = String(new Date().valueOf())

// 調用 API
try {
  client.pushBroadcast(request).then(res => {
    console.log('SUCCESS', res);
  }).catch(e => {
    console.log('FAIL', e);
  });
} catch(e) {
  console.log('ERROR', e);
}

PHP 程式碼範例

<?php

use AlibabaCloud\Client\AlibabaCloud;
use AlibabaCloud\MPaaS\MPaaS;
AlibabaCloud::accessKeyClient('accessKeyId', 'accessKeySecret')
    ->regionId('cn-hangzhou')
    ->asDefaultClient();

class Demo {
    public function run() {
        try {
               $this->broadcastPush();
        } catch (\Exception $e) {
        }
    }


   public function broadcastPush(){
        $request = MPaaS::v20190821()->pushBroadcast();
        $result = $request->host("mpaas.cn-hangzhou.aliyuncs.com")
            // 是否開啟 debug 模式
            ->debug(true)
            ->withAppId("ONEX570DA89211720")
            ->withWorkspaceId("test")
            ->withTemplateName("broadcastTemplate")
            ->withTemplateKeyValue(
                json_encode(["content" => "這是一個公告"])
            )
            ->withDeliveryType(1)
            ->withTaskName("PHP 測試群發任務")
            ->withExpiredSeconds(600)
            ->withMsgkey("". time())
            ->request();
    }
}

訊息撤回

通過極簡推送或模板推送方式推送的訊息可通過訊息 ID 撤回；通過批量推送和群發推送方式推送的訊息可通過任務 ID 撤回。僅支援撤回最近 7 天內的訊息。

通過訊息 ID 撤回

支援撤回通過極簡推送和模板推送發送的訊息。

請求參數

返回參數

使用樣本

DefaultProfile.addEndpoint("cn-hangzhou", "mpaas", "mpaas.cn-hangzhou.aliyuncs.com");
        // 建立 DefaultAcsClient 執行個體並初始化
        // 阿里雲帳號 AccessKey 擁有所有 API 的存取權限，風險很高。強烈建議您建立並使用 RAM 使用者進行 API 訪問或日常營運，請登入 RAM 控制台建立 RAM 使用者
        // 此處以把 AccessKey 和 AccessKeySecret 儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡
        // 強烈建議不要把 AccessKey 和 AccessKeySecret 儲存到代碼裡，會存在密鑰泄漏風險
        // 建議先完成環境變數配置
        String accessKeyId = System.getenv("MPAAS_AK_ENV");
        String accessKeySecret = System.getenv("MPAAS_SK_ENV");
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // 地區 ID
            accessKeyId,      
            accessKeySecret); 

        IAcsClient client = new DefaultAcsClient(profile);        

        RevokePushMessageRequest request = new RevokePushMessageRequest();
        request.setAppId("ONEX570DA89211720");
        request.setWorkspaceId("test");
        request.setMessageId("console_1624516744112");  // 業務方訊息 ID
        request.setTargetId("mpaas_push_demo");         // 目標 ID

        RevokePushMessageResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }

通過任務 ID 撤回

支援撤回通過批量推送和群發推送發送的訊息。

請求參數

返回參數

使用樣本

DefaultProfile.addEndpoint("cn-hangzhou", "mpaas", "mpaas.cn-hangzhou.aliyuncs.com");
        // 建立 DefaultAcsClient 執行個體並初始化
        // 阿里雲帳號 AccessKey 擁有所有 API 的存取權限，風險很高。強烈建議您建立並使用 RAM 使用者進行 API 訪問或日常營運，請登入 RAM 控制台建立 RAM 使用者
        // 此處以把 AccessKey 和 AccessKeySecret 儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡
        // 強烈建議不要把 AccessKey 和 AccessKeySecret 儲存到代碼裡，會存在密鑰泄漏風險
        // 建議先完成環境變數配置
        String accessKeyId = System.getenv("MPAAS_AK_ENV");
        String accessKeySecret = System.getenv("MPAAS_SK_ENV");
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // 地區 ID
            accessKeyId,      
            accessKeySecret); 

        IAcsClient client = new DefaultAcsClient(profile);

        RevokePushTaskRequest request = new RevokePushTaskRequest();
        request.setAppId("ONEX570DA89211720");
        request.setWorkspaceId("test");
        request.setTaskId("20842863");     // 推送任務 ID

        RevokePushTaskResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }

流量分析

查詢統計資料

查詢訊息推送統計資料，包括總推送條數、推送成功數、推送到達數、訊息開啟數、訊息忽略數等資料。

請求參數

返回參數

使用樣本

DefaultProfile.addEndpoint("cn-hangzhou", "mpaas", "mpaas.cn-hangzhou.aliyuncs.com");
        // 建立 DefaultAcsClient 執行個體並初始化
        // 阿里雲帳號 AccessKey 擁有所有 API 的存取權限，風險很高。強烈建議您建立並使用 RAM 使用者進行 API 訪問或日常營運，請登入 RAM 控制台建立 RAM 使用者
        // 此處以把 AccessKey 和 AccessKeySecret 儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡
        // 強烈建議不要把 AccessKey 和 AccessKeySecret 儲存到代碼裡，會存在密鑰泄漏風險
        // 建議先完成環境變數配置
        String accessKeyId = System.getenv("MPAAS_AK_ENV");
        String accessKeySecret = System.getenv("MPAAS_SK_ENV");
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // 地區 ID
            accessKeyId,      
            accessKeySecret); 

        IAcsClient client = new DefaultAcsClient(profile);

        QueryPushAnalysisCoreIndexRequest request = new QueryPushAnalysisCoreIndexRequest();
        request.setAppId("ONEX570DA89211720");
        request.setWorkspaceId("test");
        request.setStartTime(Long.valueOf("1617206400000"));
        request.setEndTime(Long.valueOf("1624982400000"));
        request.setPlatform("ANDROID");
        request.setChannel("ANDROID");
        request.setType("SIMPLE");
        request.setTaskId("20842863");

        QueryPushAnalysisCoreIndexResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }

查詢推送工作清單

查詢通過控制台建立或通過調用 API 觸發的批量推送任務和群發推送任務資訊。

請求參數

返回參數

使用樣本

DefaultProfile.addEndpoint("cn-hangzhou", "mpaas", "mpaas.cn-hangzhou.aliyuncs.com");
        // 建立 DefaultAcsClient 執行個體並初始化
        // 阿里雲帳號 AccessKey 擁有所有 API 的存取權限，風險很高。強烈建議您建立並使用 RAM 使用者進行 API 訪問或日常營運，請登入 RAM 控制台建立 RAM 使用者
        // 此處以把 AccessKey 和 AccessKeySecret 儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡
        // 強烈建議不要把 AccessKey 和 AccessKeySecret 儲存到代碼裡，會存在密鑰泄漏風險
        // 建議先完成環境變數配置
        String accessKeyId = System.getenv("MPAAS_AK_ENV");
        String accessKeySecret = System.getenv("MPAAS_SK_ENV");
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // 地區 ID
            accessKeyId,      
            accessKeySecret); 

        IAcsClient client = new DefaultAcsClient(profile);

        QueryPushAnalysisTaskListRequest request = new QueryPushAnalysisTaskListRequest();
        request.setAppId("ONEX570DA89211721");
        request.setWorkspaceId("default");
        request.setStartTime(Long.valueOf("1617206400000"));
        request.setTaskId("20845212");
        request.setTaskName("測試工作");
        request.setPageNumber(1);
        request.setPageSize(10);

        QueryPushAnalysisTaskListResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }

查詢推送任務詳情

查詢通過控制台建立或通過調用 API 觸發的批量推送任務和群發推送任務的任務詳情。

請求參數

返回參數

使用樣本

DefaultProfile.addEndpoint("cn-hangzhou", "mpaas", "mpaas.cn-hangzhou.aliyuncs.com");
        // 建立 DefaultAcsClient 執行個體並初始化
        // 阿里雲帳號 AccessKey 擁有所有 API 的存取權限，風險很高。強烈建議您建立並使用 RAM 使用者進行 API 訪問或日常營運，請登入 RAM 控制台建立 RAM 使用者
        // 此處以把 AccessKey 和 AccessKeySecret 儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡
        // 強烈建議不要把 AccessKey 和 AccessKeySecret 儲存到代碼裡，會存在密鑰泄漏風險
        // 建議先完成環境變數配置
        String accessKeyId = System.getenv("MPAAS_AK_ENV");
        String accessKeySecret = System.getenv("MPAAS_SK_ENV");
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // 地區 ID
            accessKeyId,      
            accessKeySecret); 

        IAcsClient client = new DefaultAcsClient(profile);

        QueryPushAnalysisTaskDetailRequest request = new QueryPushAnalysisTaskDetailRequest();
        request.setAppId("ONEXPREF4F5C52081557");
        request.setWorkspaceId("default");
        request.setTaskId("20845212");

        QueryPushAnalysisTaskDetailResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }

定時推送任務

查詢定時推送工作清單

查詢已建立的定時推送工作清單，包括定時推送任務和迴圈推送任務。

請求參數

返回參數

使用樣本

DefaultProfile.addEndpoint("cn-hangzhou", "mpaas", "mpaas.cn-hangzhou.aliyuncs.com");
        // 建立 DefaultAcsClient 執行個體並初始化
        // 阿里雲帳號 AccessKey 擁有所有 API 的存取權限，風險很高。強烈建議您建立並使用 RAM 使用者進行 API 訪問或日常營運，請登入 RAM 控制台建立 RAM 使用者
        // 此處以把 AccessKey 和 AccessKeySecret 儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡
        // 強烈建議不要把 AccessKey 和 AccessKeySecret 儲存到代碼裡，會存在密鑰泄漏風險
        // 建議先完成環境變數配置
        String accessKeyId = System.getenv("MPAAS_AK_ENV");
        String accessKeySecret = System.getenv("MPAAS_SK_ENV");
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // 地區 ID
            accessKeyId,      
            accessKeySecret); 
        IAcsClient client = new DefaultAcsClient(profile);

        QueryPushSchedulerListRequest request = new QueryPushSchedulerListRequest();
        request.setAppId("ONEXPREF4F5C52081557");
        request.setWorkspaceId("default");
        request.setStartTime(Long.valueOf("1625068800000"));
        request.setEndTime(Long.valueOf("1630425600000"));
        request.setType(0);
        request.setUniqueId("49ec0ed5a2a642bcbe139a2d7a419d6d");
        request.setPageNumber(1);
        request.setPageSize(10);

        QueryPushSchedulerListResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }

取消定時推送任務

取消未執行的定時推送任務（包括迴圈推送任務），支援批量取消。

請求參數

返回參數

使用樣本

DefaultProfile.addEndpoint("cn-hangzhou", "mpaas", "mpaas.cn-hangzhou.aliyuncs.com");
        // 建立 DefaultAcsClient 執行個體並初始化
        // 阿里雲帳號 AccessKey 擁有所有 API 的存取權限，風險很高。強烈建議您建立並使用 RAM 使用者進行 API 訪問或日常營運，請登入 RAM 控制台建立 RAM 使用者
        // 此處以把 AccessKey 和 AccessKeySecret 儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡
        // 強烈建議不要把 AccessKey 和 AccessKeySecret 儲存到代碼裡，會存在密鑰泄漏風險
        // 建議先完成環境變數配置
        String accessKeyId = System.getenv("MPAAS_AK_ENV");
        String accessKeySecret = System.getenv("MPAAS_SK_ENV");
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // 地區 ID
            accessKeyId,      
            accessKeySecret); 
        IAcsClient client = new DefaultAcsClient(profile);

CancelPushSchedulerRequest request = new CancelPushSchedulerRequest();
        request.setAppId("ONEXPREF4F5C52081557");
        request.setWorkspaceId("default");
        request.setUniqueIds("49ec0ed5a2a642bcbe139a2d7a419d6d, 49ec0ed5a2a642bcbe139a2d7a419d6c");

        CancelPushSchedulerResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }

擴充參數

擴充參數會跟隨訊息體到達用戶端，供使用者自訂處理。

擴充參數包含以下三類：

• 系統擴充參數

  這些擴充參數被系統佔用，注意不要修改此類參數的 value 值。系統擴充參數包括 notifyType、action、silent、pushType、templateCode、channel、taskId。

• 系統具有一定意義的擴充參數

  這些擴充參數被系統佔用，且具有一定的意義，您可以配置此類擴充參數的 value 值。系統具有一定意義的擴充參數及其說明參見下表。

  Key	說明
  sound	自訂鈴聲，參數值配置為鈴聲的路徑，本參數僅對小米和蘋果手機有效。
  badge	應用表徵圖角標，參數值配置為具體數值。本擴充參數會跟隨訊息體到達用戶端。 對於 Android 手機，您需要處理角標的實現邏輯。 對於蘋果手機，手機系統將自動實現角標。訊息推送至目標手機後，應用表徵圖的角標即會顯示為參數值中配置的數值。
  mutable-content	APNs 自訂推送標識，推送的時候攜帶本參數即表示支援 iOS 10 的 UNNotificationServiceExtension；若不攜帶本參數，則為普通推送。參數值配置為 1。
  badge_add_num	華為通道推送角標增加數。
  badge_class	華為通道案頭表徵圖對應的應用入口 Activity 類。
  big_text	大文本樣式，value 固定為 1，填寫其他值無效。本參數僅對小米和華為手機有效。

• 使用者自訂擴充參數

  除了系統擴充參數和系統具有一定意義的擴充參數，其他的參數 key 都屬於使用者擴充參數。使用者自訂擴充參數會隨訊息體中的擴充參數到達用戶端，供使用者自訂處理。

API 呼叫結果碼