SendSimple

This operation sends a simple message to multiple user targets.

Results

Name	Description
estimatedTargets	Estimate number of targeted users.

Service	Operation
pushNotification	SEND_SIMPLE

Method Parameters

Parameter	Description
message	The content of the message.
segmentCodeList	List of target segment codes. Omit to send to all users.
segmentIdList	Deprecated: list of target segment ids. Use segmentCodeList instead.

warning

segmentIdList is deprecated. Use segmentCodeList instead. Segment ids are assigned separately in each environment, so the same id can refer to a different segment after an app is copied or promoted, and new apps reject segment ids in cloud code.

Usage

http://localhost:3000

C#

// S2S call: to view example, switch to the Cloud Code or Raw tab.

C++

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Obj-C

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Java

// S2S call: to view example, switch to the Cloud Code or Raw tab.

JavaScript

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Dart

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Roblox

-- N/A

GDScript

N/A

Lua

-- S2S call: to view example, switch to the Cloud Code or Raw tab.

Cloud Code

var message = "Hello World";
var segments = [
    "high_spenders",
    "lapsed_30d"
];
var pushNotificationProxy = bridge.getPushNotificationServiceProxy();

var postResult = pushNotificationProxy.sendSimplePushNotification(message, segments);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "pushNotification",
    "operation": "SEND_SIMPLE",
    "data": {
        "message": "Hello World",
        "segmentCodeList": [
            "high_spenders",
            "lapsed_30d"
        ]
    }
}

JSON Response

{
    "packetId": 1,
    "messageResponses": [
        {
            "data": {
                "estimatedTargets": 1234
            },
            "status": 200
        }
    ]
}