Push

Send push

Use this method to send mobile push notifications.

POSThttps://api.messageflow.com/v2.1/push

Body

application/json

applications*array of string

The id of applications to which we want to send push notification.

to*array of PushToObject (object)

Push notification receivers

title*object

The push title that can be translated into multiple languages. Property name can have 2 characters maximum and property value maximum of 50 characters.

body*object

The push body that can be translated into multiple languages. Property name can have 2 characters maximum and property value maximum of 400 characters.

defaultLanguage*string

The default language for translating push in Unicode language identifier representation.

Example: "pl"

imagestring

The absolute URL of image. Image requirements:

Android:

aspect ratio 2/1
format JPG PNG GIF
dimensions:
min 512x256
balanced 1044x720
max 2088x1440

iOS

size < 10MB
format JPG PNG GIF
dimensions max 2436x2436

Example: "http://absolute.url/to/image"

silentboolean

Should notification be silent or not.

soundstring

The push sound. Use resource name or ‘DEAFULT’ string

Example: "sound-file.wav"

scheduleTimestring

The date the Push will be set off.

Example: "2020-01-01 12:12:12"

Pattern: /^\d{4}-\d{2}-\d{2}\s*(?:\d{2}:\d{2}(?::\d{2})?)?$/

ttlnumber

The unix timestamp parameter specifying the maximum lifetime of notification. Must be in future. The push service will try to deliver the notification to the receiver until the specified day.

Example: 1540377351

externalDataobject

The additional key/value pair you can add to the push notification. Property name can contain max of 50 signs

advancedobject

The advanced options for push notification.

actionobject

Action that should be executed after push click

actionButtonsarray of actionButton (object)

Two buttons for push notification. Each button can have different action.

Response

200401404500

Request was successfully processed

Body

application/json

metaMetaObject (object)

Additional data

dataarray of PushResponseObject (object)

Response

200401404500

{
  "meta": {
    "numberOfErrors": 0,
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  },
  "data": [
    {
      "receiver": "example-device-id",
      "externalId": "xxx-xxx-xxx-xxx",
      "type": 1
    }
  ]
}

C#

var client = new RestClient("https://api.messageflow.com/v2.1/push");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"applications\":[\"XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\"],\"to\":[{\"receiver\":\"example-device-id\",\"externalId\":\"xxx-xxx-xxx-xxx\",\"type\":1}],\"title\":{\"pl\":\"test\",\"en\":\"test\"},\"body\":{\"pl\":\"test\",\"en\":\"test\"},\"defaultLanguage\":\"pl\",\"image\":\"http://absolute.url/to/image\",\"silent\":false,\"sound\":\"sound-file.wav\",\"scheduleTime\":\"2020-01-01 12:12:12\",\"ttl\":1540377351,\"externalData\":{\"test\":\"x\",\"test1\":false},\"advanced\":{\"subtitle\":\"subtitle-only-ios\",\"lockscreenVisibility\":1,\"icon\":{\"small\":\"/relative-icon-file-path\",\"large\":\"/relative-icon-file-path\"}},\"action\":{\"url\":\"http://absolute.url/to/redirect/on/click\",\"type\":2},\"actionButtons\":[{\"button\":1,\"icon\":\"my_icon.png\",\"action\":{\"url\":\"www.google.pl\",\"type\":1}}]}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Go

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.messageflow.com/v2.1/push"

	payload := strings.NewReader("{\"applications\":[\"XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\"],\"to\":[{\"receiver\":\"example-device-id\",\"externalId\":\"xxx-xxx-xxx-xxx\",\"type\":1}],\"title\":{\"pl\":\"test\",\"en\":\"test\"},\"body\":{\"pl\":\"test\",\"en\":\"test\"},\"defaultLanguage\":\"pl\",\"image\":\"http://absolute.url/to/image\",\"silent\":false,\"sound\":\"sound-file.wav\",\"scheduleTime\":\"2020-01-01 12:12:12\",\"ttl\":1540377351,\"externalData\":{\"test\":\"x\",\"test1\":false},\"advanced\":{\"subtitle\":\"subtitle-only-ios\",\"lockscreenVisibility\":1,\"icon\":{\"small\":\"/relative-icon-file-path\",\"large\":\"/relative-icon-file-path\"}},\"action\":{\"url\":\"http://absolute.url/to/redirect/on/click\",\"type\":2},\"actionButtons\":[{\"button\":1,\"icon\":\"my_icon.png\",\"action\":{\"url\":\"www.google.pl\",\"type\":1}}]}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "REPLACE_KEY_VALUE")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Java

HttpResponse<String> response = Unirest.post("https://api.messageflow.com/v2.1/push")
  .header("content-type", "application/json")
  .header("authorization", "REPLACE_KEY_VALUE")
  .body("{\"applications\":[\"XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\"],\"to\":[{\"receiver\":\"example-device-id\",\"externalId\":\"xxx-xxx-xxx-xxx\",\"type\":1}],\"title\":{\"pl\":\"test\",\"en\":\"test\"},\"body\":{\"pl\":\"test\",\"en\":\"test\"},\"defaultLanguage\":\"pl\",\"image\":\"http://absolute.url/to/image\",\"silent\":false,\"sound\":\"sound-file.wav\",\"scheduleTime\":\"2020-01-01 12:12:12\",\"ttl\":1540377351,\"externalData\":{\"test\":\"x\",\"test1\":false},\"advanced\":{\"subtitle\":\"subtitle-only-ios\",\"lockscreenVisibility\":1,\"icon\":{\"small\":\"/relative-icon-file-path\",\"large\":\"/relative-icon-file-path\"}},\"action\":{\"url\":\"http://absolute.url/to/redirect/on/click\",\"type\":2},\"actionButtons\":[{\"button\":1,\"icon\":\"my_icon.png\",\"action\":{\"url\":\"www.google.pl\",\"type\":1}}]}")
  .asString();

Node

var request = require("request");

var options = {
  method: 'POST',
  url: 'https://api.messageflow.com/v2.1/push',
  headers: {'content-type': 'application/json', authorization: 'REPLACE_KEY_VALUE'},
  body: {
    applications: ['XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'],
    to: [{receiver: 'example-device-id', externalId: 'xxx-xxx-xxx-xxx', type: 1}],
    title: {pl: 'test', en: 'test'},
    body: {pl: 'test', en: 'test'},
    defaultLanguage: 'pl',
    image: 'http://absolute.url/to/image',
    silent: false,
    sound: 'sound-file.wav',
    scheduleTime: '2020-01-01 12:12:12',
    ttl: 1540377351,
    externalData: {test: 'x', test1: false},
    advanced: {
      subtitle: 'subtitle-only-ios',
      lockscreenVisibility: 1,
      icon: {small: '/relative-icon-file-path', large: '/relative-icon-file-path'}
    },
    action: {url: 'http://absolute.url/to/redirect/on/click', type: 2},
    actionButtons: [{button: 1, icon: 'my_icon.png', action: {url: 'www.google.pl', type: 1}}]
  },
  json: true
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.messageflow.com/v2.1/push",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"applications\":[\"XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\"],\"to\":[{\"receiver\":\"example-device-id\",\"externalId\":\"xxx-xxx-xxx-xxx\",\"type\":1}],\"title\":{\"pl\":\"test\",\"en\":\"test\"},\"body\":{\"pl\":\"test\",\"en\":\"test\"},\"defaultLanguage\":\"pl\",\"image\":\"http://absolute.url/to/image\",\"silent\":false,\"sound\":\"sound-file.wav\",\"scheduleTime\":\"2020-01-01 12:12:12\",\"ttl\":1540377351,\"externalData\":{\"test\":\"x\",\"test1\":false},\"advanced\":{\"subtitle\":\"subtitle-only-ios\",\"lockscreenVisibility\":1,\"icon\":{\"small\":\"/relative-icon-file-path\",\"large\":\"/relative-icon-file-path\"}},\"action\":{\"url\":\"http://absolute.url/to/redirect/on/click\",\"type\":2},\"actionButtons\":[{\"button\":1,\"icon\":\"my_icon.png\",\"action\":{\"url\":\"www.google.pl\",\"type\":1}}]}",
  CURLOPT_HTTPHEADER => array(
    "authorization: REPLACE_KEY_VALUE",
    "content-type: application/json"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://api.messageflow.com/v2.1/push"

payload = "{\"applications\":[\"XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\"],\"to\":[{\"receiver\":\"example-device-id\",\"externalId\":\"xxx-xxx-xxx-xxx\",\"type\":1}],\"title\":{\"pl\":\"test\",\"en\":\"test\"},\"body\":{\"pl\":\"test\",\"en\":\"test\"},\"defaultLanguage\":\"pl\",\"image\":\"http://absolute.url/to/image\",\"silent\":false,\"sound\":\"sound-file.wav\",\"scheduleTime\":\"2020-01-01 12:12:12\",\"ttl\":1540377351,\"externalData\":{\"test\":\"x\",\"test1\":false},\"advanced\":{\"subtitle\":\"subtitle-only-ios\",\"lockscreenVisibility\":1,\"icon\":{\"small\":\"/relative-icon-file-path\",\"large\":\"/relative-icon-file-path\"}},\"action\":{\"url\":\"http://absolute.url/to/redirect/on/click\",\"type\":2},\"actionButtons\":[{\"button\":1,\"icon\":\"my_icon.png\",\"action\":{\"url\":\"www.google.pl\",\"type\":1}}]}"
headers = {
    'content-type': "application/json",
    'authorization': "REPLACE_KEY_VALUE"
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.messageflow.com/v2.1/push")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request["authorization"] = 'REPLACE_KEY_VALUE'
request.body = "{\"applications\":[\"XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\"],\"to\":[{\"receiver\":\"example-device-id\",\"externalId\":\"xxx-xxx-xxx-xxx\",\"type\":1}],\"title\":{\"pl\":\"test\",\"en\":\"test\"},\"body\":{\"pl\":\"test\",\"en\":\"test\"},\"defaultLanguage\":\"pl\",\"image\":\"http://absolute.url/to/image\",\"silent\":false,\"sound\":\"sound-file.wav\",\"scheduleTime\":\"2020-01-01 12:12:12\",\"ttl\":1540377351,\"externalData\":{\"test\":\"x\",\"test1\":false},\"advanced\":{\"subtitle\":\"subtitle-only-ios\",\"lockscreenVisibility\":1,\"icon\":{\"small\":\"/relative-icon-file-path\",\"large\":\"/relative-icon-file-path\"}},\"action\":{\"url\":\"http://absolute.url/to/redirect/on/click\",\"type\":2},\"actionButtons\":[{\"button\":1,\"icon\":\"my_icon.png\",\"action\":{\"url\":\"www.google.pl\",\"type\":1}}]}"

response = http.request(request)
puts response.read_body

Shell

echo '{"applications":["XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"],"to":[{"receiver":"example-device-id","externalId":"xxx-xxx-xxx-xxx","type":1}],"title":{"pl":"test","en":"test"},"body":{"pl":"test","en":"test"},"defaultLanguage":"pl","image":"http://absolute.url/to/image","silent":false,"sound":"sound-file.wav","scheduleTime":"2020-01-01 12:12:12","ttl":1540377351,"externalData":{"test":"x","test1":false},"advanced":{"subtitle":"subtitle-only-ios","lockscreenVisibility":1,"icon":{"small":"/relative-icon-file-path","large":"/relative-icon-file-path"}},"action":{"url":"http://absolute.url/to/redirect/on/click","type":2},"actionButtons":[{"button":1,"icon":"my_icon.png","action":{"url":"www.google.pl","type":1}}]}' |  \
  http POST https://api.messageflow.com/v2.1/push \
  authorization:REPLACE_KEY_VALUE \
  content-type:application/jsonction":{"url":"www.google.pl","type":1}}]}'