Setup Push notifications for iOS or Android - Revision history

Liliu at 12:47, 19 August 2020

2020-08-19T12:47:43Z

Nathan at 16:14, 18 May 2020

2020-05-18T16:14:52Z

Nathan at 17:43, 24 September 2019

2019-09-24T17:43:08Z

Nathan at 17:41, 24 September 2019

2019-09-24T17:41:59Z

Nathan at 22:13, 2 August 2019

2019-08-02T22:13:20Z

Nathan at 21:33, 2 August 2019

2019-08-02T21:33:35Z

Nathan at 21:32, 2 August 2019

2019-08-02T21:32:49Z

Nathan at 21:32, 2 August 2019

2019-08-02T21:32:18Z

Nathan at 21:31, 2 August 2019

2019-08-02T21:31:11Z

Nathan at 18:22, 2 August 2019

2019-08-02T18:22:16Z

← Older revision		Revision as of 12:47, 19 August 2020
Line 112:		Line 112:

	Sending APN to Device with token:8e6adc4d55a27d2fa9da9a8ebe5451e4547b640511519ef07aae045630dea607		Sending APN to Device with token:8e6adc4d55a27d2fa9da9a8ebe5451e4547b640511519ef07aae045630dea607
		+
		+	There are 2 tokens in use for Apple:
		+
		+	token - the regular “old” style token from Apple for Applle push notifications.
		+	voiptoken - the token used for Apple “Voip” push notifications.
		+
		+	The difference is that a “Voip” push does not require acknowledgement from the user in order to notify the user and start the app. So it is preferred (usually) over the other type.
		+
		+	Since both are supported, both can be included on the same Apple device.
		+
		+	For Android there is only one type push and it is supported with just the token field.
		+
		+	Below are the code snippets from Apple for constructing the 2 types of push notifications.
		+
		+	(void)pushRegistry:(nonnull PKPushRegistry )registry didUpdatePushCredentials:(nonnull PKPushCredentials )pushCredentials forType:(nonnull PKPushType)type {
		+	// Get Device token
		+	NSString *token = [pushCredentials.token.description stringByTrimmingCharactersInSet:[NSCharacterSet characterSetWithCharactersInString:@"<>"]];
		+	token = [token stringByReplacingOccurrencesOfString:@" " withString:@""];
		+
		+	NSLog(@"voiptoken=%@",token);
		+
		+	unsigned char tokenString[128];
		+	unsigned char outString[128];
		+	char headerString[128];
		+
		+	int tokenLength=32;
		+	size_t outSize=sizeof(outString);
		+
		+	memset(tokenString,0,sizeof(tokenString));
		+	memset(outString,0,sizeof(outString));
		+	memset(headerString,0,sizeof(headerString));
		+
		+	// Put the bytes from the deviceToken into the 'C' array tokenString
		+
		+	tokenLength = (int)[pushCredentials.token length];
		+	[pushCredentials.token getBytes:tokenString length:tokenLength];
		+
		+	// Now base64 encode it to prepare it for sending in the register msg
		+
		+	if (Base64EncodeData(tokenString,tokenLength, (char *)outString,&outSize,0))
		+	{
		+
		+	NSLog(@"stoken voip Len(%lu) = %s",outSize, outString);
		+
		+
		+	// Now convert it to the header in NSString format and store it for later use during registration
		+
		+	sprintf(headerString,";voiptoken=%c%s%c",34,outString,34);
		+
		+	NSString *myNSToken = [NSString stringWithCString:headerString encoding:NSASCIIStringEncoding];
		+
		+	// Read the original header we received when we setup a token for the Apple Push Service
		+	NSString *myTokenHeader=[[NgnEngine sharedInstance].configurationService getStringWithKey:IDENTITY_TOKEN];
		+
		+	// Now concatenate it with myNSToken and resave.
		+
		+	[[NgnEngine sharedInstance].configurationService setStringWithKey: IDENTITY_TOKEN andValue: [NSString stringWithFormat:@"%@%@", myTokenHeader , myNSToken]];
		+
		+
		+	}
		+	else
		+	{
		+	NSLog(@"Error converting voip token to base64!");
		+	}
		+
		+	}

@@ Line 33: / Line 33: @@
 a) For google firebase you will need your Legacy server key - which can be found under your project settings, cloud messaging tab.
-b) For Apple you will need the push certificate from their developer console.  This file should be put into he ios push certification is put into the /home/skynet/sky/bin/Certs folder
+b) For Apple you will need the push certificate from their developer console.  This file should be put into he ios push certification is put into the /home/skynet/sky/bin/Certs/<vendor> folder, where the default vendor is sky.
 There is a script (genpems) to convert the downloaded .p12 files into the required pem certificates.  Edit the script as necessary to create production or dev certificates.
 The files that are needed for push are:  (If these are generated by by the provisionator or some other tool, you might just get one .pem file.  This same file can be copied to the key and cert.pem files)
@@ Line 42: / Line 42: @@
   apns-dev-key.pem
   apns-dev-cert.pem
 The configuration file is located in /home/skynet/sky/conf/autoload_configs/sofia.conf.xml
@@ Line 52: / Line 55: @@
      <!--Send push for calls where the phone is not registered (otherwise the push script needs to be put in the dialplan (in the dialplan is the recommended way)) -->
      <param name="is-push-every-call" value="0"/>
-     <!--Use the Apple dev certificate or production certificate. 0 - use production certificate and production push server 1 - use sandbox and dev certificate -->
+     <!--Use the Apple dev certificate or production certificate. 0 - use production certificate and production push server, 1 - use sandbox and dev certificate, 2 - use voip push certificate and production push server, 3 - use voip push and sandbox server -->
      <param name="is-dev-cert" value="0"/>
      <!--push type. 1:notification, 2:data. Currently, we don't support mixture of notification and data. -->
@@ Line 103: / Line 106: @@
 iOS:
 X-Mobile: os=ios;token="hDcyb5glkvfGoDY96Em/QQ8lZ3k+3ZpKL/ZUDQz/Cpw="   -
 Note: For iOS the token is base64 encoded in the SIP X-header so you will need to pull the actual token from the push notify in a line like this:
 Sending APN to Device with token:8e6adc4d55a27d2fa9da9a8ebe5451e4547b640511519ef07aae045630dea607

@@ Line 81: / Line 81: @@
+#
 # Send a push notify to a client
-# $1 - calling number
+# $1 - calling number (can be anything - it's not checked)
-# $2 - called number
+# $2 - called number (should include the company domain/context of the call)
+#
 fsc "sofia_push external2 $1 $2

← Older revision		Revision as of 17:41, 24 September 2019
Line 92:		Line 92:

	2.1 The push can be used in diaplan right before the bridge command like this:		2.1 The push can be used in diaplan right before the bridge command like this:
−	<action application="lua" data="/home/skynet/sky/scripts/sofia_push.lua external2 1001 1002" inline="true"/>	+	<action application="lua" data="/home/skynet/sky/scripts/sofia_push.lua external2 1001@company1.sky-networks.com 1002@company1.sky-networks.com" inline="true"/>

← Older revision		Revision as of 22:13, 2 August 2019
Line 71:		Line 71:
	</nowiki>		</nowiki>

		+
		+	Note on sandbox vs. production on iOS - if you are debugging on iOS (in development) you will need to use the sandbox. If your app is in production on the app store - use the production cert/site.

	2. push server Usage.		2. push server Usage.

@@ Line 75: / Line 75: @@
     There should be a script called pushtest to try it in the sky/bin directory
    Here is the source:
 #!/bin/bash
+#
@@ Line 82: / Line 83: @@
+#
 fsc "sofia_push external2 $1 $2
    skydance push is an API command. It has 3 argments. The usage is:

← Older revision		Revision as of 21:32, 2 August 2019
Line 87:		Line 87:


−	2.1 The push can be used in diaplan like:	+	2.1 The push can be used in diaplan right before the bridge command like this:
	<action application="lua" data="/home/skynet/sky/scripts/sofia_push.lua external2 1001 1002" inline="true"/>		<action application="lua" data="/home/skynet/sky/scripts/sofia_push.lua external2 1001 1002" inline="true"/>

← Older revision		Revision as of 21:32, 2 August 2019
Line 88:		Line 88:

	2.1 The push can be used in diaplan like:		2.1 The push can be used in diaplan like:
−	<action application="lua" data="/home/skynet/sky/scripts/sofia_push.lua external2 1001 1002", inline="true"/>	+	<action application="lua" data="/home/skynet/sky/scripts/sofia_push.lua external2 1001 1002" inline="true"/>

← Older revision		Revision as of 21:31, 2 August 2019
Line 88:		Line 88:

	2.1 The push can be used in diaplan like:		2.1 The push can be used in diaplan like:
−	<action application="lua" data="/home/skynet/sky/scripts/sofia_push.lua external2 1001 1002"/>	+	<action application="lua" data="/home/skynet/sky/scripts/sofia_push.lua external2 1001 1002", inline="true"/>

@@ Line 24: / Line 24: @@
 https://developer.apple.com/documentation/usernotifications/registering_your_app_with_apns
-You can also just use the provisionator from onesignal and it will do everything for you.
+You can also just use the provisionator from onesignal and it will do everything for you. (much easier)
 https://onesignal.com/provisionator#