ios-voip-push

APN push notification services for IOS sip client with Asterisk or Freepbx or VitalPBX or any other Asterisk based IP PBX

Background:

One may find creating a push notifcation service for general purpose applications is effortless. But configuring a functional push notification service for SIP client in conjunction with Asterisk based PBX system is not that straight forward .

After a long search for a usable push notification service for FreePbx all over internet and could not able to accumulate everything needed to make a fully functional Push Notification service , I decided to write simple scripts using shell and php

Prerequisites

1.edamov/pushok

This will connect to Apple APN servers and send notifications . Ofcourse you can use any other library or you can even write your own scripts or simply use curl. Remember Apple needs a persistant connection to APNs servers or it may flag your curl request as spam bots.

2.PHP, Mysql and your favourite shell

There is one shell script in this repository to check asterisk logs for registartion requests and save the Registration contact information in database . You can setup monit for this if you do not want to use this script. But the base idea is to monitor log files continuously and extract apn tokens from softphone requests to save it in a sepearate database .

We are saving Registartion Contact information in a sepearate database because peer ifnormation we obtain from sip show peer is not persistent.

To store push tokens we need to create a simple database something like below. You can change database columns their types and length as per your requirement.

Our interest is mainly in 2 columns to store SIP useraccount and device token information. Ofcourse you can store device type or any other dynamic information you fetch from contact headers as per your requirement.

CREATE TABLE pushdb_pushkeys ( id int(10) NOT NULL, p_device varchar(64) NOT NULL, p_status int(1) DEFAULT NULL, p_type varchar(10) DEFAULT NULL, p_info varchar(124) NOT NULL, p_updated varchar(40) NOT NULL ) ENGINE=InnoDB DEFAULT CHARSET=utf8;

3.Asterisk or Freepbx or vitalpbx pbx or elastix pbx

Once we get push tokens into database , we just modify extensions asterisk configuration to send push notification if the destination extension exist in database and it has push token .

How to use:

STEP 1.make sure you have php, mysql and asterik system installed

STEP 2. clone this repository to /var/lib/asterisk/pushscripts or any other directory of your choice but make sure scripts have executable permissions by asterisk. Please do not use your web dircetory as we are using php cli to run script from extesnions So you can rename push.php to just push.

STEP 3 move asterisk_reg.sh to /usr/local/bin

STEP 4.change database username , password , database name in scripts

STEP 5 . Change key_id, team_id, app_bundle_id,and secrets in [push.php] (https://github.com/balusreekanth/ios-asterisk-push/blob/master/push.php)

and define key path AuthKey_XXXXXX.p8 .

you can obtain p8 key,teamid, keyid details from apple developer portal.copy p8 key in the directory which you defined in push.php

STEP 6. move push.service to /etc/systemd/system/ inorder to run the script automatically at boot . You can skip this step if you are using monit and cofnigured monit accordingly .

You can run commands to enable and start the service

systemctl daemon-reload

systemctl start push.service

systemctl status push.service

systemctl enable push.service

STEP 7. Now configure your extensions configuration file to check if the destination extension exist in our database . If it exists, we do send call to push context else we process call normally.

exntsions configuration file may look differnt from system to system depending on your asterisk distro .Below a smaple configuration is given for reference.

same => n,GoSubIf($["${pushneed}" = "${CALL_DESTINATION}"]?push,s,1(${CURRENT_DEVICE}))

[push]

exten => s,1,NoOP(SUB: Send push notification)

same => n,Set(MAX_TRIES=15)

same => n,Set(TRY=1)

;send args to push script

same => n,System(/var/lib/asterisk/pushscripts/push "${CALL_DESTINATION}" "${CALLERID(num)}" "${CALLERID(name)}" )

Enjoy push notifications for SIP calls on IOS and save your battery ( infact on newer IOS versions , there is no alternative to receive incoming calls when app is in background than using push service !)

Need help ?

Write your comments and issues in issues section of this repository . Or you can mail at balusreekanthATgmailDOTcom

Would you like to improve this ?

I Love to see pull requests to improve this script further .

Donate

If this project help you reduce time to develop, you can give me a cup of coffee :)