Course13:IT Connect - 10.1 Push Object

From innovaphone-wiki

Jump to: navigation, search

How to configure a Push Object

Contents

The Push Object

The PBX is able to send push notifications to Apple via the Apple Push Notification Service (APNs) and to Google via Firebased Cloud Messaging (FCM). As a result, incoming calls will wake up your myApps for iOS or myApps for Android if it is not started or running in background mode. The PBX uses an innovaphone AG service at services.innovaphone.com (push.innovaphone.com) to send push notifications to Apple or Google. No call meta data is transmitted, the push notification is only used to wake up myApps.

In the end you should know, if your customer wants to use myApps on a Android or iOS device, you need to set up a push object on your phone system.

If you are interested in learning more about how Push works, please have a look fish-help.png at the Wiki.

Configuration

In 13r2 we introduced a new method to authenticate a push PBX object at push.innovaphone.com. This new method uses the device certificate of the device instead of email verification. This makes the new method easy to implement as the device certificate is already built into an innovaphone gateway.

The authentication method from 13r1 still works in 13r2, but this method is obsolete and only available for compatibility reasons. Please do not use it in 13r2 and above.


Configuration in 13r1

Open the PBX Manager plugin screenshot.png App Platforms and add screenshot.png innovaphones Services-App Platform. This will ask you to configure:

  • Title/SIP Id: Both must be unique in the system, but have no relevance for the user or admin. Best would be to use for title and SIP Id services. Don't name it Push as we use this name later on.
  • Host Name: here you configure the host-name of the remote Application Platform. To configure Push you will need to use services.innovaphone.com

The email address entered when asked for email verification, is stored together with the Domain/System Name of the PBX/App Platform for authentication of Push requests. The email should be in custody of the end-customer because in case of conflicts with the domain-name (e.g. 2 innovaphone customers have a PBX with the same domain name), innovaphone would use this mail-address as contact.

To test Push in our training scenario you need to enter your dvl-ckl2@class.local e-mail address because the services instance of the training environment can only deliver mails to the training mailserver.

After confirmation of the screenshot.png verification mail, a new PBX-Manager plugin called screenshot.png services Push will appear. Use the plugin to screenshot.png create a Push object. Please use the preconfigured values for Name/ID. If you want to use other Name/ID values, you must adapt the Templates PBX-Manager plugin and change the name of your Push object in the settings sections.

Your PBX will now try to connect to services.innovaphone.com using HTTPS. If everything goes well, your configuration is finished and myApps running on your mobile device will receive Push notifications from Apple or Google.

You can check the state of the push App if you go to the user interface of the device (screenshot.png Admin UI of IP411Left) via the Devices app and there in the screenshot.png PBX/Objects section. The best case scenario is if the screenshot.png Push-object shows connected. If not, check certificates in the advanced UI to trust the services.innovaphone.com certificate or even better "COMODO RSA Domain Validation Secure Server CA".

If the state still doesn’t change to connected, make sure that the PBX HTTPS-connection is not blocked by some firewall at the customer site.


Configuration from 13r2

The recommended way to set up a push object in 13r2 has been simplified a lot. In fact, all you have to do is to run the install and the object will be created automatically. In case you perform an update from 13r1 to 13r2, you will see a new screenshot.png Push PBX Manager plugin. Just screenshot.png click the name, screenshot.png leave every option as is and then press ok. A new push object will be created in the PBX which will automatically connect to push.innovaphone.com. If the connection was successful a screenshot.png green checkmark is displayed in the upper right corner.

You may wonder how this works. When created, the push object tries to establish a websocket connection to push.innovaphone.com. Therefore an outgoing HTTPS (TCP/443) and websocket connection from the customer network has to be allowed. Push.innovaphone.com has to trust this HTTPS connection. For this purpose, the PBX must transmit its device certificate which has been signed by the innovaphone Device Certification Authority 2. Fortunately an innovaphone gateway has a device certificate signed by the innovaphone Device Certification Authority 2 already pre-installed, as a consequence there is nothing to do in such a case as it will work out of the box.

(Further Hints)Since an IPVA is using a self-signed certificate by default, you need to download the device certificate from my.innovaphone.com as it is explained fish-help.png here.

Even if you use a custom certificate on your device, the device certificate signed by the innovaphone Device Certification Authority 2 remains in the flash memory so that this certificate is still used for the connection to innovaphone's push service.

Personal tools