Mobile Platform as a Service:Broadcast Push

Push the same message to all devices across the network using a template.

Before using this API, ensure the following tasks are completed:

• Create the target template in the message push console, including placeholders, to enable personalized message pushes. For more information, see Create Template.

• Add SDK dependencies. For more information, see SDK Preparation.

Request Parameters

StrategyContent Field Description

Convert JSON format to a String to pass values.

Response Parameters

Code Examples

Ensure your AccessKey has AliyunMPAASFullAccess permission. For details, see Application-Level Access Control for RAM Accounts.

Java Code Example

Click here to see how to retrieve AccessKeyId and AccessKeySecret in the code example below.

DefaultProfile.addEndpoint("cn-hangzhou", "mpaas", "mpaas.cn-hangzhou.aliyuncs.com");
        // Create DefaultAcsClient instance and initialize
        // Alibaba Cloud account AccessKey has access to all APIs, which is highly risky. We strongly recommend that you create and use a RAM user for API access or daily operations. Please log on to the RAM console to create a RAM user
        // Here, saving AccessKey and AccessKeySecret in environment variables is used as an example. You can also save them in the configuration file based on your business needs
        // We strongly recommend that you do not save AccessKey and AccessKeySecret in the code, as there is a risk of key leakage
        // It is recommended to complete the environment variable configuration first
        String accessKeyId = System.getenv("MPAAS_AK_ENV");
        String accessKeySecret = System.getenv("MPAAS_SK_ENV");
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // Region 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("Broadcast Task");
        request.setTemplateName("Broadcast Test");
        // This is an announcement: #content#
        Map<String, String> templatekv = new HashMap<String, String>();
        templatekv.put("content", "Announcement 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());  // Push task ID or scheduled push task ID
        } catch (ClientException e) {
            e.printStackTrace();
        }

Python Code Example

# -*- coding: utf8 -*-

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

// Alibaba Cloud account AccessKey has access to all APIs, which is highly risky. We strongly recommend that you create and use a RAM user for API access or daily operations. Please log on to the RAM console to create a RAM user
// Here, saving AccessKey and AccessKeySecret in environment variables is used as an example. You can also save them in the configuration file based on your business needs
// We strongly recommend that you do not save AccessKey and AccessKeySecret in the code, as there is a risk of key leakage
// It is recommended to complete the environment variable configuration first
# 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":"This is an announcement"}
request.set_TemplateKeyValue(json.dumps(templatekv))
request.set_DeliveryType(1)
request.set_TaskName("Python Test Broadcast Task")
request.set_ExpiredSeconds(600)
request.set_Msgkey(str(time.time()))

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

Node.js Code Example

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

const { default: Client, PushBroadcastRequest } = sdk;
// Create client
// Alibaba Cloud account AccessKey has access to all APIs, which is highly risky. We strongly recommend that you create and use a RAM user for API access or daily operations. Please log on to the RAM console to create a RAM user
// Here, saving AccessKey and AccessKeySecret in environment variables is used as an example. You can also save them in the configuration file based on your business needs
// We strongly recommend that you do not save AccessKey and AccessKeySecret in the code, as there is a risk of key leakage
// It is recommended to complete the environment variable configuration first
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'
});
// Initialize request

  const request = new PushBroadcastRequest();
  request.appId = "ONEX570DA89211720";
  request.workspaceId = "test";
  request.templateName= "broadcastTemplate";
  const templatekv = {
    content: 'This is an announcement',
  };
  request.templateKeyValue = JSON.stringify(templatekv);
  request.deliveryType = 1;
  request.taskName = "Node Test Task";
  request.expiredSeconds=600;
  const extendedParam = {
    test: 'Custom extended parameter'
  };
  request.extendedParams = JSON.stringify(extendedParam);

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

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

PHP Code Example

<?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")
            // Enable debug mode
            ->debug(true)
            ->withAppId("ONEX570DA89211720")
            ->withWorkspaceId("test")
            ->withTemplateName("broadcastTemplate")
            ->withTemplateKeyValue(
                json_encode(["content" => "This is an announcement"])
            )
            ->withDeliveryType(1)
            ->withTaskName("PHP Test Broadcast Task")
            ->withExpiredSeconds(600)
            ->withMsgkey("". time())
            ->request();
    }
}