a Node.JS wrapper library-port for Google Cloud Messaging for Android


node-gcm is a Node.JS library for Google Cloud Messaging.

$ npm install node-gcm

This library provides the server-side implementation of GCM. You need to generate an API key (Sender ID).

GCM notifications can be sent to both Android and iOS. If you are new to GCM you should probably look into the documentation.

According to below Usage reference, we could create such application:

var gcm = require('node-gcm');
var message = new gcm.Message();
message.addData('key1', 'msg1');
var regTokens = ['YOUR_REG_TOKEN_HERE'];
// Set up the sender with you API key 
var sender = new gcm.Sender('YOUR_API_KEY_HERE');
// Now the sender can be used to send messages 
sender.send(message, { registrationTokens: regTokens }, function (errresponse) {
    if(err) console.error(err);
    else    console.log(response);
// Send to a topic, with no retry this time 
sender.sendNoRetry(message, { topic: '/topics/global' }, function (errresponse) {
    if(err) console.error(err);
    else    console.log(response);
var gcm = require('node-gcm');
// Create a message 
// ... with default values 
var message = new gcm.Message();
// ... or some given values 
var message = new gcm.Message({
    collapseKey: 'demo',
    priority: 'high',
    contentAvailable: true,
    delayWhileIdle: true,
    timeToLive: 3,
    restrictedPackageName: "somePackageName",
    dryRun: true,
    data: {
        key1: 'message1',
        key2: 'message2'
    notification: {
        title: "Hello, World",
        icon: "ic_launcher",
        body: "This is a notification that will be displayed ASAP."
// Change the message data 
// ... as key-value 
// ... or as a data object (overwrites previous data object) 
    key1: 'message1',
    key2: 'message2'
// Set up the sender with you API key 
var sender = new gcm.Sender('insert Google Server API Key here');
// Add the registration tokens of the devices you want to send to 
var registrationTokens = [];
// Send the message 
// ... trying only once 
sender.sendNoRetry(message, { registrationTokens: registrationTokens }, function(errresponse) {
  if(err) console.error(err);
  else    console.log(response);
// ... or retrying 
sender.send(message, { registrationTokens: registrationTokens }, function (errresponse) {
  if(err) console.error(err);
  else    console.log(response);
// ... or retrying a specific number of times (10) 
sender.send(message, { registrationTokens: registrationTokens }, 10, function (errresponse) {
  if(err) console.error(err);
  else    console.log(response);

Notice that you can at most send notifications to 1000 registration tokens at a time. This is due to a restriction on the side of the GCM API.

var message = new gcm.Message();
// Add notification payload as key value 
message.addNotification('title', 'Alert!!!');
message.addNotification('body', 'Abnormal data access');
message.addNotification('icon', 'ic_launcher');
// as object 
  title: 'Alert!!!',
  body: 'Abnormal data access',
  icon: 'ic_launcher'
titleAndroid, iOS (Watch)Required (Android), Optional (iOS), stringIndicates notification title. This field is not visible on iOS phones and tablets.
bodyAndroid, iOSOptional, stringIndicates notification body text.
iconAndroidRequired, stringIndicates notification icon. On Android: sets value to myicon for drawable resource myicon.png.
soundAndroid, iOSOptional, stringIndicates sound to be played. Supports only default currently.
badgeiOSOptional, stringIndicates the badge on client app home icon.
tagAndroidOptional, stringIndicates whether each notification message results in a new entry on the notification center on Android. If not set, each request creates a new notification. If set, and a notification with the same tag is already being shown, the new notification replaces the existing one in notification center.
colorAndroidOptional, stringIndicates color of the icon, expressed in #rrggbb format
click_actionAndroid, iOSOptional, stringThe action associated with a user click on the notification. On Android, if this is set, an activity with a matching intent filter is launched when user clicks the notification. For example, if one of your Activities includes the intent filter: (Appendix:1)Set click_action to OPEN_ACTIVITY_1 to open it. If set, corresponds to category in APNS payload.
body_loc_keyiOSOptional, stringIndicates the key to the body string for localization. On iOS, this corresponds to "loc-key" in APNS payload.
body_loc_argsiOSOptional, JSON array as stringIndicates the string value to replace format specifiers in body string for localization. On iOS, this corresponds to "loc-args" in APNS payload.
title_loc_argsiOSOptional, JSON array as stringIndicates the string value to replace format specifiers in title string for localization. On iOS, this corresponds to "title-loc-args" in APNS payload.
title_loc_keyiOSOptional, stringIndicates the key to the title string for localization. On iOS, this corresponds to "title-loc-key" in APNS payload.

Notice notification payload defined in GCM Connection Server Reference

You can provide custom request options such as proxy and timeout for the GCM request. For more information, refer to the complete list of request options. Note that the following options cannot be overriden: method, uri, body, as well as the following headers: Authorization, Content-Type, and Content-Length.

// Set custom request options 
var requestOptions = {
    proxy: '',
    timeout: 5000
// Set up the sender with your API key and request options 
var sender = new gcm.Sender('YOUR_API_KEY_HERE', requestOptions);
// Prepare a GCM message... 
// Send it to GCM endpoint with modified request options 
sender.send(message, { registrationTokens: regTokens }, function (errresponse) {
    if(err) console.error(err);
    else     console.log(response);

To enable debug mode (print requests and responses to and from GCM), set the DEBUG environment flag when running your app (assuming you use node app.js to run your app):

DEBUG=node-gcm node app.js

Bitcoin: 13iTQf7tDhrKgibw2Y3U5SyPJa7R8sQmHQ