Android Push Notification PHP class using Google Cloud Messaging (GCM)

Google cloud Messaging (GCM) is a service that helps developer to send push notification data to any Android devices. With help of this feature developer can send push message to Android device whenever new data or promotion offers arrives in Android application.

Today lots of Android applications using Google cloud Messaging service to send multiple push messages to multiple Android devices. You can find more at it’s official document at https://developers.google.com/cloud-messaging/

Push Notification flow with PHP Web Server APP and GCM

1. Android device send Sender Id and application Id to GCM server.
2. GCM server generates unique registration Id and sends them back to Android device.
3. Android device sends registration Id to PHP web server application.
4. PHP web server stores registration Id to Database for later use.

1. When server needs to send Push Message, It fetch previously stored registration Id from Database
2. And send them to the GCM server along with the push message data.
3. GCM server will send that message to particular Android device using device registration Id

Get Google Cloud messaging API key

First you need to register your application into Google api Console at https://console.developers.google.com/iam-admin/projects

After creating your project find Google Cloud Messaging under Google APIs > Mobile APIs and enabled it.

Now go to Credentials and navigate to Where will you be calling the API from?dropdown and select option, for server we will choose Web server from the dropdown.

Click on Create an API key button that will generate an API key, copy this key and paste it at safe place, we will use this key in our Android push notification PHP class.

Android Push Notification PHP Class

Create a php file called it androidNotification.php and add following code.

1 2 3 4 5 6 7 8 9 10 11 12

class AndroidNotification {       public $google_api_key;     //Google cloud Message url     public $googleGcmUrl = 'https://android.googleapis.com/gcm/send';        // constructor     function __construct() {         $this->google_api_key = "GOOGLE_API_KEY";     }   }

Copy the Google API key which we have just created in above step, and paste it where I mentioned GOOGLE_API_KEY. This key is authorizing our Class to send a message to Google Cloud server, and instantly cloud server sent it to Android device as Push messages.

Add following Public function to the class.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33

public function sendNotificationAndroid($registatoinIds, $data = array()) {     // prep the bundle         $msgarray = array         (             'message' => !empty($data["message"]) ? $data["message"] : "",                 'tag' => !empty($data["tag"]) ? $data["tag"] : "",         );           $fields = array         (             'registration_ids' => $registatoinIds,             'data' => $msgarray         );           $headers = array             (             'Authorization: key=' . $this->google_api_key,             'Content-Type: application/json'         );           $ch = curl_init();         curl_setopt($ch, CURLOPT_URL, $this->googleGcmUrl);         curl_setopt($ch, CURLOPT_POST, true);         curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);         curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);         curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);         curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($fields));         $result = curl_exec($ch);         curl_close($ch);           return $result;     }

This function is responsible to send notification message to Google’s GCM server url with Android device registration id via curl, (Note: we need Android device registration id from Android phone).

Wrapping up whole Class file

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50

class AndroidNotification {       public $google_api_key;     //Google cloud Message url     public $googleGcmUrl = 'https://android.googleapis.com/gcm/send';        // constructor     function __construct() {         $this->google_api_key = "GOOGLE_API_KEY";     }       /**      * Sending Push Notification      */        public function sendNotificationAndroid($registatoinIds, $data = array()) {     // prep the bundle         $msgarray = array         (             'message' => !empty($data["message"]) ? $data["message"] : "",                 'tag' => !empty($data["tag"]) ? $data["tag"] : "",         );           $fields = array         (             'registration_ids' => $registatoinIds,             'data' => $msgarray         );           $headers = array             (             'Authorization: key=' . $this->google_api_key,             'Content-Type: application/json'         );           $ch = curl_init();         curl_setopt($ch, CURLOPT_URL, $this->googleGcmUrl);         curl_setopt($ch, CURLOPT_POST, true);         curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);         curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);         curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);         curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($fields));         $result = curl_exec($ch);         curl_close($ch);           return $result;     }   }

Push Notification Call

Include the above Android Notification Class to the file from where you want to call notification.

include_once 'androidNotification.php';

Call the notification class and add your device registration id where I wrote YOUR_DEVICE_REGISTRATION_ID .

1 2 3 4 5

$sendAndroidPush = new AndroidNotification(); //Device registration id $registatoinId = "YOUR_DEVICE_REGISTRATION_ID"; $data = array("message" => "Hello Android"); $result = $sendAndroidPush->sendNotificationAndroid(array($registatoinId), $data);

You can send one message to multiple devices with this class, you just need to pass your device registration ids array like

$result = $sendAndroidPush->sendNotificationAndroid(array($registatoinId, $registatoinId2, $registatoinId3,… and so on, $data);

Wrapping notification call

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

//Android(GCM) Push notification call //Include Android push notification class include_once 'androidNotification.php'; $sendAndroidPush = new AndroidNotification(); //Device registration id $registatoinId = "YOUR_DEVICE_REGISTRATION_ID"; $data = array("message" => "Hello Android"); $result = $sendAndroidPush->sendNotificationAndroid(array($registatoinId), $data); $result_json_decode = json_decode(trim($result), true); if ($result_json_decode["success"] == 1)     {          echo "Push Message send";     } else {        echo "Opps! Something went wrong!";     }

Download: android-push-notitication-with-php

Conclusion

You can download complete Push Notification PHP class from above Link, remember you still need android device registration id to send your message. Let me know your thoughts in comment below.