GCM with PHP Google Cloud Messaging

Question

Update  GCM is deprecated  use FCM   How can I integrate the new Google Cloud Messaging in a PHP backend

User · Answer

You can use this PHP library available on packagist:

After installing it you can do this:

$gcmClient = new GcmClient('your-gcm-api-key-here');

$message = new Message($gcmClient);

$message->addRegistrationId('xxxxxxxxxx');
$message->setData([
    'title' => 'Sample Push Notification',
    'message' => 'This is a test push notification using Google Cloud Messaging'
]);

try {

    $response = $message->send();

    // The send() method returns a Response object
    print_r($response);

} catch (Exception $exception) {

    echo 'uh-oh: ' . $exception->getMessage();

}

User · Answer

This code will send a GCM message to multiple registration IDs via PHP CURL       Payload data you want to send to Android device s      it will be accessible via intent extras       data   array  message    gt   Hello World         The recipient registration tokens for this notification    https   developer android com google gcm       ids   array  abc    def        Send push notification via Google Cloud Messaging sendPushNotification  data   ids    function sendPushNotification  data   ids           Insert real GCM API key from the Google APIs Console        https   code google com apis console               apiKey    abc           Set POST request body      post   array                       registration ids     gt   ids                       data                 gt   data                              Set CURL request headers       headers   array                            Authorization  key      apiKey                           Content-Type  application json                                 Initialize curl handle             ch   curl init            Set URL to GCM push endpoint          curl setopt  ch  CURLOPT URL   https   gcm-http googleapis com gcm send            Set request method to POST            curl setopt  ch  CURLOPT POST  true           Set custom request headers            curl setopt  ch  CURLOPT HTTPHEADER   headers           Get the response back as string instead of printing it            curl setopt  ch  CURLOPT RETURNTRANSFER  true           Set JSON post data     curl setopt  ch  CURLOPT POSTFIELDS  json encode  post            Actually send the request          result   curl exec  ch           Handle errors     if  curl errno  ch             echo  GCM error      curl error  ch                 Close curl handle     curl close  ch           Debug GCM response            echo  result

User · Answer

A lot of the tutorials are outdated  and even the current code doesn t account for when device registration ids are updated or devices unregister  If those items go unchecked  it will eventually cause issues that prevent messages from being received   http   forum loungekatt com viewtopic php t 63 p181

User · Answer

After searching for a long time finally I am able to figure out what I exactly needed  Connecting to the GCM using PHP as a server side scripting language  The following tutorial will give us a clear idea of how to setup everything we need to get started with GCM  Android Push Notifications using Google Cloud Messaging  GCM   PHP and MySQL

User · Answer

Here is android code for PHP code of above posted by  Elad Nava  MainActivity java  Launcher Activity   public class MainActivity extends AppCompatActivity       String PROJECT NUMBER  your project number sender id        Override     protected void onCreate Bundle savedInstanceState            super onCreate savedInstanceState           setContentView R layout activity main              GCMClientManager pushClientManager   new GCMClientManager this  PROJECT NUMBER           pushClientManager registerIfNeeded new GCMClientManager RegistrationCompletedHandler                  Override             public void onSuccess String registrationId  boolean isNewRegistration                     Log d  Registration id   registrationId                     send this registrationId to your server                             Override             public void onFailure String ex                    super onFailure ex                                       GCMClientManager java  public class GCMClientManager          Constants     public static final String TAG    GCMClientManager       public static final String EXTRA MESSAGE    message       public static final String PROPERTY REG ID    your sender id       private static final String PROPERTY APP VERSION    appVersion       private final static int PLAY SERVICES RESOLUTION REQUEST   9000         Member variables     private GoogleCloudMessaging gcm      private String regid      private String projectNumber      private Activity activity      public GCMClientManager Activity activity  String projectNumber            this activity   activity          this projectNumber   projectNumber          this gcm   GoogleCloudMessaging getInstance activity                         return Application s version code from the   code PackageManager               private static int getAppVersion Context context            try               PackageInfo packageInfo   context getPackageManager                        getPackageInfo context getPackageName    0               return packageInfo versionCode            catch  NameNotFoundException e                   should never happen             throw new RuntimeException  Could not get package name      e                          Register if needed or fetch from local store     public void registerIfNeeded final RegistrationCompletedHandler handler            if  checkPlayServices                  regid   getRegistrationId getContext                 if  regid isEmpty                      registerInBackground handler                 else      got id from cache                 Log i TAG  regid                   handler onSuccess regid  false                           else      no play services             Log i TAG   No valid Google Play Services APK found                                    Registers the application with GCM servers asynchronously          lt p gt         Stores the registration ID and app versionCode in the application s        shared preferences              private void registerInBackground final RegistrationCompletedHandler handler            new AsyncTask lt Void  Void  String gt                   Override             protected String doInBackground Void    params                    try                       if  gcm    null                            gcm   GoogleCloudMessaging getInstance getContext                                               InstanceID instanceID   InstanceID getInstance getContext                         regid   instanceID getToken projectNumber  GoogleCloudMessaging INSTANCE ID SCOPE  null                       Log i TAG  regid                          Persist the regID - no need to register again                      storeRegistrationId getContext    regid                     catch  IOException ex                           If there is an error  don t just keep trying to register                         Require the user to click a button again  or perform                        exponential back-off                      handler onFailure  Error      ex getMessage                                       return regid                             Override             protected void onPostExecute String regId                    if  regId    null                        handler onSuccess regId  true                                             execute null  null  null                        Gets the current registration ID for application on GCM service          lt p gt         If result is empty  the app needs to register                 return registration ID  or empty string if there is no existing            registration ID              private String getRegistrationId Context context            final SharedPreferences prefs   getGCMPreferences context           String registrationId   prefs getString PROPERTY REG ID               if  registrationId isEmpty                  Log i TAG   Registration not found                 return                          Check if app was updated  if so  it must clear the registration ID            since the existing regID is not guaranteed to work with the new            app version          int registeredVersion   prefs getInt PROPERTY APP VERSION  Integer MIN VALUE           int currentVersion   getAppVersion context           if  registeredVersion    currentVersion                Log i TAG   App version changed                 return                       return registrationId                       Stores the registration ID and app versionCode in the application s          code SharedPreferences                  param context application s context          param regId registration ID             private void storeRegistrationId Context context  String regId            final SharedPreferences prefs   getGCMPreferences context           int appVersion   getAppVersion context           Log i TAG   Saving regId on app version     appVersion           SharedPreferences Editor editor   prefs edit            editor putString PROPERTY REG ID  regId           editor putInt PROPERTY APP VERSION  appVersion           editor commit              private SharedPreferences getGCMPreferences Context context               This sample app persists the registration ID in shared preferences  but            how you store the regID in your app is up to you          return getContext   getSharedPreferences context getPackageName                    Context MODE PRIVATE                        Check the device to make sure it has the Google Play Services APK  If        it doesn t  display a dialog that allows users to download the APK from        the Google Play Store or enable it in the device s system settings              private boolean checkPlayServices             int resultCode   GooglePlayServicesUtil isGooglePlayServicesAvailable getContext             if  resultCode    ConnectionResult SUCCESS                if  GooglePlayServicesUtil isUserRecoverableError resultCode                     GooglePlayServicesUtil getErrorDialog resultCode  getActivity                            PLAY SERVICES RESOLUTION REQUEST  show                  else                   Log i TAG   This device is not supported                               return false                    return true            private Context getContext             return activity            private Activity getActivity             return activity            public static abstract class RegistrationCompletedHandler           public abstract void onSuccess String registrationId  boolean isNewRegistration           public void onFailure String ex                   If there is an error  don t just keep trying to register                 Require the user to click a button again  or perform                exponential back-off              Log e TAG  ex                       PushNotificationService java  Notification generator   public class PushNotificationService extends GcmListenerService       public static int MESSAGE NOTIFICATION ID   100        Override     public void onMessageReceived String from  Bundle data            String message   data getString  message            sendNotification  Hi-  message   My App sent you a message               private void sendNotification String title  String body            Context context   getBaseContext            NotificationCompat Builder mBuilder    NotificationCompat Builder  new NotificationCompat Builder context                   setSmallIcon R mipmap ic launcher  setContentTitle title                   setContentText body           NotificationManager mNotificationManager    NotificationManager  context                  getSystemService Context NOTIFICATION SERVICE           mNotificationManager notify MESSAGE NOTIFICATION ID  mBuilder build               AndroidManifest xml   lt  xml version  1 0  encoding  utf-8   gt       lt uses-permission android name  android permission INTERNET    gt   lt uses-permission android name  android permission WAKE LOCK    gt   lt uses-permission android name  com google android c2dm permission RECEIVE    gt   lt permission android name  com example gcm permission C2D MESSAGE      android protectionLevel  signature    gt   lt uses-permission android name  com example gcm permission C2D MESSAGE    gt   lt application     android allowBackup  true      android icon   mipmap ic launcher      android label   string app name      android supportsRtl  true      android theme   style AppTheme   gt       lt activity android name   MainActivity   gt           lt intent-filter gt               lt action android name  android intent action MAIN    gt                lt category android name  android intent category LAUNCHER    gt           lt  intent-filter gt       lt  activity gt        lt service         android name   PushNotificationService          android exported  false  gt           lt intent-filter gt               lt action android name  com google android c2dm intent RECEIVE    gt           lt  intent-filter gt       lt  service gt        lt receiver         android name  com google android gms gcm GcmReceiver          android exported  true          android permission  com google android c2dm permission SEND  gt           lt intent-filter gt               lt action android name  com google android c2dm intent RECEIVE    gt               lt category android name  package gcmdemo    gt           lt  intent-filter gt       lt  receiver gt   lt  application gt

User · Answer

lt  php        Replace with the real server API key from Google APIs      apiKey    your api key           Replace with the real client registration IDs      registrationIDs   array   reg id1   reg id2            Message to be sent      message    hi Shailesh           Set POST variables      url    https   android googleapis com gcm send         fields   array           registration ids    gt   registrationIDs           data    gt  array   message    gt   message                headers   array           Authorization  key      apiKey           Content-Type  application json                 Open connection      ch   curl init            Set the URL  number of POST vars  POST data     curl setopt   ch  CURLOPT URL   url       curl setopt   ch  CURLOPT POST  true       curl setopt   ch  CURLOPT HTTPHEADER   headers       curl setopt   ch  CURLOPT RETURNTRANSFER  true         curl setopt   ch  CURLOPT POSTFIELDS  json encode   fields         curl setopt  ch  CURLOPT SSL VERIFYPEER  false          curl setopt  ch  CURLOPT POST  true          curl setopt  ch  CURLOPT RETURNTRANSFER  true       curl setopt  ch  CURLOPT POSTFIELDS  json encode   fields            Execute post      result   curl exec  ch           Close connection     curl close  ch       echo  result        print r  result         var dump  result     gt

User · Answer

I actually have this working now in a branch in my Zend Mobile tree  https   github com mwillbanks Zend Mobile tree feature gcm  This will be released with ZF 1 12  however  it should give you some great examples on how to do this   Here is a quick demo on how it would work       lt  php require once  Zend Mobile Push Gcm php   require once  Zend Mobile Push Message Gcm php     message   new Zend Mobile Push Message Gcm     message- gt setId time      message- gt addToken  ABCDEF0123456789     message- gt setData array       foo    gt   bar        bar    gt   foo         gcm   new Zend Mobile Push Gcm     gcm- gt setApiKey  MYAPIKEY      response   false   try        response    gcm- gt send  message     catch  Zend Mobile Push Exception  e           all other exceptions only require action to be sent or implementation of exponential backoff      die  e- gt getMessage           handle all errors and registration id s foreach   response- gt getResults   as  k   gt   v        if   v  registration id              printf   s has a new registration id of   s r n    k   v  registration id               if   v  error              printf   s had an error of   s r n    k   v  error               if   v  message id              printf   s was successfully sent the message  message id is   s    k   v  message id

User · Answer

Here s a library I forked from CodeMonkeysRU   The reason I forked was because Google requires exponential backoff  I use a redis server to queue messages and resend after a set time   I ve also updated it to support iOS   https   github com stevetauber php-gcm-queue

User · Answer

Also you can try this piece of code  source    lt  php     define  GOOGLE API KEY    AIzaSyCJiVkatisdQ44rEM353PFGbia29mBVscA        define  GOOGLE GCM URL    https   android googleapis com gcm send         function send gcm notify  reg id   message             fields   array               registration ids     gt  array   reg id                 data                 gt  array   message    gt   message                         headers   array               Authorization  key     GOOGLE API KEY               Content-Type  application json                       ch   curl init            curl setopt  ch  CURLOPT URL  GOOGLE GCM URL           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           if   result     FALSE                die  Problem occurred      curl error  ch                       curl close  ch           echo  result              reg id    APA91bHuSGES     nn5pWrrSz0dV63pg        msg    Google Cloud Messaging working well        send gcm notify  reg id   msg

User · Answer

I know this is a late Answer  but it may be useful for those who wants to develop similar apps with current FCM format  GCM has been deprecated   The following PHP code has been used to send topic-wise podcast  All the apps registered with the mentioned channel topis would receive this Push Notification    lt  php  try   fcm token    your fcm token    service url    https   fcm googleapis com fcm send    channel     topics    adminChannel  echo  channel   lt  br gt           curl post body   array  to    gt   channel           content available    gt  true           notification    gt  array  click action    gt   action open                                body   gt   contentTitle                               title   gt  Title    contentCurrentCat    Updates                                 message   gt  44             data   gt  array  click action    gt   action open                                body   gt  test                                title   gt  test                                message   gt  catTitleId              headers   array           Content-Type application json            Authorization key    fcm token         ch   curl init        curl setopt  ch  CURLOPT URL   service url       curl setopt  ch  CURLOPT POST  true       curl setopt  ch  CURLOPT HTTPHEADER   headers       curl setopt  ch  CURLOPT RETURNTRANSFER  true       curl setopt  ch  CURLOPT SSL VERIFYHOST  0       curl setopt  ch  CURLOPT SSL VERIFYPEER  false       curl setopt  ch  CURLOPT POSTFIELDS  json encode  curl post body          result   curl exec  ch       if   result     FALSE            die  FCM Send Error      curl error  ch            echo  failure        else       echo  success    result            curl close  ch       return  result     catch Exception  e        echo  Message      e- gt getMessage        gt

User · Answer

It s easy to do  The cURL code that s on the page that Elad Nava has put here works  Elad has commented about the error he s receiving   String describing an error that occurred while processing the message for that recipient  The possible values are the same as documented in the above table  plus  Unavailable   meaning GCM servers were busy and could not process the message for that particular recipient  so it could be retried    I ve got a service set up already that seems to be working  ish   and so far all I ve had back are unavailable returns from Google  More than likely this will change soon   To answer the question  use PHP  make sure the Zend Framework is in your include path  and use this code    lt  php     ini set  display errors  1       include Zend Loader Autoloader php       Zend Loader Autoloader  getInstance          url    https   android googleapis com gcm send        serverApiKey    YOUR API KEY AS GENERATED IN API CONSOLE        reg    DEVICE REGISTRATION ID         data   array               registration ids    gt  array  reg                data    gt  array  yourname    gt   Joe Bloggs               print json encode  data          client   new Zend Http Client  url        client- gt setMethod  POST         client- gt setHeaders array  Content-Type    gt   application json    Authorization    gt   key      serverApiKey         client- gt setRawData json encode  data         request    client- gt request  POST         body    request- gt getBody         headers    request- gt getHeaders        print   lt xmp gt         var dump  body       var dump  headers     And there we have it  A working  it will work soon  example of using Googles new GCM in Zend Framework PHP

User · Answer

use this   function pnstest                      data   array  post id   gt  12345   title   gt  A Blog post    message    gt  test msg                      url    https   fcm googleapis com fcm send                     server key    AIzaSyDVpDdS7EyNgMUpoZV6sI2p-cG                     target   fO3JGJw4CXI APA91bFKvHv8wzZ05w2JQSor6D8lFvEGE jHZGDAKzFmKWc73LABnumtRosWuJx--I4SoyF1XQ4w01P77MKft33grAPhA8g-wuBPZTgmgttaC9U4S3uCHjdDn5c3YHAnBF3H                     fields   array                     fields  data      data                  if is array  target                         fields  registration ids      target                   else                       fields  to      target                                       header with content type api key                  headers   array                       Content-Type application json                      Authorization key    server key                                      ch   curl init                    curl setopt  ch  CURLOPT URL   url                   curl setopt  ch  CURLOPT POST  true                   curl setopt  ch  CURLOPT HTTPHEADER   headers                   curl setopt  ch  CURLOPT RETURNTRANSFER  true                   curl setopt  ch  CURLOPT SSL VERIFYHOST  0                   curl setopt  ch  CURLOPT SSL VERIFYPEER  false                   curl setopt  ch  CURLOPT POSTFIELDS  json encode  fields                     result   curl exec  ch                   if   result     FALSE                        die  FCM Send Error      curl error  ch                                      curl close  ch                   return  result

User · Answer

lt  php  function sendMessageToPhone  deviceToken   collapseKey   messageText   yourKey            echo  DeviceToken    deviceToken  Key    collapseKey  Message    messageText               API Key    yourKey  Response    lt br  gt          headers   array  Authorization key      yourKey            data   array               registration id    gt   deviceToken                     collapse key    gt   collapseKey           data message    gt   messageText          ch   curl init             curl setopt  ch  CURLOPT URL   https   android googleapis com gcm send            if   headers              curl setopt  ch  CURLOPT HTTPHEADER   headers           curl setopt  ch  CURLOPT SSL VERIFYPEER  false           curl setopt  ch  CURLOPT POST  true           curl setopt  ch  CURLOPT RETURNTRANSFER  true           curl setopt  ch  CURLOPT POSTFIELDS   data             response   curl exec  ch           var dump  response        httpCode   curl getinfo  ch  CURLINFO HTTP CODE           if  curl errno  ch             return false                if   httpCode    200            return false                curl close  ch           return  response            yourKey    YOURKEY    deviceToken    REGISTERED ID    collapseKey    COLLAPSE KEY    messageText    MESSAGE   echo sendMessageToPhone  deviceToken   collapseKey   messageText   yourKey     gt    In above script just change        YOURKEY  to API key to Server Key of API console     REGISTERED ID  with your device s registration ID    COLLAPSE KEY  with key which you required    MESSAGE  with message which you want to send   Let me know if you are getting any problem in this I am able to get notification successfully using the same script

[php] GCM with PHP (Google Cloud Messaging)

Examples related to php

Examples related to android

Examples related to firebase-cloud-messaging

Examples related to google-cloud-messaging