VoIP Push Notifications Gateway
<!-- If the browser does not support frames put the first topic content here --> <div class="WordSection1"> <p class="MsoSubtitle" align="center" style='text-align:center'><span class="TitleChar"><span style='font-size:26.0pt;line-height:107%'>VoIP push notifications</span></span><br> Add VoIP push notification support for your SIP Server and softphone</p> <p class="MsoNormal"> </p> <p class="MsoTocHeading">Contents<br> <br> </p> <p class="MsoToc1"><a href="start.htm#_Toc117069553"><b>About</b><span style='color:windowtext; display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>2</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc117069554">How it works?<span style='color:windowtext; display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>2</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc117069555">Softswitch vs Gateway<span style='color:windowtext;display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>4</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc117069556">Usage<span style='color:windowtext; display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>5</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc117069557"><b>Server</b><span style='color:windowtext; display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>5</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc117069558">Gateway configuration<span style='color:windowtext;display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>6</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc117069559">Enable VoIP push notifications<span style='color:windowtext;display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>6</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc117069560">Important configuration settings<span style='color:windowtext;display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>7</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc117069561">Advanced configuration options<span style='color:windowtext;display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>7</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc117069562">VoIP push notification messages<span style='color:windowtext;display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>8</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc117069563">Monitoring<span style='color:windowtext; display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>10</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc117069564"><b>Client</b><span style='color:windowtext; display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>10</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc117069565">Generic Instructions<span style='color:windowtext;display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>10</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc117069566">Android<span style='color:windowtext; display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>11</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc117069567">iOS with PushKit<span style='color:windowtext;display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>15</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc117069568">iOS with FCM<span style='color:windowtext; display:none;text-decoration:none'>... </span><span style='color:windowtext;display:none;text-decoration:none'>25</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc117069569">Web<span style='color:windowtext; display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>32</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc117069570">WebPhone<span style='color:windowtext; display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>35</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc117069571">AJVoIP<span style='color:windowtext; display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>37</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc117069572">AJVoIP -Mizu PUSH service<span style='color:windowtext;display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>40</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc117069573">Customized MizuDroid<span style='color:windowtext;display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>43</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc117069574">Others<span style='color:windowtext; display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>43</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc117069575"><b>SIP Signaling</b><span style='color:windowtext;display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>44</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc117069576">X-MPUSH<span style='color:windowtext; display:none;text-decoration:none'>.. </span><span style='color:windowtext;display:none;text-decoration:none'>44</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc117069577">RFC 8599<span style='color:windowtext; display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>46</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc117069578"><b>FAQ</b><span style='color:windowtext; display:none;text-decoration:none'>.. </span><span style='color:windowtext;display:none;text-decoration:none'>48</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc117069579"><b>Resources</b><span style='color:windowtext;display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>54</span></a></p> <p class="MsoNormal"> </p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <h1><a name="_Toc117069553"><b>About</b></a></h1> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Push notification is a method to send message to your application or to notify its user without actually opening the app. Push notifications in the context of VoIP means that VoIP softphones no longer have to maintain a persistent connection to the SIP server (run in background) in order to be able to receive incoming calls or messages. This has several benefits, the most important of which is conserving battery life of mobile devices.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>All softphones provided by Mizutech that are designed for mobile devices has support push notifications: </span><a href="https://www.mizu-voip.com/Software/Softphones/AndroidSoftphone.aspx"><span style='font-size:9.0pt;line-height:107%'>Android softphone</span></a><span style='font-size:9.0pt;line-height:107%'>, </span><a href="https://www.mizu-voip.com/Software/Softphones/iPhoneSoftphone.aspx"><span style='font-size:9.0pt;line-height:107%'>iOS softphone</span></a><span style='font-size:9.0pt;line-height:107%'>, </span><a href="https://www.mizu-voip.com/Software/WebPhone.aspx"><span style='font-size: 9.0pt;line-height:107%'>Web phone</span></a><span style='font-size:9.0pt; line-height:107%'>.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Mizutech also provides ready to use server side solution for push notifications specifically designed with VoIP in mind. This solution offers the possibility for our customers to easily integrate and take advantage of push notifications in their third party VoIP softphones, without the need of purchasing softphones or VoIP server from Mizutech.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>The </span><a href="https://www.mizu-voip.com/Software/VoIPPushGateway.aspx"><span style='font-size:9.0pt;line-height:107%'>MPUSH gateway</span></a><span style='font-size:9.0pt;line-height:107%'> have been built specifically to handle voip push notifications for third party SIP servers and SIP networks. If you are not using the Mizutech SIP server and wish to enable push notification for your softphones, we recommend the use of the </span><a href="https://www.mizu-voip.com/Software/VoIPPushGateway.aspx"><span style='font-size:9.0pt;line-height:107%'>MPUSH voip push notification gateway</span></a><span style='font-size:9.0pt;line-height:107%'>, which is compatible with any SIP server (including Asterisk, Cisco, Voipswitch and others) and it is capable to deliver push notifications to your custom SIP applications.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>All server side solutions from Mizutech include support for push notifications including the </span><a href="https://www.mizu-voip.com/Software/SIPSBC.aspx"><span style='font-size:9.0pt;line-height:107%'>SIP SBC</span></a><span style='font-size:9.0pt;line-height:107%'>, the </span><a href="https://www.mizu-voip.com/Software/WebRTCtoSIP.aspx"><span style='font-size:9.0pt;line-height:107%'>WebRTC-SIP gateway</span></a><span style='font-size:9.0pt;line-height:107%'> and the </span><a href="https://www.mizu-voip.com/Software/VoIPServer.aspx"><span style='font-size:9.0pt;line-height:107%'>SIP Softswitch</span></a><span style='font-size:9.0pt;line-height:107%'>. This means that you don’t need a separate MPSUH gateway if you are using any other of our server side software.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>In this document, we will describe how to integrate push notifications into your app (any browser/web, Android or iOS app) to be used via the Mizu Push Gateway with any SIP server (for example your Asterisk based IP-PBX) or directly with Mizu VoIP server. For Android and Web we will be using Google’s FCM (Firebase Cloud Messaging). For iOS the preferable solution is Apple’s PushKit </span><span style='font-size: 9.0pt;line-height:107%'>APNS</span><span style='font-size:9.0pt;line-height: 107%'> notifications, but FCM can also be used with the limitation that notifications will be received only if the softphone is already “running in background”, meaning that it was not killed by the user. Google GCM is not supported anymore as it was deprecated by Google and replaced with Firebase.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Bellow we will present a step-by-step guide and prerequisites for adding this notification mechanism for Android/iOS softphones and browser webphones.</span></p> <h2><a name="_Toc117069554">How it works?</a></h2> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>The main purpose of the push notifications is to be able to wake-up your closed or sleeping SIP client when new call or chat message is received. <br> It might be used also for other events such as call cancel and custom messages.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>This functionality can be enabled in your softswitch itself (if you are using the Mizu VoIP server) or by using the Mizu Push gateway as a proxy, gateway or SBC between your SIP client applications and your SIP server (all SIP servers is supported such as Asterisk, Cisco and many others). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>If you are using the gateway, then a typical simplified message flow will look like this:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:9.0pt; line-height:107%;color:#833C0B'>SIP Client -> [REGISTER] -> Push Gateway -> [REGISTER] -> SIP server </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:9.0pt; line-height:107%;color:#833C0B'>SIP Client <- [INVITE] <- Push Gateway <- [INVITE] <- SIP server <- [INVITE] <- Other extension or inbound call from a trunk</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> </span><span style='font-size:9.0pt;line-height:107%;color:black'>Where:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'> SIP client: is any Android, iOS or web-based application</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'> Push Gateway: is any Mizutech gateway (MPUSH, MRTC or SBC)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'> SIP server: is your existing IP-PBX or Softswitch such as Asterisk </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>The server uses </span><a href="https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/APNSOverview.html"><span style='font-size:9.0pt;line-height:107%'>Apple APNs</span></a><span style='font-size:9.0pt;line-height:107%'> or the </span><a href="https://firebase.google.com/docs/cloud-messaging/android/client"><span style='font-size:9.0pt;line-height:107%'>Google FCM</span></a><span style='font-size:9.0pt;line-height:107%'> to send the push notifications to iOS, Android or Web clients.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Below we will refer to the push notification service as “server” regardless if it is implemented in the SIP server or as a separate gateway/SBC.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>This is how it works, step-by-step:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Server must be </span><a href="start.htm#_Important_configuration_settings"><span style='font-size:9.0pt; line-height:107%'>configured</span></a><span style='font-size:9.0pt;line-height: 107%'> with your FCM API key and/or apple APNS TLS certificate</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>SIP client apps must have FCM or PushKit integrated which means the followings:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.75in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>app subscribe to </span><a href="https://developer.apple.com/documentation/usernotifications/registering_your_app_with_apns"><span style='font-size:9.0pt;line-height:107%'>Apple Push Notification Service</span></a><span style='font-size:9.0pt;line-height:107%'> (APNS) or </span><a href="https://firebase.google.com/docs/cloud-messaging/android/client"><span style='font-size:9.0pt;line-height:107%'>Google FCM</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.75in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>app will receive a device token from the above cloud service and will send this token in a special SIP header (X-MPUSH or RFC 8599) with SIP REGSITER requests as described </span><a href="start.htm#_SIP_signaling_1"><span style='font-size:9.0pt;line-height:107%'>here</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.75in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>at this point the app is capable to receive push notifications </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.75in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>app must implement handlers for the received notifications (just wake-up for calls or display chat messages)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.75in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>detailed integration instructions can be found </span><a href="start.htm#_Client"><span style='font-size:9.0pt;line-height:107%'>here</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>The server will remember all such clients including their package name (will store in tb_users.fcm field)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in'><span style='font-size:9.0pt;line-height:107%'>By default the server will </span><a href="start.htm#_Improvements"><span style='font-size:9.0pt;line-height:107%'>keep</span></a><span style='font-size:9.0pt;line-height:107%'> these clients registered even if they don’t refresh their registration (regardless their expires timeout)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>4.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>The user can close its app at this point or the device can go to power saving sleep state</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>5.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>New call or chat arrives to the server</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>6.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Server determines whether the destination number is a SIP client with push notification enabled (it will know which applications are “push enabled” because those apps have been sent the X-MPUSH SIP header or Contact tags in an earlier registration). If the target is not a push client then the call/chat is routed as usually, thus it is capable to decide automatically when push notification is needed or not. If the target is a push enabled client, then the followings steps will be applied</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>7.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Server will send a notification to the applications which is delivered with the push notification cloud services (Firebase or PushKit APN).</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.75in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>For the Apple APNS the push is sent either using the new </span><a href="https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns"><span style='font-size:9.0pt;line-height:107%'>HTTPS/2 protocol</span></a><span style='font-size:9.0pt;line-height:107%'> (default) or the </span><a href="https://developer.apple.com/library/archive/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/BinaryProviderAPI.html#//apple_ref/doc/uid/TP40008194-CH13-SW1"><span style='font-size:9.0pt;line-height:107%'>old legacy binary protocol</span></a><span style='font-size:9.0pt;line-height:107%'> over TLS</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.75in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>For Google Firebase FCM the push is sent with </span><a href="https://firebase.google.com/docs/cloud-messaging/http-server-ref"><span style='font-size:9.0pt;line-height:107%'>HTTPS requests</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>8.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>The application will receive the notification. </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.75in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>If it is a chat, then normally just displays it to the user as a notification (user can launch the app by tapping on the notification)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.75in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>If it is a call, then wake up (and register at startup) and handle the incoming call as normally</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>9.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>When calls are routed to push enabled apps, the server will do it a bit differently than for normal calls:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.75in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>It will resend the INVITE more times to allow the app enough time to wake-up and register (it might send the INVITE up to 15 times)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.75in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>It will wait more time for the answer to allow the app enough time to wake-up and register (up to 40 seconds)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.75in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>It will watch for incoming register from the app and will modify its target route set at runtime to include the newly registered app</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.75in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Note that call fork is also fully supported (same user registered from multiple devices)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>10.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>In some circumstances the server can automatically remove the push binding to prevent sending unnecessary/invalid push notifications requests. This might happen when push notification is rejected by FCM/APNS or when the app doesn’t respond to push or when the app doesn’t respond for incoming SIP requests (such as calls) upon push or if the app can’t register (such as because wrong username/password). The push binding is automatically recreated next time when the client register with push request in the signaling.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><b><span style='font-size:9.0pt;line-height:107%'>Call flow with the MPUSH gateway:</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Let's suppose that A is the caller party and B is the called party (username/extension/phone number).</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:"Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>The A can come from any other app registered via the gateway or from your SIP server (maybe from a standard SIP phone or a PSTN call from an external trunk). It can be also your app with push support.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:"Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>The B party must have been registered via the MPUSH gateway before the call arrives! This is your app with push notification support.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>(If the call is coming from your SIP server then the call will not even arrive to the gateway if the B party is not a user on the gateway)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><s><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span></s><s><span style='font-size:9.0pt;line-height:107%'>If the B user is not registered via the gateway, then the gateway can't do anything with the call except to route it to your SIP server (because it doesn't know the address of the B user)</span></s></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><s><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span></s><s><span style='font-size:9.0pt;line-height:107%'>If the B user is registered normally (without using X-MPUSH or RFC 8599) then the call will be routed as normally directly to user B address, without any push notification</span></s></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>If the B user is registered with push (</span><a href="start.htm#_SIP_signaling_1"><span style='font-size:9.0pt;line-height:107%'>using X-MPUSH or RFC 8599</span></a><span style='font-size:9.0pt;line-height:107%'>) then a push notification is sent to the B device and the call is routed to B (this case is what you wish to achieve using the MPUSH gateway)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:"Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>If the B device is already actively registered, then the call is routed normally (the push notification actually is not needed in this case)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:"Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>If the B device is sleeping or the app is closed, then the push notification will wake up to app, the app send a register at startup and the call will be routed to the address from where the register where received.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>The information flow looks like this if you are using the Mizu Push Gateway (MPUSH or SBC) with you SIP server or softswitch:</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'><img border="0" width="559" height="728" id="Picture 3" src="VOIP_Push_notifications_files/image001.png"></span></p> <h2><a name="_Toc117069555">Softswitch vs Gateway</a></h2> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'><br> Push notifications are built into all Mizutech software.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>If you are using the </span><a href="https://www.mizu-voip.com/Software/VoIPServer.aspx"><span style='font-size:9.0pt;line-height:107%'>Mizu VoIP server</span></a><span style='font-size:9.0pt;line-height:107%'> (softswitch) or the </span><a href="https://www.mizu-voip.com/Software/VoIPServer/WindowsPBX.aspx"><span style='font-size:9.0pt;line-height:107%'>Windows IP-PBX</span></a><span style='font-size:9.0pt;line-height:107%'>, you already have everything in place for voip push notifications.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>If you wish to add push notification support to your existing SIP server (be it a softswitch, proxy or IP-PBX), you can use the </span><a href="https://www.mizu-voip.com/Software/VoIPPushGateway.aspx"><span style='font-size:9.0pt;line-height:107%'>voip push notification gateway</span></a><span style='font-size:9.0pt;line-height:107%'> (known as MPUSH) which will act as a SIP proxy between your SIP server and your SIP clients.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Above the standard SIP proxy functionality, the MPUSH gateways performs the following main tasks:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Store push notification related details about your softphones from the REGISTER sessions. This includes the client push token and optionally the client credentials as MD5 hash string</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Send a push notification (via Google or Apple cloud service) on incoming call or text message to the target device</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Might send the incoming INVITE or MESSAGE SIP signaling more times and for a longer period then specified in the SIP standards to make sure that your client has enough time to wake-up (upon the previously sent push notification) and be able to process the incoming request</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>All of these are done transparently with no changes required in your server configuration and the same module can be activated in our </span><a href="https://www.mizu-voip.com/Software/WebRTCtoSIP.aspx"><span style='font-size:9.0pt;line-height:107%'>WebRTC gateway</span></a><span style='font-size:9.0pt;line-height:107%'> and </span><a href="https://www.mizu-voip.com/Software/SIPSBC.aspx"><span style='font-size: 9.0pt;line-height:107%'>SIP SBC</span></a><span style='font-size:9.0pt; line-height:107%'> (so you don’t need a separate MPSUH gateway if you are using our MRTC gateway software or SBC).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>With other words, there are two ways to enable push notifications:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Direct: in case if your SIP server has support for push notifications (such as the mizu </span><a href="https://www.mizu-voip.com/Software/VoIPServer.aspx"><span style='font-size:9.0pt;line-height:107%'>VoIP server</span></a><span style='font-size:9.0pt;line-height:107%'>)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Via gateway: the SIP client must register via a push enabled proxy or gateway (such as the </span><a href="https://www.mizu-voip.com/Software/VoIPPushGateway.aspx"><span style='font-size:9.0pt;line-height:107%'>MPUSH</span></a><span style='font-size:9.0pt;line-height:107%'> gateway)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <h2><a name="_Toc117069556">Usage</a></h2> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>You will need to perform the following steps to add VoIP push notification capability for your SIP client apps:</span></p> <p class="MsoListParagraphCxSpFirst" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Install and configure your mizu server/gateway</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.0in;text-indent:-.25in'><span class="MsoHyperlink"><span style='font-size:9.0pt;line-height:107%;color:windowtext; text-decoration:none'>a.<span style='font:7.0pt "Times New Roman"'> </span></span></span><a href="start.htm#_Server"><span style='font-size:9.0pt; line-height:107%'>Install mizu server or gateway</span></a><span style='font-size:9.0pt;line-height:107%'> (you can download the VoIP PUSH specific gateway from </span><a href="https://www.mizu-voip.com/Portals/0/Files/MPUSH_Setup.exe"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size: 9.0pt;line-height:107%'>)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.0in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>b.<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_Gateway_configuration"><span style='font-size:9.0pt; line-height:107%'>Basic configuration</span></a><span style='font-size:9.0pt; line-height:107%'> (can be set in the “Configuration wizard” or in the global “Configurations” form) </span></p> <p class="MsoListParagraphCxSpLast" style='margin-left:1.0in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>c.<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_Configure_VoIP_push"><span style='font-size:9.0pt; line-height:107%'>Enable push notifications in your server/gateway</span></a><span style='font-size:9.0pt;line-height:107%'> (for MPUSH it is enabled by default, you just need to set your FCM package name and key in the Configurations and/or upload your Apple PushKit certificate) </span></p> <p class="MsoNormal" style='margin-left:.75in'><span style='font-size:9.0pt; line-height:107%'>Note: the FCM key and/or the Apple VoIP certificate might be configured later when you reach there at point 3 below</span></p> <p class="MsoListParagraphCxSpFirst" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Test basic gateway/SBC functionality: configure any SIP endpoint (IP phone or softphone such as </span><a href="https://counterpath.com/x-lite/"><span style='font-size:9.0pt;line-height:107%'>X-Lite</span></a><span style='font-size:9.0pt;line-height:107%'> or </span><a href="https://www.mizu-voip.com/Software/Softphones.aspx"><span style='font-size:9.0pt;line-height:107%'>MizuPhone</span></a><span style='font-size:9.0pt;line-height:107%'>)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.0in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>a.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>SIP server/domain: the MPUSH gateway or your push server address </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.0in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>b.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>SIP Username/password: any valid account/extension on your SIP server </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.0in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>c.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>The softphone should be able to connect/register and capable to make and receive call</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.0in'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Integrate push with your application(s)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.0in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>a.<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_SIP_client_integration"><span style='font-size:9.0pt; line-height:107%'>Add push notification support to your application</span></a><span style='font-size:9.0pt;line-height:107%'> (the related SIP signaling required changes are described </span><a href="start.htm#_SIP_signaling_1"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size: 9.0pt;line-height:107%'>). </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.0in'><span style='font-size:9.0pt;line-height:107%'>This point is where some work have to be done by you to add a few lines of code into your app(s).</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.0in'><span style='font-size:9.0pt;line-height:107%'>Your app will have to request for a push token and send it with the REGISTER requests in an </span><a href="start.htm#_X-MPUSH"><span style='font-size:9.0pt;line-height:107%'>X-MPUSH header</span></a><span style='font-size:9.0pt;line-height:107%'> or as defined in </span><a href="start.htm#_RFC_8599"><span style='font-size:9.0pt;line-height:107%'>RFC 8599</span></a><span style='font-size:9.0pt;line-height:107%'>.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.0in'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>4.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Test push notification functionality</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.0in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>a.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Check if your app register sends the push details with the REGISTER requests (X-MPUSH header or pn-* tags in the Contact header)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-left:1.0in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>b.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Close your app and make a call to it: the app should receive the push notification, it should wake-up then it should receive the incoming SIP INVITE and process the call as usually (ringing and capable to answer)</span></p> <h1><a name="_Toc117069557"></a><a name="_Server"></a><a name="_SIP_signaling"></a><b>Server</b></h1> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>You can use the Mizu Server side software to add push notification capabilities for any softphone (including your own third party softphones).</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>In case if you are using the Mizu Softswitch, then no special configuration is required as it already has push notification support by default.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>In case if you are using a third party SIP server (your own server such as Asterisk, 3CX, Cisco or any others), you can use our </span><a href="https://www.mizu-voip.com/Software/VoIPPushGateway.aspx"><span style='font-size:9.0pt;line-height:107%'>MPUSH gateway</span></a><span style='font-size:9.0pt;line-height:107%'> to add push notification support for your infrastructure which will act as a gateway/proxy between your app and your SIP sever. You can implement push notification support for your SIP network using any of the followings:</span></p> <p class="MsoListParagraphCxSpFirst" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://www.mizu-voip.com/Software/VoIPPushGateway.aspx"><span style='font-size:9.0pt;line-height:107%'>MPUSH gateway</span></a><span style='font-size:9.0pt;line-height:107%'> (this is a SIP proxy with the specific purpose to handle push notifications)</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://www.mizu-voip.com/Software/VoIPServer.aspx"><span style='font-size:9.0pt;line-height:107%'>VoIP server</span></a><span style='font-size:9.0pt;line-height:107%'> (running as an SBC as described </span><a href="start.htm#_Convert_to_gateway"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size:9.0pt;line-height:107%'>)</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://www.mizu-voip.com/Software/SIPSBC.aspx"><span style='font-size:9.0pt;line-height:107%'>SIP SBC</span></a><span style='font-size:9.0pt;line-height:107%'> (activating push notifications in our SBC can be done with a single configuration change)</span></p> <p class="MsoListParagraphCxSpLast" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://www.mizu-voip.com/Software/WebRTCtoSIP.aspx"><span style='font-size:9.0pt;line-height:107%'>WebRTC-SIP gateway</span></a><span style='font-size:9.0pt;line-height:107%'> (use this if you need also WebRTC support)<br> <br> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Both of the popular push notification service providers are supported: </span><a href="https://firebase.google.com/docs/cloud-messaging/"><span style='font-size:9.0pt;line-height:107%'>Google FCM</span></a><span style='font-size:9.0pt;line-height:107%'> and </span><a href="https://developer.apple.com/documentation/pushkit"><span style='font-size:9.0pt;line-height:107%'>Apple</span></a><span class="MsoHyperlink"><span style='font-size:9.0pt;line-height:107%'> APNS</span></span><span style='font-size:9.0pt;line-height:107%'>.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Follow these steps to configure push notification in Mizutech servers or gateways:</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>All the most important settings can be configured from the “Configuration Wizard”.<br> Some more advanced settings can be set from the “Configuration” form or by changing users (“Users and devices form” and routing (“Routing” form) settings, although these are rarely required.</span></p> <h2><a name="_Toc117069558"></a><a name="_Convert_to_gateway"></a><a name="_Gateway_configuration"></a>Gateway configuration</h2> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><u><span style='font-size:9.0pt;line-height:107%'>In short:</span></u></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Just follow the configuration wizard to have a fully working push gateway. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Take attention for the followings:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Network page: configure the server/gateway listener IP and ports correctly after your needs</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>SIP server page: configure the address of your SIP server correctly</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Push page: configure FCM keys and/or Apple pushkit certificate correctly</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>For FCM/PushKit details read </span><a href="start.htm#_Enable_VoIP_push"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size:9.0pt;line-height:107%'> and </span><a href="start.htm#_Configure_VoIP_push"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size:9.0pt;line-height:107%'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>A detailed documentation can be found </span><a href="https://www.mizu-voip.com/Portals/0/Files/SIP_SBC_Doc.pdf"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size: 9.0pt;line-height:107%'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><u><span style='font-size:9.0pt;line-height:107%'>Details:</span></u></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Once the gateway have been installed, the Admin client will automatically start the configuration wizard or you can launch it at any time from the “Config” menu. Go through the settings and set to the appropriate values. The most important thing to be set correctly is that gateway listening address and your SIP server address (you can also add more SIP server later in the routing).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>You can follow our </span><a href="https://www.mizu-voip.com/Portals/0/Files/SIP_SBC_Doc.pdf"><span style='font-size:9.0pt;line-height:107%'>SBC guide</span></a><span style='font-size:9.0pt;line-height:107%'> for general server configuration including for MPUSH gateway configuration.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>The main difference between a softswitch and MPUSH gateway are the followings:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Gateways are running as a SIP proxy, thus their configuration is much more simple. Usually you need to set-up once at the beginning and it will keep running with no maintenance needed</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Gateways don’t need any active management. You will continue to manage your users, routing, billing like you did it before: on your softswitch</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Users and devices are only a virtual concept on the gateway. Accounts are created on the fly (on first request from the user) and deleted automatically (if not used for some time) and used only for internally with no user credentials or details stored on the gateway (only the SIP username and the push notification token will be stored)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Authentications are performed transparently. When the client is connected, then the auth requests are forwarded transparently to the client. When the client is closed or sleeping then the gateway can continue to send REGISTER requests using the last known and stored MD5 checksum for the authentications, thus no clean passwords needs to be stored on the gateway</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Modules such as billing are missing on a gateway (your SIP server will remain responsible for this)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Users to user (IP to IP) sessions (calls, chat, presence and others) can be handled entirely by the gateway between the users registered via the gateway. This will free up your server resources. You can also disabled user to user routing if you wish, thus everything will go through your server</span></p> <p class="MsoListParagraphCxSpLast" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Some modules can be kept enabled to extend your SIP server features. For example if your SIP server is not good at RTP routing or NAT handling, then you can use the gateway as an SBC to do this task for you. Or you can exploit other gateway features like conference and text messaging</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Once the gateway have been installed and configured, review the push notification related settings </span><a href="start.htm#_Configure_VoIP_push"><span style='font-size: 9.0pt;line-height:107%'>here</span></a><span style='font-size:9.0pt;line-height: 107%'>.</span></p> <h2><a name="_Toc117069559"></a><a name="_Enable_VoIP_push"></a>Enable VoIP push notifications</h2> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>To setup push notifications in your Mizu Server or Gateway, all you need to do is to enable and configure push notifications from the Configuration Wizard.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>The Configuration Wizard is launched automatically when you first start the MManage admin client or you can launch it anytime later form Config menu from MManage -> Configuration Wizard. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>In the Configuration Wizard:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Make sure that the “PUSH” checkbox is checked on the “Roles and features” page (this step is not required for the MPUSH gateway as PUSH module is enabled by default)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Then configure push notifications after your needs on the “Push” page.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>The configuration wizard actually will just set a few global config settings:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>It will set the <span style='color:#833C0B'>pushnotification</span> config option to 1,2 or 3.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%; font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:black'>Then if you configure Google FCM then will set the </span><span style='font-size: 9.0pt;line-height:107%;color:#833C0B'>fcm_app</span><span style='font-size: 9.0pt;line-height:107%;color:black'> (your app package name) and </span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>fcm_key</span><span style='font-size:9.0pt;line-height:107%;color:black'> (FCM key).</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family: Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:black'>If you configure Apple APNS PushKit then it will ask for your </span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>certificate</span><span style='font-size:9.0pt;line-height:107%;color:black'> file which can be obtained as </span><span style='font-size:9.0pt;line-height:107%'>described </span><a href="start.htm#_Generate_a_VoIP"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size:9.0pt;line-height:107%;color:black'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span class="MsoHyperlink"><span style='font-size:9.0pt;line-height:107%;color:black'><span style='text-decoration:none'> </span></span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'>You can set or change these also manually anytime later from the “Configurations” form. The meaning of these parameters and other possible settings are described below.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>You can enable both FCM and PushKit/APNS at the same time and you can also configure multiple apps (described below).</span></p> <h2><a name="_Toc117069560"></a><a name="_Configure_VoIP_push"></a><a name="_Important_configuration_settings"></a>Important configuration settings</h2> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%'>The followings can be set also automatically by the VoIP server from the Config Wizard as described above, but worth to double check:</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Set the following global config options (MManage -> Configurations form) to enable push notifications in your server or gateway:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification</span><span style='font-size:9.0pt;line-height:107%'>: 2</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_chat</span><span style='font-size:9.0pt;line-height:107%'>: 2</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%'>Note: some of the settings might appear in the Configurations form only after you set the pushnotification to 2 and restart the service (Control menu -> Restart) or otherwise you can insert the records manually.</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>In case if you are using FCM (Google Firebase):</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_fcm</span><span style='font-size:9.0pt;line-height:107%'>: 1</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>fcm_app</span><span style='font-size:9.0pt;line-height:107%'>: your app package name</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>fcm_key</span><span style='font-size:9.0pt;line-height:107%'>: the FCM API key</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>In case if you have multiple applications, then you can configure them by <span style='color:#833C0B'>fcm_app1</span>/<span style='color:#833C0B'>fcm_key1</span>, <span style='color:#833C0B'>fcm_app2</span>/<span style='color:#833C0B'>fcm_key2</span> ... <span style='color:#833C0B'>fcm_appX</span>/<span style='color:#833C0B'>fcm_keyX</span> global config options where X is a number from 1 to 1000.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>In case if you are using PushKit (Apple/iOS APNS):</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_pushkit</span><span style='font-size:9.0pt;line-height:107%'>: 1</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Copy the VoIP push certificate into the server app folder as file name </span><span style='font-size:9.0pt;line-height:107%'>pushkit.p12/ pushkit.pem or renamed to</span><span style='font-size:9.0pt;line-height:107%'> pushkit.PACKAGENAME.p12 or pushkit.PACKAGENAME.pem.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt'><span style='font-size:9.0pt;line-height:107%'>(This certificate can be downloaded from Apple as described </span><a href="start.htm#_Generate_a_VoIP"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size: 9.0pt;line-height:107%'>. Replace PACKAGENAME with your app Bundle ID)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>In case if you have multiple iOS apps, save the certificate for each of them in your app folder as pushkit.PACKAGENAME.pem.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <h2><a name="_Toc117069561"></a><a name="_Advanced_configuration_options"></a>Advanced configuration options</h2> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Here we are listing all push notification related settings. Most of them has optimal default values (even if you don’t see their value in the configuration form). Change these only if you fully understand its meaning and the change is required for your specific use-case, otherwise leave them with their default values!</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification</span><span style='font-size:9.0pt;line-height:107%'>: enable/disable push notifications. -1: auto (if FCM keys or pushkit certs are found), 0: no, 1: yes, 2: always (even on high server load), 3=all endpoints. Default is -1.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_chat</span><span style='font-size:9.0pt;line-height:107%'>: pushnotification also for chat. -1: auto guess, 0=no,1=yes on low load,2,yes,3=always (even on high load). Default is -1/1.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_cancel</span><span style='font-size:9.0pt;line-height:107%'>: pushnotification also for cancel. 0=no,1=yes on low load,2,yes,3=always (even on high server load). Default is 0. Not recommended because cancel can be received in signaling and otherwise it would wake to app unnecessarily.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_fcm</span><span style='font-size:9.0pt;line-height:107%'>: enable/disable FCM -1=auto (check if fcm_app/fcm_key exists), 0=disable,1=enable</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_pushkit</span><span style='font-size:9.0pt;line-height:107%'>: enable/disable PushKit 0=disable,1=enable,2=also for android. Default is 0 (set explicitly to 1 if you wish to enable pushkit)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_websocket</span><span style='font-size:9.0pt;line-height:107%'>: enable/disable push subscribe from websocket connections (WebRTC clients). -1=auto, 0=disable, 1=enable</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_inviteretry</span><span style='font-size:9.0pt;line-height:107%'>: how much/long we try to send the INVITE. Default is 3 (which means 3x more times than the default SIP standards).</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_clientmaxoffline</span><span style='font-size:9.0pt;line-height:107%'>: days after the server will consider the client as permanently offline and will not send push notifications anymore if no any message received from the client for these numbers of days. Default is 30.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_disableunreg</span><span style='font-size:9.0pt;line-height:107%'>: disable unregistration from softphones with push notification support. 0: enable unregister, 1: disable unregister, 2: convert unregister to register. Default is 2.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_regrefresh</span><span style='font-size:9.0pt;line-height:107%'>: instead of keeping the upper server registrations, send push notification to wake up the app also to refresh its register binding: -1 auto (default; yes if no X-PIID SIP header is sent from your app), 0: no, 1: yes, 2: remove also push binding on register timeout</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_persists</span><span style='font-size:9.0pt;line-height:107%'>: will launch client reg endpoint on mserver startup. -1: auto (on servers with few users), 0: no, other: ep statusdate number of days. Default is -1.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_keepupperreg</span><span style='font-size:9.0pt;line-height:107%'>: keep upper server registrations and don’t unregister. 0: no, 1: keep register auto, 2: keep register always. Default is 1.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_removeon_regfail</span><span style='font-size:9.0pt;line-height:107%'>: remove push binding if upper server registrations fails (this is applied for gateways only). 0: no, 1: yes. Default is 1.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_removeon_subscallfail</span><span style='font-size:9.0pt;line-height:107%'>: remove binding bind on subsequent call failure. 0: no, 1: yes. Default is -1 which means 0 for gateways and 1 for servers.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_removeon_pushfail</span><span style='font-size:9.0pt;line-height:107%'>: remove push binding if fails to send push notification. 0: no, 1: yes. Default is 1.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_removeon_noanswer</span><span style='font-size:9.0pt;line-height:107%'>: remove push binding if endpoint doesn’t respond for requests. 0: no, 1: yes. Default is -1 which means 0 for gateways and 1 for servers.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_removeon_reject</span><span style='font-size:9.0pt;line-height:107%'>: remove push binding if caller user is rejected for any reason such as banned. 0: no, 1: yes. Default is 1.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_upperexpire</span><span style='font-size:9.0pt;line-height:107%'>: upper server expire interval. -1 means no change. others: specify. Default is 3600 which means one hour (you might change it to 86400 if your server has support for one day expire).</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>rebuildregclients</span><span style='font-size:9.0pt;line-height:107%;color:black'>: specify the interval in seconds to verify upper registrations and relaunch if needed. Default is 3600 (one hour)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_ttl</span><span style='font-size:9.0pt;line-height:107%'>: time to live for the push notifications. 0: now or never, 1+: other value in seconds. Default is 0.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_teamid</span><span style='font-size:9.0pt;line-height:107%'>: remote teamid from packagename (first part of the pushkit apns pn-param): -1: auto, 0: no, 1: yes. Default is -1.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_teamidstr</span><span style='font-size:9.0pt;line-height:107%'>: the team id string is usually “.voip”. If yours differs, you can set it with this setting</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_apnspushtype</span><span style='font-size:9.0pt;line-height:107%'>: the apns-push-type is set the “voip” for calls and “alert” for other notifications by default. In case if you wish to force something different, then you can set it with this setting</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_topic</span><span style='font-size:9.0pt;line-height:107%'>: specify the apns-topic to be set (otherwise calculated automatically from packagename/teamid/pushtype). usually it is "voip". possible values: "voip", "alert", "null" (to don't send any apns-topic) or any other string which match your certificate</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>fcm_serverurl</span><span style='font-size:9.0pt;line-height:107%'>: the FCM cloud service URL. Default is: https://fcm.googleapis.com/fcm/send</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushkit_serverurl_legacy</span><span style='font-size:9.0pt;line-height:107%'>: the Apple PushKit cloud service URL for the legacy binary protocol. Default is: gateway.push.apple.com:2195 (For testing/development you might set to: gateway.sandbox.push.apple.com:2195)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushkit_serverurl_http2</span><span style='font-size:9.0pt;line-height:107%'>: the Apple PushKit cloud service URL for the new HTTP/2 protocol. Default is: api.push.apple.com (For testing/development you might set to: api.development.push.apple.com)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushkit_port</span><span style='font-size:9.0pt;line-height:107%'>: internal udp listen port in the pushkit process. Default is: 61111</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushkit_localport</span><span style='font-size:9.0pt;line-height:107%'>: internal udp bind port in the mserver toward pushkit. Default is: 61110</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushkit_protocol</span><span style='font-size:9.0pt;line-height:107%'>: PushKit/Apple APNS protocol. -1: auto, 0: binary protocol 0, 1: </span><a href="https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/LegacyNotificationFormat.html#//apple_ref/doc/uid/TP40008194-CH14-SW1"><span style='font-size:9.0pt;line-height:107%'>binary protocol 1</span></a><span style='font-size:9.0pt;line-height:107%'>, 2: </span><a href="https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns/"><span style='font-size:9.0pt;line-height:107%'>HTTP/2</span></a><span style='font-size:9.0pt;line-height:107%'>. Default is -1 which means binary 1 until November 2020 and HTTP/2 after.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushkit_sslcertpassword</span><span style='font-size:9.0pt;line-height:107%'>: pushkit voip certificate password if required (for example if you supply a password protected pkcs12 certificate)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>prefermd5xauth</span><span style='font-size:9.0pt;line-height:107%'>: Set to 1 if the server should prefer to answer the auth request itself from the X-PIID received from client (if any). Set to 0 if the server should prefer to forward the auth requests to the client</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>fcm_app</span><span style='font-size:9.0pt;line-height:107%'>: default FCM app package name</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>fcm_key</span><span style='font-size:9.0pt;line-height:107%'>: default FCM server API key</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>fcm_app1</span><span style='font-size:9.0pt;line-height:107%'>: additional FCM app package name</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>fcm_key1</span><span style='font-size:9.0pt;line-height:107%'>: additional FCM server API key</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>fcm_app2</span><span style='font-size:9.0pt;line-height:107%'>: additional FCM app package name</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>fcm_key2</span><span style='font-size:9.0pt;line-height:107%'>: additional FCM server API key</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>...</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>fcm_appX</span><span style='font-size:9.0pt;line-height:107%'>: additional FCM app package name</span></p> <p class="MsoListParagraphCxSpLast" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>fcm_keyX</span><span style='font-size:9.0pt;line-height:107%'>: additional FCM server API key</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Note: some of the above options might appear only after you have set the </span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification</span><span style='font-size:9.0pt;line-height:107%'> config to 1, 2 or 3 and restart the service (or reload the settings). You can also insert them manually with the + (plus sign) button on the Configurations form.</span></p> <h2><a name="_Toc117069562"></a><a name="_VoIP_push_notification"></a>VoIP push notification messages</h2> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>The message sent by the Mizutech server or gateway can be configured by rewriting the following text files: fcmmessage.txt, pushkitmessage.txt (This file can be found in the server app folder which is located by default at C:\Program Files (x86)\MPUSH\ or open the folder from MManage -> File menu -> Folders -> Server App directory)</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>The default message format is already optimized for VoIP (minimum delay, compatible with all platforms). Change it only if necessary for your specific use case.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>The following keywords are replaced automatically at runtime:</span></p> <p class="MsoListParagraphCxSpFirst" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>PACKAGE</span><span style='font-size:9.0pt;line-height:107%'>: your app package as received from X-MPUSH or pn-param in a previous REGISTER</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>TOKEN</span><span style='font-size:9.0pt;line-height:107%'>: target user token as received from X-MPUSH or pn-prid in a previous REGISTER</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>TO</span><span style='font-size:9.0pt;line-height:107%'>: called user name (callee)</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>TYPE</span><span style='font-size:9.0pt;line-height:107%'>: 0=call,1=chat,2=cancel,3=custom message,4=refresh register binding</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>FROM</span><span style='font-size:9.0pt;line-height:107%'>: caller/sender full name</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>FROMUSERNAME</span><span style='font-size:9.0pt;line-height:107%'>: caller/sender username (caller id)</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>FROMDISPLAYNAME</span><span style='font-size:9.0pt;line-height:107%'>: caller/sender displayname </span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>CALLID</span><span style='font-size:9.0pt;line-height:107%'>: SIP Call-ID of the incoming call or message</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>APRIORITY</span><span style='font-size:9.0pt;line-height:107%'>: apn message priority number. 10 means immediately</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>PRIORITY</span><span style='font-size:9.0pt;line-height:107%'>: message priority. Default is “high”</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>TTLNUM</span><span style='font-size:9.0pt;line-height:107%'>: time to live (def to 0 for immediate delivery)</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>PUSHTYPE</span><span style='font-size:9.0pt;line-height:107%'>: message type. Default value is “voip”</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>SOUND</span><span style='font-size:9.0pt;line-height:107%'>: notification sound file to be played (you might instead play a sound from your app if required)</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>MSG</span><span style='font-size:9.0pt;line-height:107%'>: chat message text/body</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>MESSAGE</span><span style='font-size:9.0pt;line-height:107%'>: notification text (for call it looks like: Incoming VoIP call from FROM)</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>TITLE</span><span style='font-size:9.0pt;line-height:107%'>: message title (for calls it looks like: Call from FROMUSERNAME)</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>BODY</span><span style='font-size:9.0pt;line-height:107%'>: message body (for calls it looks like Incoming VoIP call from FROM)</span></p> <p class="MsoListParagraphCxSpLast"><span style='font-size:9.0pt;line-height: 107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>For FCM the message is defined in the <b>fcmmessage.txt</b> file which can be found in the app folder and you can edit it after your needs. <br> The possibilities are described </span><a href="https://firebase.google.com/docs/cloud-messaging/concept-options"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size: 9.0pt;line-height:107%'> and </span><a href="https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size: 9.0pt;line-height:107%'>.<br> The default message looks like this:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'>{</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'>"message":</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'>{</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "to" : "TO",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "token" : "TOKEN",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "priority" : "high",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "content_available" : true,</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "time_to_live" : TTLNUM,</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "data" : </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "ntype" : TYPE, </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "nfromusername" : "FROMUSERNAME",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "nfrom" : "FROM", </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "nmsg" : "MSG",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "ncallid": "CALLID",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "ntousr": "TOUSERNAME"</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> },</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "android" : </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "priority" : "high", </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "ttl" : "TTLNUMs"</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> }, </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "webpush" : </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "headers" : </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "TTL" : "TTLNUM",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "Urgency": "PRIORITY"</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> } </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> }, </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "apns" : </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "headers" : </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "apns-priority" : APRIORITY,</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "apns-expiration" : TTLNUM,</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "apns-push-type" : "PUSHTYPE",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "apns-topic": "PACKAGE.voip"</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> },</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "payload" : </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "aps" : </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "alert" : </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "title" : "TITLE",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "body" : "BODY" </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> },</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "content-available" : 1,</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "sound" : "SOUND"</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> },</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "aps" : </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "content-available" : 1,</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "sound" : "SOUND",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "alert" : </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "title" : "TITLE",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "body" : "BODY" </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'>}</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'>}</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>For Apple APNS/PushKit the message is defined in the <b>pushkitmessage.txt</b> file which can be found in the app folder. <br> The possibilities are described </span><a href="https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns/"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size: 9.0pt;line-height:107%'>, </span><a href="https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CreatingtheNotificationPayload.html#//apple_ref/doc/uid/TP40008194-CH10-SW1"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size: 9.0pt;line-height:107%'> and </span><a href="https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/PayloadKeyReference.html#//apple_ref/doc/uid/TP40008194-CH17-SW1"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size: 9.0pt;line-height:107%'>.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>The default message looks like this:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'>{</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "headers" : </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "apns-priority" : "10",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "apns-expiration" : TTLNUM,</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "apns-push-type" : "PUSHTYPE",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "apns-topic": "PACKAGE.voip"</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> },</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "aps" : </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "alert" : </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "title" : "TITLE",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "body" : "BODY" </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> },</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "content-available" : 1,</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "sound" : "SOUND",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "badge" : 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> },</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "data" : </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "ntype" : TYPE, </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "nfromusername" : "FROMUSERNAME",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "nfrom" : "FROM", </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "nmsg" : "MSG",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "ncallid": "CALLID",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> "ntousr": "TOUSERNAME"</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:6.0pt;line-height:107%;color:#833C0B'>}</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Usually for applications only the data section is important as you can extract all the important details from there and process it after your needs (launch the application or display notification).</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <h2><a name="_Toc117069563">Monitoring</a></h2> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>For general monitoring, check the Dashboard, Analyze, CDR, Registrar and Logs forms in the MManage admin client.<br> For example you can list the upper server registrations (toward your server) from the Registrar form “Upper Succ” option.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Important push notification issues and events can be listed on the “Logs” form.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Statistics about push notifications can be obtained from Console menu -> Push Stats (or with the “pushstat” command sent from the “Server Console” form).</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Push activated users can be quickly listed by right clicking to “Users and devices” node and select the List -> “Users with Push” popup item or from inside the “Users and devices” form right click on the “Enduser” node and select the List -> “Push enabled” popup item.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Detailed logs can be found at </span><span style='font-size:9.0pt;line-height:107%'>File menu -> Folders -> Server Logs Directory (search for Call-ID or username in the last *log.dat file and in puskit.log).</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>See the </span><a href="https://www.mizu-voip.com/Portals/0/Files/SIP_SBC_Doc.pdf"><span style='font-size:9.0pt;line-height:107%'>SBC documentation</span></a><span style='font-size:9.0pt;line-height:107%'> for more details abut basic usage. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>In case if push notifications doesn’t work as expected, see the </span><a href="start.htm#_FAQ"><span style='font-size:9.0pt'>FAQ</span></a><span style='font-size:9.0pt'> for troubleshooting. Contact Mizutech </span><a href="mailto:support@mizu-voip.com"><span style='font-size:9.0pt'>support</span></a><span style='font-size:9.0pt'> if needed.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <h1><a name="_Toc117069564"></a><a name="_SIP_client_integration"></a><a name="_Client"></a><b>Client</b></h1> <p class="MsoNormal"> </p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>This chapter is about adding VoIP notification support for your application(s).</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Once your server/gateway is running with push notification enabled, you need to prepare your SIP client to send its token to the server/gateway with REGISTER and to handle the incoming push notifications.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>In this chapter we present the usual configurations and required changes for all the important platforms. You can jump to the section relevant to your app and follow the step-by-step instructions.</span></p> <h2><a name="_Toc117069565"></a><a name="_Generic_Step-by-step_instructions"></a>Generic Instructions</h2> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>You will need to implement the followings in your app(s) step-by-step:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Configure </span><a href="start.htm#_Create_a_Firebase"><span style='font-size:9.0pt;line-height:107%'>Google Firebase</span></a><span style='font-size:9.0pt;line-height:107%'> or </span><a href="start.htm#_Generate_a_VoIP"><span style='font-size:9.0pt;line-height:107%'>iOS pushkit</span></a><span style='font-size:9.0pt;line-height:107%'> (or other provider)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Use your OS API to get a push token (</span><a href="start.htm#_Get_the_device"><span style='font-size: 9.0pt;line-height:107%'>Google Firebase/FCM registration token</span></a><span style='font-size:9.0pt;line-height:107%'> or </span><a href="start.htm#_Setting_the_background"><span style='font-size:9.0pt;line-height:107%'>Apple APNS pushkit device token</span></a><span style='font-size:9.0pt;line-height: 107%'> or other such as generic webpush)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Configure the server/gateway according to your application settings and push notification provider as discussed </span><a href="start.htm#_Server"><span style='font-size:9.0pt; line-height:107%'>above</span></a><span style='font-size:9.0pt;line-height: 107%'>:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.75in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;color:black'>a.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>if you are using FCM then set the <span style='color:#833C0B'>fcm_key </span>and <span style='color:#833C0B'>fcm_app </span>global <span style='color:black'>config options</span></span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.75in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;color:black'>b.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:black'>if you are using PushKit then copy the certificate to the server app directory as </span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushkit.p12</span><span style='font-size:9.0pt;line-height:107%;color:black'> as </span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushkit.APPID.p12.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.75in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;color:black'>c.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:black'>you can use both Google FCM and Apple PushKit (for example if you have both an Android and iOS app)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>4.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>If you are using the gateway or SBC then you need to configure your SIP client to use the gateway as the SIP proxy (not your SIP server)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>5.<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_SIP_signaling"><span style='font-size:9.0pt; line-height:107%'>Send the token</span></a><span style='font-size:9.0pt; line-height:107%'> to the MPUSH gateway/SBC or server with the SIP REGISTER requests with the X-MPUSH header or as described in RFC 8599.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>6.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Handle the incoming </span><a href="start.htm#_Adding_the_code"><span style='font-size:9.0pt; line-height:107%'>APNS</span></a><span style='font-size:9.0pt;line-height:107%'> or </span><a href="start.htm#_Receive_and_handle"><span style='font-size:9.0pt; line-height:107%'>FCM</span></a><span style='font-size:9.0pt;line-height:107%'> (or other) push notifications which will come before calls/messages (and will wake-up your app if not running)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.75in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>a.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>on call: wake-up the application and process the incoming call (SIP INVITE) as normally (alert the user)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-left:.75in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>b.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>on IM: wake-up the application and process the incoming chat (SIP MESSAGE) as normally (display the chat message)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#833C0B'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>These are discussed in the below chapters in details with exact description for each major OS/platform. </span></p> <h2><a name="_Toc117069566"></a><a name="_Android"></a>Android</h2> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Follow these steps to add Firebase (FCM) push notifications to your Android application. This can be a native Android app developed in Android Studio, Eclipse or other IDE or applications created by Xamarin or React Native using any SIP stack.</span></p> <p class="MsoNormal"><i><span style='font-size:9.0pt;line-height:107%'>In case if you are using the Mizu </span></i><a href="https://www.mizu-voip.com/Software/SIPSDK/AndroidSIPSDK.aspx"><i><span style='font-size:9.0pt;line-height:107%'>Android SIP library</span></i></a><i><span style='font-size:9.0pt;line-height:107%'> then jump </span></i><a href="start.htm#_AJVoIP"><i><span style='font-size:9.0pt;line-height:107%'>here</span></i></a><i><span style='font-size:9.0pt;line-height:107%'>.</span></i></p> <h4><a name="node0" id="node0"></a>In short</h4> <p class="MsoListParagraphCxSpFirst" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Create a Firebase project and add its json config file to your project. Also add your server key and package name to the Mizu server global config (<span style='color:black'>fcm_key and fcm_app</span>)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Implement Firebase as described </span><a href="https://console.firebase.google.com/"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size: 9.0pt;line-height:107%'>, </span><a href="https://firebase.google.com/docs/cloud-messaging/"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size: 9.0pt;line-height:107%'> and </span><a href="https://firebase.google.com/docs/cloud-messaging/android/client"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size: 9.0pt;line-height:107%'> (Firebase registration and handling the push notifications)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>SIP signaling changes: implement RFC 8599 or send the X-MPUSH and X-PIID SIP headers with the REGISTER requests in the SIP signaling</span></p> <h4><a name="node1" id="node1"></a>Prerequisites</h4> <p class="MsoListParagraphCxSpFirst" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>A device running Android 4.0 (Ice Cream Sandwich) or newer, and Google Play services 11.8.0 or higher</span></p> <p class="MsoListParagraphCxSpLast" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>The latest version of </span><a href="https://developer.android.com/studio/index.html"><span style='font-size:9.0pt;line-height:107%'>Android Studio</span></a><span style='font-size:9.0pt;line-height:107%'> (You can also use other IDE such as Eclipse, however this guide is guide is for Android Studio)</span></p> <h4><a name="node2" id="node2"></a>Online resources</h4> <p class="MsoListParagraphCxSpFirst" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://console.firebase.google.com/"><span style='font-size:9.0pt;line-height:107%'>Firebase console</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span class="MsoHyperlink"><span style='font-size:9.0pt;line-height:107%;font-family: Symbol;color:windowtext;text-decoration:none'>·<span style='font:7.0pt "Times New Roman"'> </span></span></span><a href="https://firebase.google.com/docs/cloud-messaging/"><span style='font-size:9.0pt;line-height:107%'>FCM Messaging</span></a><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://firebase.google.com/docs/cloud-messaging/android/client"><span style='font-size:9.0pt;line-height:107%'>Add FCM support to Android project</span></a></p> <p class="MsoListParagraphCxSpLast" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://www.codementor.io/flame3/send-push-notifications-to-android-with-firebase-du10860kb"><span style='font-size:9.0pt;line-height:107%'>Tutorial</span></a></p> <h4><a name="_Create_a_Firebase"></a>Create a Firebase project</h4> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>To add Firebase to your app you'll need a Firebase project and a Firebase configuration file for your app.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Create a Firebase project in the </span><a href="https://console.firebase.google.com/"><span style='font-size:9.0pt;line-height:107%'>Firebase console</span></a><span style='font-size:9.0pt;line-height:107%'>, if you don't already have one. If you already have an existing Google project associated with your mobile app, click <b>Import Google Project</b>. Otherwise, click <b>Add project</b>.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in'><i><span style='font-size:8.0pt;line-height:107%'>2.<span style='font:7.0pt "Times New Roman"'> </span></span></i><span style='font-size:9.0pt;line-height:107%'>Click <b>Add Firebase to your Android app</b> and follow the setup steps. <br> </span><i><span style='font-size:8.0pt;line-height:107%'>If you're importing an existing Google project, this may happen automatically and you can just </span></i><a href="http://support.google.com/firebase/answer/7015592"><i><span style='font-size:8.0pt;line-height:107%'>download the config file</span></i></a><i><span style='font-size:8.0pt;line-height:107%'>.</span></i></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>When prompted, enter your app's package name. It is important to enter the package name your app is using; this can only be set when you add an app to your Firebase project.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>4.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>At the end, you'll download a google-services.json file. You can </span><a href="http://support.google.com/firebase/answer/7015592"><span style='font-size:9.0pt;line-height:107%'>download this file</span></a><span style='font-size:9.0pt;line-height:107%'> again at any time.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>5.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>If you haven't done so already, copy this into your project's module folder, typically app.</span></p> <p class="MsoNormal" align="center" style='text-align:center'><span style='font-size:9.0pt;line-height:107%'><img border="0" width="447" height="410" src="VOIP_Push_notifications_files/image002.jpg"></span></p> <h4><a name="node3" id="node3"></a>Configure Firebase for your app</h4> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>To integrate the Firebase libraries into one of your own Android softphone project, you need to add Firebase to your Android project. This can be done in the following way:</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>First, add rules to your root-level build.gradle file, to include the google-services plugin and the Google's Maven repository:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;background:white'><span style='font-size:9.0pt;font-family:"Courier New"; color:black'>buildscript {<br> repositories {<br> jcenter()<br> google()<br> }<br> dependencies {<br> </span><b><span style='font-size:9.0pt;font-family:"Courier New";color:green'> </span></b><span style='font-size:9.0pt;font-family:"Courier New";color:black'>classpath </span><b><span style='font-size:9.0pt;font-family:"Courier New";color:green'>'com.google.gms:google-services:3.0.0'<br> </span></b><span style='font-size:9.0pt;font-family:"Courier New"; color:black'>}<br> }<br> <br> allprojects {<br> repositories {<br> jcenter()<br> google()<br> }<br> }</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Then, in your module Gradle file (usually the app/build.gradle), add firebase messaging to dependencies and the apply plugin line at the bottom of the file to enable the Gradle plugin:</span></p> <pre style='background:white'><span style='font-size:9.0pt;color:black'>//...</span></pre><pre style='background:white'><span style='font-size:9.0pt;color:black'>dependencies {<br> compile </span><b><span style='font-size:9.0pt;color:green'>'com.google.firebase:firebase-messaging:10.0.1'</span></b><span style='font-size:9.0pt;color:black'><br> }<br> apply </span><b><span style='font-size:9.0pt;color:green'>plugin</span></b><span style='font-size:9.0pt;color:black'>: </span><b><span style='font-size:9.0pt; color:green'>'com.google.gms.google-services'</span></b></pre><pre style='background:white'><span style='font-size:9.0pt;color:black'> </span></pre><pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif; color:black'>Also, be sure to set <i>minSdkVersion 9</i> or higher in the app's build.gradle to support FCM.</span></pre> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <h4><a name="node4" id="node4"></a>Manifest configuration</h4> <p class="MsoNormal"> </p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Add the following Services to your Android Manifest:</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>A service that extends FirebaseMessagingService. This provides the functionality to receive notifications.</span></p> <pre><span class="tag"><span style='font-size:9.0pt'><service</span></span><span style='font-size:9.0pt'><br> <span class="pln"> </span><span class="atn">android:name</span><span class="pun">=</span><span class="atv">".MyFirebaseMessagingService"</span><span class="tag">></span><br> <span class="pln"> </span><span class="tag"><intent-filter></span><br> <span class="pln"> </span><span class="tag"><action</span><span class="pln"> </span><span class="atn">android:name</span><span class="pun">=</span><span class="atv">"com.google.firebase.MESSAGING_EVENT"</span><span class="tag">/></span><br> <span class="pln"> </span><span class="tag"></intent-filter></span><br> <span class="tag"></service></span></span></pre> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>A service that extends FirebaseInstanceIdService to handle the creation, rotation, and updating of registration tokens.</span></p> <pre><span class="tag"><span style='font-size:9.0pt'><service</span></span><span style='font-size:9.0pt'><br> <span class="pln"> </span><span class="atn">android:name</span><span class="pun">=</span><span class="atv">".MyFirebaseInstanceIDService"</span><span class="tag">></span><br> <span class="pln"> </span><span class="tag"><intent-filter></span><br> <span class="pln"> </span><span class="tag"><action</span><span class="pln"> </span><span class="atn">android:name</span><span class="pun">=</span><span class="atv">"com.google.firebase.INSTANCE_ID_EVENT"</span><span class="tag">/></span><br> <span class="pln"> </span><span class="tag"></intent-filter></span><br> <span class="tag"></service></span></span></pre><pre><span style='font-size:9.0pt'> </span></pre> <h4><a name="_Get_the_device"></a>Get the device registration token</h4> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>On initial startup of your softphone, the FCM SDK generates a registration token for the client app instance. This token will be used later by the FCM server to send notifications to a specific device. To retrieve the current token, call </span><a href="https://firebase.google.com/docs/reference/android/com/google/firebase/iid/FirebaseInstanceId.html#public-methods"><span style='font-size:9.0pt;line-height:107%'>FirebaseInstanceId.getInstance().getToken()</span></a><span style='font-size:9.0pt;line-height:107%'>. This method returns null if the token has not yet been generated.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Below is the implementation of </span><span class="atv"><span style='font-size:9.0pt; line-height:107%'>MyFirebaseInstanceIDService used for receiving the token updates:</span></span></p> <pre style='background:white'><b><span style='font-size:9.0pt;color:navy'>import </span></b><span style='font-size:9.0pt;color:black'>com.google.firebase.iid.FirebaseInstanceId;<br> </span><b><span style='font-size:9.0pt;color:navy'>import </span></b><span style='font-size:9.0pt;color:black'>com.google.firebase.iid.FirebaseInstanceIdService;<br> <br> </span><b><span style='font-size:9.0pt;color:navy'>public class </span></b><span style='font-size:9.0pt;color:black'>MyFirebaseInstanceIDService </span><b><span style='font-size:9.0pt;color:navy'>extends </span></b><span style='font-size: 9.0pt;color:black'>FirebaseInstanceIdService<br> {<br> </span><span style='font-size:9.0pt;color:olive'>@Override<br> </span><b><span style='font-size:9.0pt;color:navy'>public void </span></b><span style='font-size:9.0pt;color:black'>onTokenRefresh()<br> {<br> </span><i><span style='font-size:9.0pt;color:gray'>// Get updated token and store it<br> </span></i><span style='font-size:9.0pt;color:black'>String updatedToken = FirebaseInstanceId.<i>getInstance</i>().getToken();<br> }<br> <br> }</span></pre><pre style='background:white'><span style='font-size:9.0pt; color:black'> </span></pre><pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>Note: the token might change at device reboots. You might cache the old one, but try to request at very startup and update it if changed. It might be possible that you receive the token with a big delay (handle it asynchronously and make sure to don’t set your variable with an empty token).</span></pre> <h4><a name="node5" id="node5"></a>Configure the server or gateway</h4> <pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>You need to set the following global config options (from the “Configurations” form):</span></pre><pre style='margin-left:.5in;text-indent:-.25in;background:white'><span style='font-size:9.0pt;font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>pushnotification_fcm: set to 1</span></pre><pre style='margin-left:.5in;text-indent:-.25in;background:white'><span style='font-size:9.0pt;font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>fcm_key: your FCM server key</span></pre><pre style='margin-left:.5in;text-indent:-.25in;background:white'><span style='font-size:9.0pt;font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>fcm_app: your app package name</span></pre><pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif; color:black'> </span></pre><pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>The FCM server key must be loaded from </span><a href="https://console.firebase.google.com/"><span style='font-size:9.0pt; font-family:"Calibri",sans-serif'>firebase console</span></a><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'> -> Project settings (gear icon in the top left near the “Project Overview”) -> Cloud Messaging page -> Cloud Messaging API (Legacy) section -> <b>Server key</b>.<br> <i>(So it is NOT the “Web API Key” from the General page and NOT they “Key pair” and NOT the old “Legacy server key” …this latter might not be displayed anymore on the website).</i></span></pre><pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif; color:black'> </span></pre><pre style='text-align:center;background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'><img border="0" width="511" height="323" src="VOIP_Push_notifications_files/image003.jpg"></span></pre><pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif; color:black'> </span></pre><pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>If you have more then one Android applications, then you can add multiple fcm_key/fcm_app combinations appending a number after the keys like </span></pre><pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif; color:black'>fcm_key1/fcm_app1 for your first app and fcm_key2/fcm_app2 for the second app (up to 1000).</span></pre><pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif; color:black'> </span></pre> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>More details about the server configuration can be found </span><a href="start.htm#_Configure_VoIP_push"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size:9.0pt;line-height:107%'>.</span></p> <h4><a name="node6" id="node6"></a>Register to server or gateway</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>You will need to send your app package name and token to the server with SIP REGISTER requests. For this you can implement </span><a href="start.htm#_RFC_8599"><span style='font-size:9.0pt;line-height:107%'>RFC 8599</span></a><span style='font-size:9.0pt;line-height:107%'> or send the </span><a href="start.htm#_X-PUSH"><span style='font-size:9.0pt;line-height:107%'>X-MPUSH</span></a><span style='font-size:9.0pt;line-height:107%;color:black'> (with the provider set to “</span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>a</span><span style='font-size:9.0pt;line-height:107%;color:black'>”)</span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> </span><span style='font-size:9.0pt;line-height:107%'>and <span style='color:#833C0B'>X-PIID </span>SIP headers with the REGISTER requests in the SIP signaling.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>All the details are described in the </span><a href="start.htm#_SIP_signaling_1"><span style='font-size:9.0pt;line-height:107%'>SIP Signaling chapter</span></a><span style='font-size:9.0pt;line-height:107%'>.</span></p> <h4><a name="_Receive_and_handle"></a>Receive and handle notifications</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>On </span><a href="start.htm#_VoIP_push_notification"><span style='font-size:9.0pt;line-height:107%'>incoming notification</span></a><span style='font-size:9.0pt;line-height:107%'> your app might do the followings:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>On text message (chat): just display it as a notification (user can tap on it to launch your app and see more details)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>On call: just wake-up the app (once your app is started, it will auto-register and it will receive the incoming INVITE thus it can handle the incoming call as normally)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>You can also handle other events if you have some specific needs (call cancel and custom messages)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>We are using the Java language for the below example code. You can follow the same logic with other language such as Kotlin.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>To receive notifications we need to implement </span><span class="atv"><i><span style='font-size:9.0pt;line-height:107%'>MyFirebaseMessagingService.</span></i></span><span class="atv"><span style='font-size:9.0pt;line-height:107%'> Below is an example of that:</span></span></p> <pre style='background:white'><b><span style='font-size:9.0pt;color:navy'>import </span></b><span style='font-size:9.0pt;color:black'>com.google.firebase.messaging.FirebaseMessagingService;<br> </span><b><span style='font-size:9.0pt;color:navy'>import </span></b><span style='font-size:9.0pt;color:black'>com.google.firebase.messaging.RemoteMessage;<br> </span><b><span style='font-size:9.0pt;color:navy'>import </span></b><span style='font-size:9.0pt;color:black'>java.util.Map;<br> <br> </span><b><span style='font-size:9.0pt;color:navy'>public class </span></b><span style='font-size:9.0pt;color:black'>MyFirebaseMessagingService </span><b><span style='font-size:9.0pt;color:navy'>extends </span></b><span style='font-size: 9.0pt;color:black'>FirebaseMessagingService<br> {<br> </span><span style='font-size:9.0pt;color:olive'>@Override<br> </span><b><span style='font-size:9.0pt;color:navy'>public void </span></b><span style='font-size:9.0pt;color:black'>onMessageReceived(RemoteMessage remoteMessage)<br> {<br> </span><i><span style='font-size:9.0pt;color:gray'> </span></i><b><span style='font-size:9.0pt;color:navy'>if </span></b><span style='font-size:9.0pt; color:black'>(remoteMessage != </span><b><span style='font-size:9.0pt; color:navy'>null </span></b><span style='font-size:9.0pt;color:black'>&& remoteMessage.getData().size() > </span><span style='font-size:9.0pt;color:blue'>0</span><span style='font-size:9.0pt; color:black'>)<br> {</span></pre><pre style='background:white'><i><span style='font-size: 9.0pt;color:gray'> // ex: {nfrom=1002, ntype=0}</span></i><span style='font-size:9.0pt;color:black'><br> Map<String, String> data = remoteMessage.getData();</span><i><span style='font-size:9.0pt;color:gray'><br> </span></i><b><span style='font-size:9.0pt;color:navy'>if </span></b><span style='font-size:9.0pt;color:black'>(data != </span><b><span style='font-size: 9.0pt;color:navy'>null</span></b><span style='font-size:9.0pt;color:black'>)<br> {<br> Log.v(LOG_TAG, </span><b><span style='font-size:9.0pt; color:green'>" FCM onMessageReceived message: " </span></b><span style='font-size:9.0pt;color:black'>+ data.toString());</span></pre><pre style='background:white'><span style='font-size:9.0pt;color:black'><br> String ntype = data.get(</span><b><span style='font-size:9.0pt; color:green'>"ntype"</span></b><span style='font-size:9.0pt; color:black'>); </span><i><span style='font-size:9.0pt;color:gray'>// ntype: 0=call, 1=message<br> </span></i><span style='font-size:9.0pt;color:black'>String nfrom = data.get(</span><b><span style='font-size:9.0pt;color:green'>"nfrom"</span></b><span style='font-size:9.0pt;color:black'>);<br> String nmsg = data.get(</span><b><span style='font-size:9.0pt; color:green'>"nmsg"</span></b><span style='font-size:9.0pt; color:black'>);<br> <br> </span><b><span style='font-size:9.0pt;color:navy'>if </span></b><span style='font-size:9.0pt;color:black'>(ntype == </span><b><span style='font-size: 9.0pt;color:navy'>null</span></b><span style='font-size:9.0pt;color:black'>) ntype = </span><b><span style='font-size:9.0pt;color:green'>"0"</span></b><span style='font-size:9.0pt;color:black'>;<br> </span><b><span style='font-size:9.0pt;color:navy'>if </span></b><span style='font-size:9.0pt;color:black'>(nfrom == </span><b><span style='font-size: 9.0pt;color:navy'>null</span></b><span style='font-size:9.0pt;color:black'>) nfrom = </span><b><span style='font-size:9.0pt;color:green'>""</span></b><span style='font-size:9.0pt;color:black'>;<br> </span><b><span style='font-size:9.0pt;color:navy'>if </span></b><span style='font-size:9.0pt;color:black'>(nmsg == </span><b><span style='font-size: 9.0pt;color:navy'>null</span></b><span style='font-size:9.0pt;color:black'>) nmsg = </span><b><span style='font-size:9.0pt;color:green'>""</span></b><span style='font-size:9.0pt;color:black'>;</span></pre><pre style='background:white'><span style='font-size:9.0pt;color:black'> </span></pre><pre style='background: white'><span style='font-size:9.0pt;color:black'> ProcessNotification(ntype, nfrom, nmsg);<br> <br> }</span></pre><pre style='background:white'><span style='font-size:9.0pt;color:black'> }</span></pre><pre style='margin-left:.5in;background:white'><span style='font-size:9.0pt; color:black'> }<br> <br> </span><b><span style='font-size:9.0pt;color:navy'>public void </span></b><span style='font-size:9.0pt;color:black'>ProcessNotification(String ntype, String nfrom, String nmsg)<br> {</span></pre><pre style='background:white'><span style='font-size:9.0pt; color:black'> </span><i><span style='font-size:9.0pt;color:gray'>// display notification to user or wake up your application</span></i></pre><pre style='margin-left:.5in;background:white'><span style='font-size:9.0pt; color:black'>}</span></pre><pre style='background:white'><i><span style='font-size:9.0pt;color:gray'><br> </span></i><span style='font-size:9.0pt;color:black'>}</span></pre><pre style='background:white'><span style='font-size:9.0pt;color:black'> </span></pre><pre style='background:white'><u><span style='font-size:9.0pt;font-family:"Calibri",sans-serif; color:black'>Important note:</span></u><span style='font-size:9.0pt;font-family: "Calibri",sans-serif;color:black'> In Android you have the option to “wake” up your app, more exactly to start it and bring it to foreground, you don’t have to necessarily display a notification to the user. This can be achieved by sending an <i>Intent</i> to your application’s main <i>Activity</i>. Example code:</span></pre><pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif; color:black'> </span></pre><pre style='background:white'><span style='font-size:9.0pt;color:black'>Intent intentWake = </span><b><span style='font-size:9.0pt;color:navy'>new </span></b><span style='font-size:9.0pt; color:black'>Intent(</span><b><span style='font-size:9.0pt;color:navy'>this</span></b><span style='font-size:9.0pt;color:black'>, MainActivity.</span><b><span style='font-size:9.0pt;color:navy'>class</span></b><span style='font-size:9.0pt; color:black'>);<br> intentWake.setFlags(Intent.</span><b><i><span style='font-size:9.0pt; color:#660E7A'>FLAG_ACTIVITY_NEW_TASK</span></i></b><span style='font-size: 9.0pt;color:black'>);<br> startActivity(intentWake);</span></pre> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <h2><a name="_Toc117069567"></a><a name="_iOS_with_PushKit"></a>iOS with PushKit</h2> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Follow these steps to add PushKit </span><span style='font-size:9.0pt;line-height:107%'>APNS</span><span style='font-size:9.0pt;line-height:107%'> notifications to your iOS softphone:</span></p> <h4><a name="node7" id="node7"></a>In short</h4> <p class="MsoListParagraphCxSpFirst" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Get a VoIP push notification certificate and configure it into your app. Also copy the certificate files into the Mizu server app folder.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Implement PushKit in your project (registration and handling the push notifications)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>SIP signaling changes: implement RFC 8599 or send the X-MPUSH and X-PIID SIP headers with the REGISTER requests in the SIP signaling</span></p> <h4><a name="node8" id="node8"></a>Online resources</h4> <p class="MsoListParagraphCxSpFirst" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://developer.apple.com/documentation/pushkit"><span style='font-size:9.0pt;line-height:107%'>PushKit documentation home</span></a></p> <p class="MsoListParagraphCxSpLast" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://www.sinch.com/tutorials/ios8-apps-and-pushkit/"><span style='font-size:9.0pt;line-height:107%'>Tutorial1</span></a><span style='font-size:9.0pt;line-height:107%'>, </span><a href="http://www.nikola-breznjak.com/blog/ios/create-native-ios-app-can-receive-voip-push-notifications/"><span style='font-size:9.0pt;line-height:107%'>tutorial2</span></a><span style='font-size:9.0pt;line-height:107%'>, </span><a href="http://pierremarcairoldi.com/ios-8-voip-notifications/"><span style='font-size:9.0pt;line-height:107%'>tutorial3</span></a></p> <h4><a name="node9" id="node9"></a>Prerequisites</h4> <p class="MsoListParagraphCxSpFirst" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>An iOS device for testing (notifications cannot be tested on simulator)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Preferably the latest version of Xcode</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Apple developer account</span></p> <p class="MsoListParagraphCxSpLast" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>For development, you should change the pushkit_serverurl to the sandbox APNS (the pushkit_serverurl_http2 config to api.development.push.apple.com)</span></p> <h4><a name="node10" id="node10"></a>Create an App ID</h4> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Follow these steps in case if you don’t have an app id / bundle id yet:</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Login to your developer account and go to </span><a href="https://developer.apple.com/account/ios/certificate/"><span style='font-size:9.0pt;line-height:107%'>Certificates, Identifiers & Profiles</span></a><span style='font-size:9.0pt;line-height:107%'>.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Create an App ID if you don’t already have one. If already have one, then edit it and make sure to enable Push Notification services within you App ID. Follow the below steps to create an App ID.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Go to <code><span style='line-height:107%;font-family:"Calibri",sans-serif'>Identifiers->App IDs</span></code> and then click on the <code><span style='line-height:107%; font-family:"Calibri",sans-serif'>+</span></code> button.</span></p> <p class="MsoNormal"><img border="0" width="529" height="281" id="Picture 10" src="VOIP_Push_notifications_files/image004.png" alt="http://i.imgur.com/PFyYiUo.png"></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Two important things to fill out here are </span><code><span style='font-size:9.0pt; line-height:107%;font-family:"Calibri",sans-serif'>App ID Description</span></code><span style='font-size:9.0pt;line-height:107%'> and so-called </span><code><span style='font-size:9.0pt;line-height:107%;font-family:"Calibri",sans-serif'>Bundle ID</span></code><span style='font-size:9.0pt;line-height:107%'> (this will most likely be something like </span><code><span style='font-size:9.0pt;line-height: 107%;font-family:"Calibri",sans-serif'>com.yourdomain.yourappname</span></code><span style='font-size:9.0pt;line-height:107%'>):</span></p> <p><img border="0" width="379" height="503" id="Picture 9" src="VOIP_Push_notifications_files/image005.png" alt="http://i.imgur.com/4w8HxKd.png"></p> <p> </p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Make sure to enable Push Notification services for this App ID.</span></p> <h4><a name="_Generate_a_VoIP"></a>VoIP push certificate</h4> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>You will need a VoIP push certificate which will be used by the server to be able to connect to apple push cloud service (APNS). Follow the below steps to generate and set the certificate:</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Login to your with your developer account and go to </span><a href="https://developer.apple.com/account/ios/certificate/"><span style='font-size:9.0pt;line-height:107%'>Certificates, Identifiers & Profiles</span></a><span style='font-size:9.0pt;line-height:107%'>.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>To generate a VoIP push certificate you first need to click on the All button in the Certificates section on the left-hand side. Then, click the + button:</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'><img border="0" width="506" height="157" id="Picture 8" src="VOIP_Push_notifications_files/image006.png" alt="http://i.imgur.com/sqJGGfc.png"></span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>On the next page you need to select the VoIP Services Certificate:</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'><img border="0" width="410" height="222" id="Picture 7" src="VOIP_Push_notifications_files/image007.png" alt="http://i.imgur.com/6qOktuJ.png"></span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Then select the App ID for which you’re creating this VoIP certificate:</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'><img border="0" width="381" height="258" id="Picture 11" src="VOIP_Push_notifications_files/image008.jpg"></span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Next, you’ll be presented with instructions on how to create a so-called CSR (Certificate Signing Request) file:</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'><img border="0" width="426" height="300" id="Picture 17" src="VOIP_Push_notifications_files/image009.png" alt="http://i.imgur.com/xjjUiQr.png"></span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Once you create that file, you’ll select it for upload on the next screen. If everything goes well you’ll be given the certificate which you <b>have to</b> download:</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'><img border="0" width="450" height="376" id="Picture 16" src="VOIP_Push_notifications_files/image010.png" alt="http://i.imgur.com/2o9laoK.png"></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Download certificate from Apple developer page -> voip_services.cer.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>After you download the certificate, open it up, and this should open the Keychain Access application, and you should see the certificate under the My Certificates section:</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'><img border="0" width="473" height="328" id="Picture 18" src="VOIP_Push_notifications_files/image011.jpg"></span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%'> </span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Expand the new certificate in Keychain Access, you should see the private key with either your name or your company name. Select both items by using the “Select” key on your keyboard, right click (or cmd-click if you use a single button mouse), choose “Export 2 items”.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Then save the p12 file with name “pushkit.p12″ to your Desktop – now you will be prompted to enter a password to protect it, you can either click Enter to skip the password or enter a password you desire. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Copy the certificate to your gateway or server app folder as described </span><a href="start.htm#_Configure_the_server"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size: 9.0pt;line-height:107%'>.<br> <br> </span></p> <p class="MsoNormal"><u><span style='font-size:10.0pt;line-height:107%'>Old notes (skip this section):</span></u></p> <p class="MsoNormal" style='margin-left:.5in'><i><span style='font-size:9.0pt; line-height:107%'>These might be required for versions before 2020 June. New versions can use also pkcs12 certificate as is so you can just copy the </span></i><i><span style='font-size:9.0pt;line-height:107%'>pushkit.p12 certificate to the app folder as-is just make sure to set also the pushkit_sslcertpassword global config if your file is password protected.</span></i></p> <p class="MsoNormal" style='margin-left:.5in'><span style='font-size:9.0pt; line-height:107%'>Expand the certificate in Keychain Access, you should see the private key with either your name or your company name. Select both items by using the “Select” key on your keyboard, right click (or cmd-click if you use a single button mouse), choose “Export 2 items”.</span></p> <p class="MsoNormal" style='margin-left:.5in'><span style='font-size:9.0pt; line-height:107%'>Then save the p12 file with name “<a name="_Hlk10251081">pushkit</a>.p12″ to your Desktop – now you will be prompted to enter a password to protect it, you can either click Enter to skip the password or enter a password you desire.</span></p> <p class="MsoNormal" style='margin-left:.5in'><span style='font-size:9.0pt; line-height:107%'>Now the important part: open “Terminal” on your Mac, and run the following commands:</span></p> <p class="MsoNormal" style='margin-left:.5in'><span style='font-size:9.0pt; line-height:107%'>cd<br> cd Desktop<br> openssl pkcs12 <span class="sy0">-</span><span class="kw1">in</span> pushkit.p12 <span class="sy0">-</span>out </span><span style='font-size:9.0pt;line-height:107%'>pushkit.YOURPACKAGENAME.pem </span><span class="sy0"><span style='font-size:9.0pt;line-height:107%'>-</span></span><span style='font-size:9.0pt;line-height:107%'>nodes <span class="sy0">–</span>clcerts</span></p> <p class="MsoNormal" style='margin-left:.5in'><span style='font-size:9.0pt; line-height:107%'> </span></p> <p class="MsoNormal" style='margin-left:.5in'><u><span style='font-size:9.0pt; line-height:107%'>Details step-by-step instructions:</span></u></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Download certificate from Apple developer page -> voip_services.cer</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Expand the certificate in Keychain Access, you should see the private key with either your name or your company name. Select both items by using the “Select” key on your keyboard, right click (or cmd-click if you use a single button mouse), choose “Export 2 items”.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Then save the p12 file with name “pushkit.p12″ to your Desktop – now you will be prompted to enter a password to protect it, you can either click Enter to skip the password or enter a password you desire.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>4.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Open “Terminal” on your Mac, and run the following commands:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>5.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>cd<br> cd Desktop<br> openssl pkcs12 <span class="sy0">-</span><span class="kw1">in</span> pushkit.p12 <span class="sy0">-</span>out </span><span style='font-size:9.0pt;line-height:107%'>pushkit.YOURPACKAGENAME.pem </span><span class="sy0"><span style='font-size:9.0pt;line-height:107%'>-</span></span><span style='font-size:9.0pt;line-height:107%'>nodes <span class="sy0">–</span>clcerts</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>openssl x509 -in voip_services.cer -inform der -out pushkit<b>cert</b>PACKAGENAME.pem</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>6.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Install the certificate and export it from Mac Keychain as Certificates.p12 (Exporting without a passphrase did not work for me in the gateway, so that might be required)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>7.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Run the following from terminal:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>openssl pkcs12 -nocerts -out pushkit<b>key</b>PACKAGENAME.pem -in Certificates.p12</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>8.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Copy those 2 files to the gateway folder: copy the certificate file in the mizu server or gateway app folder renamed to pushkit.YOURPACKAGENAME.pem (replace the YOURPACKAGENAME string with your App Bundle ID such as com.yourdomain.yourappname)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>9.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>In MManage > Configurations set pushkit_sslcertpassword to the passphrase used in step 6.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-left:.75in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>10.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Once you copied the new certificate, you have to restart the gateway or reload with the “pushkitrst” command (to be send from the “Server console” form).</span></p> <p class="MsoNormal" style='margin-left:.5in'><span style='font-size:9.0pt; line-height:107%'> </span></p> <p class="MsoNormal" style='margin-left:.5in'><u><span style='font-size:9.0pt; line-height:107%'>Uploading the .pem file to server:</span></u></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><a name="_Setting_the_background"></a><span style='font-size:9.0pt;line-height:107%'>Copy the certificate file in the mizu server or gateway app folder.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:9.0pt; line-height:107%'>Make sure that the file name is pushkit.YOURPACKAGENAME.pem. (Replace the YOURPACKAGENAME string with your App ID such as com.yourdomain.yourappname)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:9.0pt; line-height:107%'> </span></p> <p class="MsoNormal" style='margin-left:.5in'><i><span style='font-size:9.0pt; line-height:107%'>Note: <br> Once the pushkit process starts, it will generate a pushkit<b>cert</b>.YOURPACKAGENAME.pem and pushkit<b>key</b>.YOURPACKAGENAME.pem files from pushkit.YOURPACKAGENAME.pem file and will rename the original file to *.old. Later if you need to replace your certificate, you just need to upload the pushkit.YOURPACKAGENAME.pem file again.</span></i></p> <p class="MsoNormal" style='margin-left:.5in'><i><span style='font-size:9.0pt; line-height:107%'>If you apply this to a running service then you have to restart the service (restart the “mserver” NT service or from MManage -> Control -> Restart Server) or reload with the “pushkitrst” command (to be send from the “Server Console” form).</span></i></p> <p class="MsoNormal"><i><span style='font-size:9.0pt;line-height:107%'> </span></i></p> <h4><a name="node11" id="node11"></a>Set the app capabilities</h4> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>To use the VoIP push in the app, you must set the background capabilities to your app in Xcode</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>For this we need to turn ON Push Notifications and the Background Modes for our app and check few of the checkboxes:</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'><img border="0" width="623" height="471" id="Picture 21" src="VOIP_Push_notifications_files/image012.jpg"></span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Make sure you select the following options:</span></p> <ul style='margin-top:0in' type="disc"> <li class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Audio, Airplay, and Picture in Picture</span></li> <li class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Voice over IP</span></li> <li class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Background fetch</span></li> <li class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Remote notifications</span></li> </ul> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>“Voice over IP” background mode was removed in Xcode 9 from user interface, it must be added manually in the application’s Info.plist file.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Add PushKit.framework in General-> Linked Frameworks and Libraries.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <h4><a name="_Configure_the_server"></a>Configure the server or gateway</h4> <pre style='background:white'><span style='font-size:9.0pt'> </span></pre><pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif; color:black'>Configure the followings on your gateway or server:</span></pre><pre style='margin-left:.25in;text-indent:-.25in;background:white'><span style='font-size:9.0pt;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>Set the <span style='color:#833C0B'>pushnotification_pushkit </span>global config to <span style='color:#833C0B'>1</span> (from the “Configurations” form)</span></pre> <p class="MsoListParagraphCxSpFirst" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Copy the pem or p12 </span><a href="start.htm#_Generate_a_VoIP"><span style='font-size:9.0pt;line-height: 107%'>certificate file</span></a><span style='font-size:9.0pt;line-height:107%'> to the mizu server or gateway app folder. One of the followings:</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:"Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>The pem file renamed as <span style='color:#833C0B'>pushkit.pem </span>(if you have only one app/one domain) or <span style='color:#833C0B'>pushkit.YOURPACKAGENAME.pem </span>(replace the YOURPACKAGENAME string with your App ID such as com.yourdomain.yourappname). </span></p> <p class="MsoListParagraphCxSpMiddle"><span style='font-size:9.0pt;line-height: 107%'>The file must contain both the certificate and the key in PEM format.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%; font-family:"Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>The p12 file renamed to <span style='color:#833C0B'>pushkit.p12 </span>(if you have only one app/one domain) or <span style='color:#833C0B'>pushkit.YOURPACKAGENAME.p12 </span>(replace the YOURPACKAGENAME string with your App ID such as com.yourdomain.yourappname). </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt'><span style='font-size:9.0pt;line-height:107%'>If the p12 file is password protected, then set its password (passphrase) as the <span style='color:#833C0B'>pushkit_sslcertpassword</span> global config value or create a separate <span style='color:#833C0B'>pushkit.YOURPACKAGENAME.pwd</span> text file for all your apps with the keystore password if you have multiple apps.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Reset the pushkit module from Control menu -> Reset -> PUSH.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>(or restart the “mserver” NT service from Control menu -> Restart server or send the “reload” and “pushkitrst” commands from the “Server console” form)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%'>Note: </span></i></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><i><span style='font-size:9.0pt;line-height:107%'>Once the pushkit process starts, it will generate a pushkit<b>cert</b>.YOURPACKAGENAME.pem and pushkit<b>key</b>.YOURPACKAGENAME.pem files from pushkit.YOURPACKAGENAME.pem file and will delete it. Later if you need to replace your certificate, you just need to upload the pushkit.YOURPACKAGENAME.pem file again.</span></i></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><i><span style='font-size:9.0pt;line-height:107%'>New versions (since 2020 June) also accepts the certificate in crt, p12 or pfx file and will auto convert as needed. Also the new version is capable to extract the package name from the cert file. This means that you might just copy the original file as pushkit.p12 file and the push module will take care of the rest.</span></i></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%; font-family:Symbol;color:red'>·<span style='font:7.0pt "Times New Roman"'> </span></span><i><span style='font-size:9.0pt;line-height:107%;color:red'>Do not mismatch sandbox/development and production environments as device tokens are not cross valid.</span></i></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:black'>It is important to realize that development/sandbox device tokens are not valid via production APNS service and inverse.</span></i></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt; line-height:107%;color:black'>In case if you are using development/sandbox environment then you should configure the </span></i><i><span style='font-size: 9.0pt;line-height:107%;color:#833C0B'>pushkit_serverurl_legacy </span></i><i><span style='font-size:9.0pt;line-height:107%;color:black'>to </span></i><i><span style='font-size:9.0pt;line-height:107%;color:black'> </span></i><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>gateway.sandbox.push.apple.com:2195 </span></i><i><span style='font-size:9.0pt;line-height:107%;color:black'>and/or the </span></i><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushkit_serverurl_http2 </span></i><i><span style='font-size:9.0pt;line-height:107%;color:black'>to </span></i><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>api.development.push.apple.com </span></i><i><span style='font-size:9.0pt;line-height:107%;color:black'>(or just set the ‘d:’ prefix for the X-MPUSH SIP header value from your app)</span></i></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt; line-height:107%;color:black'>In case if you configure for production then you should configure the </span></i><i><span style='font-size:9.0pt;line-height: 107%;color:#833C0B'>pushkit_serverurl_legacy </span></i><i><span style='font-size:9.0pt;line-height:107%;color:black'>to </span></i><i><span style='font-size:9.0pt;line-height:107%;color:black'> </span></i><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>gateway.push.apple.com:2195 </span></i><i><span style='font-size:9.0pt;line-height:107%;color:black'>and/or the </span></i><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushkit_serverurl_http2</span></i><i><span style='font-size:9.0pt;line-height:107%;color:black'> to </span></i><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>api.push.apple.com</span></i><i><span style='font-size:9.0pt;line-height:107%;color:black'> (or just set the ‘p:’ prefix for the X-MPUSH SIP header value from your app)</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%'> </span></i></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>More details about the server configuration can be found </span><a href="start.htm#_Configure_VoIP_push"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size:9.0pt;line-height:107%'>.</span></p> <h4><a name="node12" id="node12"></a>Register to the server or gateway</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>You will need to send your app package name and token to the server with SIP REGISTER requests. For this you can implement </span><a href="start.htm#_RFC_8599"><span style='font-size:9.0pt;line-height:107%'>RFC 8599</span></a><span style='font-size:9.0pt;line-height:107%'> or send the </span><a href="start.htm#_X-PUSH"><span style='font-size:9.0pt;line-height:107%'>X-MPUSH</span></a><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> </span><span style='font-size:9.0pt;line-height:107%;color:black'>(with the provider set to “</span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>i</span><span style='font-size:9.0pt;line-height:107%;color:black'>”)</span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> </span><span style='font-size:9.0pt;line-height:107%'>and <span style='color:#833C0B'>X-PIID </span>SIP headers with the REGISTER requests in the SIP signaling.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>All the details are described in the </span><a href="start.htm#_SIP_signaling_1"><span style='font-size:9.0pt;line-height:107%'>SIP Signaling</span></a><span style='font-size:9.0pt;line-height:107%'> chapter.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Example register request using the X-MPUSH header: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>REGISTER sip:gw.mydomain.com SIP/2.0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>Via: SIP/2.0/TCP 192.168.1.101:14501;alias;branch=z9hG4bK.edThn;rport</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>From: <sip:1111@gw.mydomain.com>;tag=tUgBfpF8h</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>To: sip:1111@gw.mydomain.com</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>CSeq: 2 REGISTER</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>Call-ID: enutmuwaynqib</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>Max-Forwards: 70</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>Contact: <sip:1111@192.168.1.101:14501></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>Authorization: Digest realm="sip.mydomain.com", nonce="WvDOe1rwzc2EDrmrsjELzwQLYnJ7tD3H", username="1111", uri="sip:gw.mydomain.com", response="1336341b517678240fb092e0cf1159a7"</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>Expires: 3600</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-size:8.0pt;color:#833C0B'>X-MPUSH: i:com.mycompany.myapp:c-10-ap_Kt0:BPC91bG7STqrzueY3dRAtPhxpST4cjrd_cqQquRLkHi3eY4g</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-size:8.0pt;color:#833C0B'>X-PIID: 14d4f932e3897a39d6a17c13b526db</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><b><span style='font-size:8.0pt;line-height:107%;color:#833C0B'>X-Sy.Uppersrv: sip.mydomain.com</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>User-Agent: MyCoolApp</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>Content-Length: 0</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <h4><a name="_Adding_the_code"></a>Adding the code</h4> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>The below code is Objective-C. For Swift you will need something similar (actually more simple/easier).</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Import PushKit in your app delegate:</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%;font-family: "Menlo-Regular",serif;color:#643820'>#import </span><span style='font-size: 9.0pt;line-height:107%;font-family:"Menlo-Regular",serif;color:#C41A16'><PushKit/PushKit.h></span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Add delegate in order to implement its functions:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>@interface</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> MyApplication : </span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#5C2699'>UIApplication</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> <</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#5C2699'>PKPushRegistryDelegate</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>Add the following code to </span><i><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>didFinishLaunchingWithOptions</span></i><span style='font-size: 9.0pt'> to request permission from user for displaying notifications:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#2E0D6E'>floor</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>(</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSFoundationVersionNumber</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>) <= </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#643820'>NSFoundationVersionNumber_iOS_9_x_Max</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>) {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>UIUserNotificationType</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'> allNotificationTypes =</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#2E0D6E'>UIUserNotificationTypeSound</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'> | </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>UIUserNotificationTypeAlert</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> | </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>UIUserNotificationTypeBadge</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>UIUserNotificationSettings</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'> *settings =</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> [</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>UIUserNotificationSettings</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>settingsForTypes</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:allNotificationTypes </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#2E0D6E'>categories</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>:</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>nil</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> [</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>self</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#2E0D6E'>registerUserNotificationSettings</span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:black'>:settings];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> } </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>else</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#007400'>// iOS 10 or later</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#643820'>#if defined(__IPHONE_10_0) && __IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_10_0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> [</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>UNUserNotificationCenter</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>currentNotificationCenter</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>].</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#5C2699'>delegate</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> = </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#AA0D91'>self</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>;</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>UNAuthorizationOptions</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'> authOptions =</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#2E0D6E'>UNAuthorizationOptionAlert</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> | </span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#2E0D6E'>UNAuthorizationOptionSound</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> | </span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#2E0D6E'>UNAuthorizationOptionBadge</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>;</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> [[</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#5C2699'>UNUserNotificationCenter</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>currentNotificationCenter</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>] </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>requestAuthorizationWithOptions</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:authOptions </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#2E0D6E'>completionHandler</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>:^(</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#AA0D91'>BOOL</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> granted, </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSError</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> * </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>_Nullable</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> error) {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> }]; </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#643820'>#endif</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>Also in </span><i><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>didFinishLaunchingWithOptions</span></i><span style='font-size:9.0pt'> register for PushKit notifications:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#3F6E74'>pushRegistry</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'> = [[</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#5C2699'>PKPushRegistry</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>alloc</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>] </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>initWithQueue</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>dispatch_get_main_queue</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>()];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#3F6E74'>pushRegistry</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>.</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#5C2699'>delegate</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> = </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#AA0D91'>self</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>;</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#3F6E74'>pushRegistry</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>.</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#5C2699'>desiredPushTypes</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> = [</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#5C2699'>NSSet</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>setWithObject</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#5C2699'>PKPushTypeVoIP</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>Implement required delegate functions. First implement </span><i><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>didUpdatePushCredentials</span></i><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> to receive token:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#007400'>// receive and update token</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>- (</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>void</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>)pushRegistry:(</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#5C2699'>PKPushRegistry</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> *)registry didUpdatePushCredentials:(</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#5C2699'>PKPushCredentials</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> *)credentials forType:(</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> *)type</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>(!credentials.</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#5C2699'>token</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'> || [credentials.</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#5C2699'>token</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>length</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>] < </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#1C00CF'>1</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>) {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#2E0D6E'>NSLog</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>(</span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"PushKit voip token NULL"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#AA0D91'>return</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>;</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#007400'> // convert token to NSString</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>const</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>char</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> *data = [credentials.</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#5C2699'>token</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>bytes</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSMutableString</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'> *token = [</span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:#5C2699'>NSMutableString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>string</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>for</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSUInteger</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> i = </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#1C00CF'>0</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>; i < [credentials.</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#5C2699'>token</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>length</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>]; i++) {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> [token </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#2E0D6E'>appendFormat</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"%02.2hhX"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>, data[i]];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#3F6E74'> *pushKitToken</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'> = [token </span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>copy</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#3F6E74'>pushKitToken</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'> = [[[</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#3F6E74'>pushKitToken</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#2E0D6E'>stringByReplacingOccurrencesOfString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>: </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"<"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>withString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>: </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@""</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>]</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#2E0D6E'>stringByReplacingOccurrencesOfString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>: </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@">"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>withString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>: </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@""</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>]</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#2E0D6E'>stringByReplacingOccurrencesOfString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>: </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@" "</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#2E0D6E'>withString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>: </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@""</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#2E0D6E'>NSLog</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>(</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"PushKit received token: %@"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>, </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#3F6E74'>pushKitToken</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>Then implement <i>didReceiveIncomingPushWithPayload</i>. Here we receive and parse the </span><a href="start.htm#_VoIP_push_notification"><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif'>notification</span></a><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><u><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>Important note:</span></u><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'> Once you receive a notification, you will be responsible for presenting it to the user.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>The PushKit notification that you will receive has the following JSON format by default:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>{</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> "headers" : </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> "apns-priority" : "10",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> "apns-expiration" : TTL</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> },</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> "aps" : </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> "alert" : </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> "title" : "TITLE",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> "body" : "BODY" </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> },</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> "content-available" : 1,</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> "sound" : "SOUND"</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> },</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> "data" : </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> "ntype" : TYPE, </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> "nfrom" : "FROM", </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> "nmsg" : "MSG"</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>}</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><i><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>See the pushkitmessage.txt in your server or gateway app folder for the exact JSON format.</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>- (</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>void</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>)pushRegistry:(</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#5C2699'>PKPushRegistry</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> *)registry didReceiveIncomingPushWithPayload:(</span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:#5C2699'>PKPushPayload</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> *)payload forType:(</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> *)type</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (payload && [payload </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#2E0D6E'>dictionaryPayload</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>])</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#2E0D6E'>NSLog</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>(</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"PushKit didReceiveIncomingPushWithPayload"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSDictionary</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'> *msg = [payload </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>dictionaryPayload</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> *nfrom = </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@""</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>; </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#007400'>// other party number</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> *ntype = </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@""</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>; </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#007400'>// can be “0” for calls, “1” for chat messages, “2” for cancel, “3” for custom message, “4” to request re-register</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> *nmsg = </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@""</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>; </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#007400'>// will contain the first part of the chat message</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> *title = </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@""</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>; </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#007400'>// Title of the notification</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> *body = </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@""</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>; </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#007400'>// Body of the notification, for example: “Incoming VoIP call from: 1234556”</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> *sound = </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@""</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>;</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Helvetica",sans-serif'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#007400'>// parse notification</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSDictionary</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'> *aps = msg[</span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"aps"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSDictionary</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'> *data = msg[</span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"data"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (aps && aps[</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#C41A16'>@"sound"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>] && [aps[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"sound"</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>] </span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>length</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>] > </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#1C00CF'>0</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>) sound = aps[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"sound"</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (aps && aps[</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#C41A16'>@"alert"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>])</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#5C2699'>NSDictionary</span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:black'> *alert = aps[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"alert"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#AA0D91'>if</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'> (alert && alert[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"title"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>] && [alert[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"title"</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>] </span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>length</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>] > </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#1C00CF'>0</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>) title = alert[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"title"</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#AA0D91'>if</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'> (alert && alert[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"body"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>] && [alert[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"body"</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>] </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#2E0D6E'>length</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>] > </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#1C00CF'>0</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>) body = alert[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"body"</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (data && data[</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#C41A16'>@"nfrom"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>] && [data[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"nfrom"</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>] </span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>length</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>] > </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#1C00CF'>0</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>) nfrom = data[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"nfrom"</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (data && data[</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#C41A16'>@"ntype"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>]) ntype = data[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"ntype"</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (data && data[</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#C41A16'>@"nmsg"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>] && [data[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"nmsg"</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>] </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#2E0D6E'>length</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>] > </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#1C00CF'>0</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>) nmsg = data[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"nmsg"</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#2E0D6E'>NSLog</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>(</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"PushKit notification received nfrom: %@; ntype: %@; nmsg: %@; title: %@; body: %@; sound: %@"</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>, nfrom, ntype, nmsg, title, body, sound);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Helvetica",sans-serif'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Helvetica",sans-serif'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Helvetica",sans-serif'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#3F6E74'>yourViewController</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#26474B'>PKNotifyUser</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:nfrom </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#26474B'>type</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:ntype </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#26474B'>msg</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:nmsg </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#26474B'>tit</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:title </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#26474B'>bdy</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:body </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#26474B'>snd</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:sound];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>Add the below function to your ViewController to display a local notification for the user:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>- (</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>void</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>)PKNotifyUser:(</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#5C2699'>NSString</span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:black'> *)nfrom type:(</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> *)ntype msg:(</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> *)nmsg tit:(</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> *)title bdy:(</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#5C2699'>NSString</span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:black'> *)body snd:(</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> *)sound</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>{</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> *alertbody = nmsg;</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (!alertbody || [alertbody </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#2E0D6E'>length</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>] < </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#1C00CF'>2</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#AA0D91'>if</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'> ([ntype isEqualToString(</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"1"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>)])</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> alertbody = [</span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>stringWithFormat</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"Incoming message from: %@"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>, nfrom];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#AA0D91'>else</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> [</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>stringWithFormat</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"Incoming call from: %@"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>, nfrom];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#007400'>// for iOS lower than 10</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#2E0D6E'>floor</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>(</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSFoundationVersionNumber</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>) <= </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#643820'>NSFoundationVersionNumber_iOS_9_x_Max</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#5C2699'>UILocalNotification</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> *localNotification = [[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>UILocalNotification</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>alloc</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>] </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>init</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> localNotification.</span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:#5C2699'>alertBody</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> = alertbody;</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> localNotification.</span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:#5C2699'>soundName</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> = </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#5C2699'>UILocalNotificationDefaultSoundName</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>;</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> [[</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#5C2699'>UIApplication</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>sharedApplication</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>] </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>presentLocalNotificationNow</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:localNotification];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> }</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>else</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#007400'>// iOS 10 or later</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#643820'>#if defined(__IPHONE_10_0) && __IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_10_0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#5C2699'>UNMutableNotificationContent</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> *content = [[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>UNMutableNotificationContent</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>alloc</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>] </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>init</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> content.</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#5C2699'>title</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> = </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@""</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>;</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> content.</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#5C2699'>body</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> = alertbody;</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> content.</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#5C2699'>sound</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> = [</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#5C2699'>UNNotificationSound</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>defaultSound</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#5C2699'>UNTimeIntervalNotificationTrigger</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> *trigger = [</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>UNTimeIntervalNotificationTrigger</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>triggerWithTimeInterval</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>: </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#1C00CF'>0.1f</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>repeats</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#AA0D91'>NO</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#5C2699'>UNNotificationRequest</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> *request = [</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>UNNotificationRequest</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>requestWithIdentifier</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"FiveSecond"</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#2E0D6E'>content</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>:content</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#2E0D6E'>trigger</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>:trigger];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#007400'>// schedule localNotification</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#5C2699'>UNUserNotificationCenter</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> *center = [</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>UNUserNotificationCenter</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>currentNotificationCenter</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> [center </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#2E0D6E'>addNotificationRequest</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:request </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>withCompletionHandler</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:^(</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#5C2699'>NSError</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> * </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#AA0D91'>_Nullable</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> error) {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#AA0D91'>if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> (!error)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#2E0D6E'>NSLog</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>(</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"PKNotifyUser UNUserNotificationCenter succeded"</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> }</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#AA0D91'>else</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#2E0D6E'>NSLog</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>(</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"ERROR, PKNotifyUser UNUserNotificationCenter failed"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> }];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#643820'>#endif</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>}</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <h2><a name="_Toc117069568">iOS with FCM</a></h2> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>iOS apps usually integrates with PushKit for push notifications which is described in the </span><a href="start.htm#_iOS_with_PushKit"><span style='font-size:9.0pt'>above chapter</span></a><span style='font-size:9.0pt'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>However, some developers might choose to use FCM also for iOS apps which is described in this chapter.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>As we mentioned earlier, FCM can also be used for delivering notifications to iOS applications, with the limitation that notifications will be received only if the application is already “running in background”, meaning that it was not killed by the user. Follow these steps to add FCM notifications to your iOS softphone:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <h4><a name="node13" id="node13"></a>In short</h4> <p class="MsoListParagraphCxSpFirst" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Create a Firebase project and add its plist config file to your project. Also add your server key and package name to the Mizu server global config (<span style='color:black'>fcm_key and fcm_app</span>)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Implement Firebase (Firebase registration and handling the push notifications)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>SIP signaling changes: implement RFC 8599 or send the X-MPUSH and X-PIID SIP headers with the REGISTER requests in the SIP signaling</span></p> <h4><a name="node14" id="node14"></a>Online resources</h4> <p class="MsoListParagraphCxSpFirst" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://console.firebase.google.com/"><span style='font-size:9.0pt;line-height:107%'>Firebase console</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span class="MsoHyperlink"><span style='font-size:9.0pt;line-height:107%;font-family: Symbol;color:windowtext;text-decoration:none'>·<span style='font:7.0pt "Times New Roman"'> </span></span></span><a href="https://firebase.google.com/docs/cloud-messaging/"><span style='font-size:9.0pt;line-height:107%'>FCM Messaging</span></a><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://firebase.google.com/docs/cloud-messaging/ios/client"><span style='font-size:9.0pt;line-height:107%'>Add FCM support to iOS project</span></a></p> <p class="MsoListParagraphCxSpLast" style='text-indent:-.25in'><span class="MsoHyperlink"><span style='font-size:9.0pt;line-height:107%;font-family: Symbol;text-decoration:none'>·<span style='font:7.0pt "Times New Roman"'> </span></span></span><a href="https://www.appcoda.com/firebase-push-notifications/"><span style='font-size:9.0pt;line-height:107%'>Tutorial1</span></a><span style='font-size:9.0pt;line-height:107%'>, </span><a href="https://codentrick.com/firebase-cloud-messaging-ios/"><span style='font-size:9.0pt;line-height:107%'>tutorial2</span></a><span style='font-size:9.0pt;line-height:107%'> <a href="https://codentrick.com/firebase-cloud-messaging-ios/"></a></span></p> <h4><a name="node15" id="node15"></a>Prerequisites</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>Before you begin, you need a few things set up in your environment:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Xcode 8.0 or later</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Your Xcode softphone project must be targeting iOS 8 or above</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Swift projects must use Swift 3.0 or later</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>The bundle identifier of your app</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>CocoaPods 1.2.0 or later</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>For Cloud Messaging:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>A physical iOS device</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>An Apple Push Notification Authentication Key for your Apple Developer account</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>In Xcode, enable Push Notifications in App > Capabilities</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <h4><a name="node16" id="node16"></a>Add Firebase to your softphone</h4> <p><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>To add Firebase to your softphone, you will need a Firebase project and a Firebase configuration file for your app, just like for Android.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Create a Firebase project in the </span><a href="https://console.firebase.google.com/"><span style='font-size:9.0pt'>Firebase console</span></a><span style='font-size:9.0pt'>, if you don't already have one. If you already have an existing Google project associated with your mobile app, click <strong><span style='font-family:"Calibri",sans-serif'>Import Google Project</span></strong>. Otherwise, click <strong><span style='font-family: "Calibri",sans-serif'>Add project</span></strong>.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Click <strong><span style='font-family:"Calibri",sans-serif'>Add Firebase to your iOS app</span></strong> and follow the setup steps. If you're importing an existing Google project, this may happen automatically and you can just </span><a href="http://support.google.com/firebase/answer/7015592"><span style='font-size:9.0pt'>download the config file</span></a><span style='font-size:9.0pt'>.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>When prompted, enter your app's bundle ID. It's important to enter the bundle ID your app is using; this can only be set when you add an app to your Firebase project. This will usually be something like: </span><code><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>com.yourdomain.yourappname</span></code></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt'>4.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>At the end, you'll download a <code><span style='font-family:"Calibri",sans-serif'>GoogleService-Info.plist</span></code> file. You can </span><a href="http://support.google.com/firebase/answer/7015592"><span style='font-size:9.0pt'>download this file</span></a><span style='font-size: 9.0pt'> again at any time.</span></p> <ol start="5" type="1"> <li class="MsoNormal" style='line-height:normal'><span style='font-size:9.0pt'>If you haven't done so already, add this file to your Xcode project root using the <strong><span style='font-family:"Calibri",sans-serif'>Add Files</span></strong> utility in Xcode (From the <strong><span style='font-family:"Calibri",sans-serif'>File</span></strong> menu, click <strong><span style='font-family:"Calibri",sans-serif'>Add Files</span></strong>). Make sure the file is included in your app's build target.</span></li> </ol> <h4><a name="node17" id="node17"></a>Add the SDK</h4> <p><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>You need to install the SDK. We recommend using CocoaPods to install the libraries. You can install CocoaPods by following the below. More details about CocoaPods installation can be </span><a href="https://guides.cocoapods.org/using/getting-started.html#getting-started"><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>found here</span></a><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>. If you'd rather not use CocoaPods, you can integrate the SDK frameworks manually, but it’s more cumbersome this way. However, if you chose to do it manually, you can find </span><a href="https://firebase.google.com/docs/cloud-messaging/ios/client#add_the_sdk"><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>instructions here</span></a><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>.</span></p> <p style='margin-left:.5in;text-indent:-.25in'><span style='font-size:9.0pt; font-family:"Calibri",sans-serif'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>Installing CocoPods: open the terminal in you Mac OS X and enter the following commands:</span></p> <pre><span class="gp"><span style='font-size:9.0pt'> $ </span></span><code><span style='font-size:9.0pt'>sudo gem install cocoapods</span></code></pre><pre><code><span style='font-size:9.0pt'> </span></code></pre><pre style='margin-left:.5in; text-indent:-.25in'><code><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>2.<span style='font:7.0pt "Times New Roman"'> </span></span></code><code><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>Create a Pod file in your project:</span></code></pre><pre style='margin-left:.5in'><code><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'> </span></code></pre><pre style='margin-left:45.8pt'><span class="pln"><span style='font-size:9.0pt'>$ cd your</span></span><span class="pun"><span style='font-size:9.0pt'>-</span></span><span class="pln"><span style='font-size:9.0pt'>project directory</span></span><span style='font-size: 9.0pt'><br> <span class="pln">$ pod init</span></span></pre><pre><span style='font-size:9.0pt'> </span></pre><pre style='margin-left:.5in;text-indent:-.25in'><span style='font-size:9.0pt; font-family:"Calibri",sans-serif'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>Add the pods that you want to install. You can include a Pod in your Podfile like this:</span></pre><pre style='margin-left:.5in'><span class="pln"><span style='font-size:9.0pt'>pod </span></span><span class="str"><span style='font-size:9.0pt'>'Firebase/Core'</span></span><span style='font-size:9.0pt'><br> <span class="pln">pod </span><span class="str">'Firebase/Messaging'</span></span></pre><pre style='margin-left:.5in'><span style='font-size:9.0pt'> </span></pre><pre style='margin-left:.5in'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>This will add the prerequisite libraries needed to get Firebase up and running in your iOS app.</span></pre><pre style='margin-left:.5in'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'> </span></pre> <p style='margin-left:.5in;text-indent:-.25in'><span style='font-size:9.0pt; font-family:"Calibri",sans-serif'>4.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>Close Xcode, if it’s running. Install the pods and open the .xcworkspace file to see the project in Xcode.</span></p> <pre style='margin-left:45.8pt'><span class="pln"><span style='font-size:9.0pt'>$ pod install</span></span><span style='font-size:9.0pt'><br> <span class="pln">$ open your</span><span class="pun">-</span><span class="pln">project</span><span class="pun">.</span><span class="pln">xcworkspace</span></span></pre><pre style='margin-left:45.8pt'><span style='font-size:9.0pt'> </span></pre><pre style='margin-left:45.8pt'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>After pod install has finished, it will create an .</span><span class="pln"><span style='font-size:9.0pt'>xcworkspace </span></span><span class="pln"><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>type file. From now on you must use this file to open your project, because you will have your own project and a Pods project attached to it. Never open your project using </span></span><span class="pln"><span style='font-size:9.0pt'>.xcodeproj</span></span><span class="pln"><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'> because it can mess it up. </span></span></pre><pre style='margin-left:45.8pt'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'> </span></pre><pre style='margin-left:.5in'> </pre><pre style='margin-left:.5in;text-indent: -.25in'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>5.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>Download a GoogleService-Info.plist file from </span><a href="https://support.google.com/firebase/answer/7015592"><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>here</span></a><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'> and include it in your app</span></pre><pre style='margin-left:.5in'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'> </span></pre><pre style='margin-left:.5in'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'> </span></pre> <h4><a name="node18" id="node18"></a>Configuring APNs with FCM </h4> <p><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>The Firebase Cloud Messaging APNs interface uses the </span><a href="https://developer.apple.com/notifications/"><span style='font-size:9.0pt; font-family:"Calibri",sans-serif'>Apple Push Notification service (APNs)</span></a><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'> to send messages up to 4KB in size to your iOS app, including when it is in the background.</span></p> <p><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>To enable sending Push Notifications through APNs, you need:</span></p> <p class="MsoListParagraphCxSpFirst" style='text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt'>-<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>An Apple Push Notification Authentication Key for your </span><a href="https://www.google.com/url?sa=D&q=https://developer.apple.com/account"><span style='font-size:9.0pt'>Apple Developer account</span></a><span style='font-size:9.0pt'>. Firebase Cloud Messaging uses this token to send Push Notifications to the application identified by the App ID.</span></p> <p class="MsoListParagraphCxSpLast" style='text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt'>-<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>A provisioning profile for that App ID.</span></p> <h4><a name="node19" id="node19"></a>Create the authentication key</h4> <p class="MsoNormal" style='line-height:normal'><span style='font-size:9.0pt'>Below are the steps to follow to generate an authentication key for an App ID enabled for Push Notifications:</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Login to your developer account and go to </span><a href="https://developer.apple.com/account/ios/certificate/"><span style='font-size:9.0pt'>Certificates, Identifiers & Profiles</span></a><span style='font-size:9.0pt'>, and under <b>Keys</b>, select <b>All</b>.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Click the <b>Add</b> button (+) in the upper-right corner.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Enter a description for the APNs Auth Key</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt'>4.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Under <b>Key Services</b>, select the APNs checkbox, and click <b>Continue</b>.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt'>5.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Click <b>Confirm</b> and then <b>Download</b>. Save your key in a secure place. This is a one-time download, and the key cannot be retrieved later.</span></p> <h4><a name="node20" id="node20"></a>Create an APP ID</h4> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Login to your developer account and go to </span><a href="https://developer.apple.com/account/ios/certificate/"><span style='font-size:9.0pt;line-height:107%'>Certificates, Identifiers & Profiles</span></a><span style='font-size:9.0pt;line-height:107%'>.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Create an App ID if you don’t already have one. If already have one, then edit it and make sure to enable Push Notification services within you App ID. Follow the below steps to create an App ID.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Go to <code><span style='line-height:107%;font-family:"Calibri",sans-serif'>Identifiers->App IDs</span></code> and then click on the <code><span style='line-height:107%; font-family:"Calibri",sans-serif'>+</span></code> button.</span></p> <p><img border="0" width="529" height="281" id="Picture 1" src="VOIP_Push_notifications_files/image013.png" alt="http://i.imgur.com/PFyYiUo.png"></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Two important things to fill out here are </span><code><span style='font-size:9.0pt; line-height:107%;font-family:"Calibri",sans-serif'>App ID Description</span></code><span style='font-size:9.0pt;line-height:107%'> and so-called </span><code><span style='font-size:9.0pt;line-height:107%;font-family:"Calibri",sans-serif'>Bundle ID</span></code><span style='font-size:9.0pt;line-height:107%'> (this will most likely be something like </span><code><span style='font-size:9.0pt;line-height: 107%;font-family:"Calibri",sans-serif'>com.yourdomain.yourappname</span></code><span style='font-size:9.0pt;line-height:107%'>):</span></p> <p><img border="0" width="379" height="503" id="Picture 2" src="VOIP_Push_notifications_files/image014.png" alt="http://i.imgur.com/4w8HxKd.png"></p> <p><span style='font-size:9.0pt'>Make sure to enable Push Notification services for this App ID.</span></p> <p class="MsoNormal" style='line-height:normal'><b><span style='font-size:9.0pt'> </span></b></p> <h4><a name="node21" id="node21"></a>Create the Provisioning Profile</h4> <p><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>To test your app while under development, you need a Provisioning Profile for development to authorize your devices to run an app that is not yet published on the App Store.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Navigate to the </span><a href="https://developer.apple.com/membercenter/index.action"><span style='font-size:9.0pt'>Apple Developer Member Center</span></a><span style='font-size:9.0pt'> and sign in.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Navigate to <strong><span style='font-family:"Calibri",sans-serif'>Certificates, Identifiers and Profiles</span></strong>.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>In the drop down menu on the top left corner, select <strong><span style='font-family:"Calibri",sans-serif'>iOS, tvOS, watchOS</span></strong> if it's not already selected, then navigate to <strong><span style='font-family:"Calibri",sans-serif'>Provisioning Profiles > All</span></strong>.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt'>4.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Click the <strong><span style='font-family:"Calibri",sans-serif'>+</span></strong> button to create a new Provisioning Profile.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt'>5.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Select <strong><span style='font-family:"Calibri",sans-serif'>iOS App Development</span></strong> as provisioning profile type, then click <strong><span style='font-family:"Calibri",sans-serif'>Continue</span></strong>.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt'>6.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>In the drop down menu, select the App ID you want to use, then click <strong><span style='font-family:"Calibri",sans-serif'>Continue</span></strong>.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt'>7.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Select the iOS Development certificate of the App ID you have chosen in the previous step, then click <strong><span style='font-family:"Calibri",sans-serif'>Continue</span></strong>.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt'>8.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Select the iOS devices that you want to include in the Provisioning Profile, then click <strong><span style='font-family:"Calibri",sans-serif'>Continue</span></strong>. Make sure to select all the devices you want to use for your testing.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt'>9.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Input a name for this provisioning profile (e.g. <em><span style='font-family:"Calibri",sans-serif'>Firebase Sample App Development Profile</span></em>), then click <strong><span style='font-family:"Calibri",sans-serif'>Generate</span></strong>.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt'>10.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Click <strong><span style='font-family:"Calibri",sans-serif'>Download</span></strong> to save the Provisioning Profile to your Mac.</span></p> <ol start="11" type="1"> <li class="MsoNormal" style='line-height:normal'><span style='font-size:9.0pt'>Double-click the Provisioning Profile file to install it.</span></li> </ol> <p class="MsoNormal"> </p> <h4><a name="node22" id="node22"></a>Upload your APNs authentication key</h4> <p><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>Upload your APNs authentication key, that we have generate earlier, to Firebase.</span></p> <p style='margin-left:.5in;text-indent:-.25in'><span style='font-size:9.0pt; font-family:"Calibri",sans-serif'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>Inside your project in the Firebase console, select the gear icon, select <strong><span style='font-family:"Calibri",sans-serif'>Project Settings</span></strong>, and then select the <strong><span style='font-family:"Calibri",sans-serif'>Cloud Messaging</span></strong> tab. </span></p> <p style='margin-left:.5in;text-indent:-.25in'><span style='font-size:9.0pt; font-family:"Calibri",sans-serif'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>In <strong><span style='font-family:"Calibri",sans-serif'>APNs authentication key</span></strong> under <strong><span style='font-family:"Calibri",sans-serif'>iOS app configuration</span></strong>, click the <strong><span style='font-family:"Calibri",sans-serif'>Upload</span></strong> button. </span></p> <p style='margin-left:.5in;text-indent:-.25in'><span style='font-size:9.0pt; font-family:"Calibri",sans-serif'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>Browse to the location where you saved your key, select it, and click <strong><span style='font-family:"Calibri",sans-serif'>Open</span></strong>. Add the key ID for the key (available in <strong><span style='font-family:"Calibri",sans-serif'>Certificates, Identifiers & Profiles</span></strong> in the </span><a href="https://developer.apple.com/membercenter/index.action"><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>Apple Developer Member Center</span></a><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>) and click <strong><span style='font-family:"Calibri",sans-serif'>Upload</span></strong>. </span></p> <p><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'> </span></p> <h4><a name="node23" id="node23"></a>Initialize Firebase in your app</h4> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>First make sure to turn ON Push Notifications and the Background Modes for our app in Xcode. You can find these settings by clicking on your project -> Targets -> Capabilities:</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'><img border="0" width="623" height="514" id="Picture 4" src="VOIP_Push_notifications_files/image015.jpg"></span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Make sure you select the following options:</span></p> <ul style='margin-top:0in' type="disc"> <li class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Remote notifications</span></li> </ul> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>The below code is ObjectC. Follow the same logic if you are using Swift or check the tutorials </span><a href="https://www.appcoda.com/firebase-push-notifications/"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size: 9.0pt;line-height:107%'> and </span><a href="http://shubhank101.github.io/iOSAndroidChaosOverFlow/2016/07/Push-Notification-in-iOS-using-FCM-(Swift)"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size: 9.0pt;line-height:107%'>.</span></p> <p class="MsoNormal" style='line-height:normal'><span style='font-size:9.0pt'>You'll need to add Firebase initialization code to your application. Import the Firebase module and configure a shared instance as shown:</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Import the Firebase module in your UIApplicationDelegate: </span></p> <p class="MsoNormal" style='margin-left:.5in;line-height:normal'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#643820'>#import </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'><Firebase/Firebase.h></span></p> <p class="MsoListParagraphCxSpFirst" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Configure a FirebaseApp shared instance, typically in your application's </span><i><span style='font-size:9.0pt;line-height:107%;font-family:"Menlo-Regular",serif; color:black'>didFinishLaunchingWithOptions</span></i><span style='font-size: 9.0pt;line-height:107%'>: method:</span></p> <p class="MsoListParagraphCxSpLast"><span style='font-size:9.0pt;line-height: 107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#3F6E74'>FIRApp</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#26474B'>configure</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>];</span></p> <p class="MsoListParagraphCxSpFirst"><span style='font-size:9.0pt;line-height: 107%;font-family:"Menlo-Regular",serif;color:black'>[</span><span style='font-size:9.0pt;line-height:107%;font-family:"Menlo-Regular",serif; color:#3F6E74'>FIRMessaging</span><span style='font-size:9.0pt;line-height: 107%;font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size:9.0pt;line-height:107%;font-family:"Menlo-Regular",serif; color:#26474B'>messaging</span><span style='font-size:9.0pt;line-height:107%; font-family:"Menlo-Regular",serif;color:black'>].</span><span style='font-size: 9.0pt;line-height:107%;font-family:"Menlo-Regular",serif;color:#3F6E74'>delegate</span><span style='font-size:9.0pt;line-height:107%;font-family:"Menlo-Regular",serif; color:black'> = </span><span style='font-size:9.0pt;line-height:107%; font-family:"Menlo-Regular",serif;color:#AA0D91'>self</span><span style='font-size:9.0pt;line-height:107%;font-family:"Menlo-Regular",serif; color:black'>;</span></p> <p class="MsoListParagraphCxSpLast"><span style='font-size:9.0pt;line-height: 107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> Also add the following code to </span><i><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>didFinishLaunchingWithOptions</span></i><span style='font-size: 9.0pt'> to request permission from user for displaying notifications:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#2E0D6E'>floor</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>(</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSFoundationVersionNumber</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>) <= </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#643820'>NSFoundationVersionNumber_iOS_9_x_Max</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>) {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>UIUserNotificationType</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'> allNotificationTypes =</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#2E0D6E'>UIUserNotificationTypeSound</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'> | </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>UIUserNotificationTypeAlert</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> | </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>UIUserNotificationTypeBadge</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>UIUserNotificationSettings</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'> *settings =</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> [</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>UIUserNotificationSettings</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>settingsForTypes</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:allNotificationTypes </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#2E0D6E'>categories</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>:</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>nil</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> [</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>self</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#2E0D6E'>registerUserNotificationSettings</span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:black'>:settings];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> } </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>else</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#007400'>// iOS 10 or later</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#643820'>#if defined(__IPHONE_10_0) && __IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_10_0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> [</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>UNUserNotificationCenter</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>currentNotificationCenter</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>].</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#5C2699'>delegate</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> = </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#AA0D91'>self</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>;</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>UNAuthorizationOptions</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'> authOptions =</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#2E0D6E'>UNAuthorizationOptionAlert</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> | </span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#2E0D6E'>UNAuthorizationOptionSound</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> | </span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#2E0D6E'>UNAuthorizationOptionBadge</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>;</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> [[</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#5C2699'>UNUserNotificationCenter</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>currentNotificationCenter</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>] </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>requestAuthorizationWithOptions</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:authOptions </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#2E0D6E'>completionHandler</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>:^(</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#AA0D91'>BOOL</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> granted, </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSError</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> * </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>_Nullable</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> error) {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> }]; </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#643820'>#endif</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> }</span></p> <p class="MsoNormal" style='line-height:normal'><b><span style='font-size:9.0pt'> </span></b></p> <h4><a name="node24" id="node24"></a>Receive the current registration token</h4> <p class="MsoNormal" style='line-height:normal'><span style='font-size:9.0pt'>Registration tokens are delivered via the method <i>didReceiveRegistrationToken</i>. This method is called generally once per app start with an FCM token or if for some reason the token is changed.</span></p> <p class="MsoNormal" style='line-height:normal'><span style='font-size:9.0pt'>To get the registration token, execute the below code:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#3F6E74'>NSString *fcmToken</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'> = [</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#3F6E74'>FIRMessaging</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#26474B'>messaging</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>].</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#3F6E74'>FCMToken</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>;</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#2E0D6E'>NSLog</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>(</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"Current FCM token is: %@"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>, </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#3F6E74'>fcmToken</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>);</span></p> <p class="MsoNormal" style='line-height:normal'><span style='font-size:9.0pt'>To receive updates about token changes, implement <i>didReceiveRegistrationToken </i>as below:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>- (</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>void</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>)messaging:(</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#3F6E74'>FIRMessaging</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'> *)messaging didReceiveRegistrationToken:(</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> *)fcmToken</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>{</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (fcmToken && [fcmToken</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#2E0D6E'> length</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>] > </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#1C00CF'>0</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-family:"Helvetica",sans-serif'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#2E0D6E'>NSLog</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>(</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"New FCM token received: %@"</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>, fcmToken);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Helvetica",sans-serif'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#007400'>// send the new registration token to the FCM server as described in the following chapter</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> }</span></p> <p class="MsoNormal" style='line-height:normal'><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>}</span></p> <h4><a name="node25" id="node25"></a>Configure the server or gateway</h4> <pre style='background:white'><span style='font-size:9.0pt'> </span></pre><pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>You need to set the following global config options (from the “Configurations” form):</span></pre><pre style='margin-left:.5in;text-indent:-.25in;background:white'><span style='font-size:9.0pt;font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>fcm_key: your FCM server key</span></pre><pre style='margin-left:.5in;text-indent:-.25in;background:white'><span style='font-size:9.0pt;font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>fcm_app: your package name</span></pre> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>More details about the server configuration can be found </span><a href="start.htm#_Configure_VoIP_push"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size:9.0pt;line-height:107%'>.</span></p> <h4><a name="node26" id="node26"></a>Register to the server/gateway</h4> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>You will need to send your app package name and token to the server with SIP REGISTER requests. For this you can implement </span><a href="https://tools.ietf.org/html/rfc8599"><span style='font-size:9.0pt; line-height:107%'>RFC 8599</span></a><span style='font-size:9.0pt;line-height: 107%'> or send the <span style='color:#833C0B'>X-MPUSH </span><span style='color:black'> (with the provider set to “</span><span style='color:#833C0B'>j</span><span style='color:black'>”)</span><span style='color:#833C0B'> </span>and <span style='color:#833C0B'>X-PIID </span>SIP headers with the REGISTER requests in the SIP signaling.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>All the details are described in the </span><a href="start.htm#_SIP_signaling_1"><span style='font-size:9.0pt;line-height:107%'>SIP Signaling</span></a><span style='font-size:9.0pt;line-height:107%'> chapter.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Example register request using the X-MPUSH header: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>REGISTER sip:gw.mydomain.com SIP/2.0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>Via: SIP/2.0/TCP 192.168.1.101:14501;alias;branch=z9hG4bK.edThn;rport</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>From: <sip:1111@gw.mydomain.com>;tag=tUgBfpF8h</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>To: sip:1111@gw.mydomain.com</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>CSeq: 2 REGISTER</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>Call-ID: enutmuwaynqib</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>Max-Forwards: 70</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>Contact: <sip:1111@192.168.1.101:14501></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>Authorization: Digest realm="sip.mydomain.com", nonce="WvDOe1rwzc2EDrmrsjELzwQLYnJ7tD3H", username="1111", uri="sip:gw.mydomain.com", response="1336341b517678240fb092e0cf1159a7"</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>Expires: 3600</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-size:8.0pt;color:#833C0B'>X-MPUSH: j:com.mycompany.myapp:c-10-ap_Kt0:BPC91bG7STqrz4cjrd_cqQquRLkH5iMi3eY4g</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-size:8.0pt;color:#833C0B'>X-PIID: 14d4f932e3897a39d6a17c13b526db</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><b><span style='font-size:8.0pt;line-height:107%;color:#833C0B'>X-Sy.Uppersrv: sip.mydomain.com</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>User-Agent: MyCoolApp</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>Content-Length: 0</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <h4><a name="node27" id="node27"></a>Handle notifications</h4> <p class="MsoNormal" style='line-height:normal'><span style='font-size:9.0pt'>Handle notifications received through the FCM APNs interface</span></p> <p class="MsoNormal" style='line-height:normal'><span style='font-size:9.0pt'>Once everything is set, you will receive </span><a href="start.htm#_VoIP_push_notification"><span style='font-size:9.0pt'>notifications</span></a><span style='font-size:9.0pt'> through the FCM APNs interface on incoming call or chat messages, which can be handled as described below.</span></p> <p class="MsoNormal" style='line-height:normal'><span style='font-size:9.0pt'>Also in your app delegate, implement <i>didReceiveRemoteNotification</i>: and <i>didReceiveRemoteNotification:fetchCompletionHamdler</i> as shown below:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>- (</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>void</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>)application:(</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#5C2699'>UIApplication</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> *)application didReceiveRemoteNotification:(</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#5C2699'>NSDictionary</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> *)userInfo</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>{</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#007400'>// If you are receiving a notification message while your app is in the background,</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#007400'>// this callback will not be fired till the user taps on the notification launching the application.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> *nfrom = </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@""</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>; </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#007400'>// other party number</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> *ntype = </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@""</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>; </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#007400'>// can be “0” for calls, “1” for chat messages, “2” for cancel, “3” for custom messages, “4” to request re-register</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> *<a name="_Hlk507526215">nmsg </a>= </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@""</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>; </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#007400'>// will contain the first part of the chat message</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> *title = </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@""</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>; </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#007400'>// Title of the notification</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> *body = </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@""</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>; </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#007400'>// Body of the notification, for example: “Incoming VoIP call from: 1234556”</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> *<a name="_Hlk507526276">sound </a>= </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@""</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>;</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Helvetica",sans-serif'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (userInfo[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"nfrom"</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>]) nfrom = userInfo[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"nfrom"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (userInfo[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"ntype"</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>]) ntype = userInfo[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"ntype"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'> if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (userInfo[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"nmsg "</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>]) nmsg = userInfo[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"nmsg"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'> if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (userInfo[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"title"</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>]) title = userInfo[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"title"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'> if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (userInfo[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"body"</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>]) body = userInfo[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"body"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'> if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (userInfo[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"sound"</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>]) sound = userInfo[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"sound"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#007400'>// Print full message.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#2E0D6E'>NSLog</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>(</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"FCM Firebase notif received simple FULL: %@"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>, userInfo);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> [</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#3F6E74'>yourViewController</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:#26474B'>PKNotifyUser</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:nfrom </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#26474B'>type</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:ntype </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#26474B'>msg</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:nmsg </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#26474B'>tit</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:title </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#26474B'>bdy</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:body </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#26474B'>snd</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:sound];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>}</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Helvetica",sans-serif'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>- (</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>void</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>)application:(</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#5C2699'>UIApplication</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> *)application didReceiveRemoteNotification:(</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#5C2699'>NSDictionary</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> *)userInfo fetchCompletionHandler:(</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#AA0D91'>void</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'> (^)(</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#5C2699'>UIBackgroundFetchResult</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>))completionHandler</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>{</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#007400'>// If you are receiving a notification message while your app is in the background,</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#007400'>// this callback will not be fired till the user taps on the notification launching the application.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'> NSString</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'> *nfrom = </span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@""</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>; </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#007400'>// other party number</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> *ntype = </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@""</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>; </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#007400'>// can be “0” for calls, “1” for chat messages, “2” for cancel, “3” for custom messages, “4” to request re-register</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> *nmsg = </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@""</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>; </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#007400'>// will contain the first part of the chat message</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> *title = </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@""</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>; </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#007400'>// Title of the notification</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> *body = </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@""</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>; </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#007400'>// Body of the notification, for example: “Incoming VoIP call from: 1234556”</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#5C2699'>NSString</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> *sound = </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@""</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>;</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Helvetica",sans-serif'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (userInfo[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"nfrom"</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>]) nfrom = userInfo[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"nfrom"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'>if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (userInfo[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"ntype"</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>]) ntype = userInfo[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"ntype"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'> if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (userInfo[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"nmsg "</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>]) nmsg = userInfo[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"nmsg"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'> if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (userInfo[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"title"</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>]) title = userInfo[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"title"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'> if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (userInfo[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"body"</span><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:black'>]) body = userInfo[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"body"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#AA0D91'> if</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> (userInfo[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"sound"</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>]) sound = userInfo[</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#C41A16'>@"sound"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#007400'>// Print full message.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#2E0D6E'>NSLog</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>(</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#C41A16'>@"FCM Firebase notif received fetchCompletionHandler FULL: %@"</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'>, userInfo);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> [</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#3F6E74'>yourViewController</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'> </span><span style='font-size: 9.0pt;font-family:"Menlo-Regular",serif;color:#26474B'>PKNotifyUser</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:nfrom </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#26474B'>type</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:ntype </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#26474B'>msg</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:nmsg </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#26474B'>tit</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:title </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#26474B'>bdy</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:body </span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:#26474B'>snd</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>:sound];</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:black'> completionHandler(</span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:#2E0D6E'>UIBackgroundFetchResultNewData</span><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif;color:black'>);</span></p> <p class="MsoNormal" style='line-height:normal'><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>}</span></p> <p class="MsoNormal" style='line-height:normal'><span style='font-size:9.0pt'>Function </span><i><span style='font-size:9.0pt;font-family:"Menlo-Regular",serif; color:#26474B'>PKNotifyUser</span></i><span style='font-size:9.0pt;font-family: "Menlo-Regular",serif;color:#26474B'> </span><span style='font-size:9.0pt; font-family:"Menlo-Regular",serif;color:black'>is just a simple LocalNotification on iOS. You can see an implementation example above in the PushKit notification handling.</span></p> <h2><a name="_Toc117069569"></a><a name="_Web"></a>Web</h2> <p class="MsoNormal"> </p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Follow these steps to add Firebase (FCM) push notifications to your WEB application. This can be any HTML5 SIP client such as a WebRTC client running in modern browsers or any HTML/Web based application.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>It can be used also in HTML based applications such as Ionic, Cordova or PhoneGap projects, however for native mobile applications you might use the above discussed iOS/Android native push notifications capabilities instead of this web based push.</span></p> <p class="MsoNormal"><i><span style='font-size:9.0pt;line-height:107%'>Please note that push notifications support in browsers is not so suitable for VoIP yet. They can’t wake-up the browser or auto-launch any webpage on incoming calls or emit any sound. They just displays a popup (if the browser is already running) where the user can click to launch your website and these notifications are known to be frequently blocked by users. </span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>A web standard exists by </span><a href="https://www.w3.org/TR/push-api/"><span style='font-size:9.0pt;line-height: 107%'>W3C Push API</span></a><span style='font-size:9.0pt;line-height:107%'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>HTTP Push is described in </span><a href="https://tools.ietf.org/html/rfc8030"><span style='font-size:9.0pt; line-height:107%'>RFC 8030</span></a><span style='font-size:9.0pt;line-height: 107%'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><i><span style='font-size:9.0pt;line-height:107%'>In case if you are using the Mizu </span></i><a href="https://www.mizu-voip.com/Software/WebPhone.aspx"><i><span style='font-size:9.0pt;line-height:107%'>webphone</span></i></a><i><span style='font-size:9.0pt;line-height:107%'> then jump </span></i><a href="start.htm#_WebPhone"><i><span style='font-size:9.0pt;line-height:107%'>here</span></i></a><i><span style='font-size:9.0pt;line-height:107%'>.</span></i></p> <h4><a name="node28" id="node28"></a>In short</h4> <p class="MsoListParagraphCxSpFirst" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Import the necessary Firebase javascript files into your html page.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Create a Firebase project and set the config parameters in your html page. Also add your server key and package name to the Mizu server global config (<span style='color:black'>fcm_key and fcm_app</span>)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Create “firebase-messaging-sw.js” service worker to receive notifications in “background”.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>SIP signaling changes: implement RFC 8599 or send the X-MPUSH and X-PIID SIP headers with the REGISTER requests in the SIP signaling</span></p> <h4><a name="node29" id="node29"></a>Prerequisites</h4> <p class="MsoListParagraphCxSpFirst" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Your web app must be hosted on secure website (HTTPS).</span></p> <p class="MsoListParagraphCxSpLast" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>The browser must support </span><a href="https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API"><span style='font-size:9.0pt;line-height:107%'>service worker API</span></a><span style='font-size:9.0pt;line-height:107%'>.</span></p> <h4><a name="node30" id="node30"></a>Online resources</h4> <p class="MsoListParagraphCxSpFirst" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://console.firebase.google.com/"><span style='font-size:9.0pt;line-height:107%'>Firebase console</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span class="MsoHyperlink"><span style='font-size:9.0pt;line-height:107%;font-family: Symbol;color:windowtext;text-decoration:none'>·<span style='font:7.0pt "Times New Roman"'> </span></span></span><a href="https://firebase.google.com/docs/cloud-messaging/"><span style='font-size:9.0pt;line-height:107%'>FCM Messaging</span></a><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span class="MsoHyperlink"><span style='font-size:9.0pt;line-height:107%;font-family: Symbol;color:windowtext;text-decoration:none'>·<span style='font:7.0pt "Times New Roman"'> </span></span></span><a href="https://firebase.google.com/docs/web/setup"><span style='font-size:9.0pt;line-height:107%'>Add FCM support to Web project</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span class="MsoHyperlink"><span style='font-size:9.0pt;line-height:107%;font-family: Symbol;color:windowtext;text-decoration:none'>·<span style='font:7.0pt "Times New Roman"'> </span></span></span><a href="https://firebase.google.com/docs/cloud-messaging/js/client"><span style='font-size:9.0pt;line-height:107%'>FCM Web Push notifications</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span class="MsoHyperlink"><span style='font-size:9.0pt;line-height:107%;font-family: Symbol;color:windowtext;text-decoration:none'>·<span style='font:7.0pt "Times New Roman"'> </span></span></span><a href="https://www.w3.org/TR/push-api/"><span style='font-size:9.0pt;line-height:107%'>W3C Push API</span></a></p> <p class="MsoListParagraphCxSpLast" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://medium.com/@cizu64/sending-notification-message-with-firebase-with-javascript-5d5c4bb02206"><span style='font-size:9.0pt;line-height:107%'>Tutorial</span></a></p> <h4><a name="node31" id="node31"></a>Create a Firebase project</h4> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>To use Firebase messaging (notifications) in your app you'll need a Firebase project and the Firebase configurations for your web app.</span></p> <p class="MsoListParagraphCxSpFirst" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Create a Firebase project in the </span><a href="https://console.firebase.google.com/"><span style='font-size:9.0pt;line-height:107%'>Firebase console</span></a><span style='font-size:9.0pt;line-height:107%'>, if you don't already have one. If you already have an existing Google project associated with your mobile app, click <b>Import Google Project</b>. Otherwise, click <b>Add project</b>.</span></p> <p class="MsoListParagraphCxSpMiddle"><span style='font-size:9.0pt;line-height: 107%'> </span></p> <p class="MsoListParagraphCxSpLast" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Click <b>Add Firebase to your Web app</b> and follow the setup steps. If you're importing an existing Google project, this may happen automatically and you can just copy the configurations which will have the following format:</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <pre style='margin-left:.5in'><span class="kwd"><i><span style='font-size:9.0pt'>var</span></i></span><span class="pln"><i><span style='font-size:9.0pt'> config </span></i></span><span class="pun"><i><span style='font-size:9.0pt'>=</span></i></span><span class="pln"><i><span style='font-size:9.0pt'> </span></i></span><span class="pun"><i><span style='font-size:9.0pt'>{</span></i></span><i><span style='font-size:9.0pt'><br> <span class="pln"> apiKey</span><span class="pun">:</span><span class="pln"> </span><span class="str">"<API_KEY>"</span><span class="pun">,</span><br> <span class="pln"> authDomain</span><span class="pun">:</span><span class="pln"> </span><span class="str">"<PROJECT_ID>.firebaseapp.com"</span><span class="pun">,</span><br> <span class="pln"> databaseURL</span><span class="pun">:</span><span class="pln"> </span><span class="str">"https://<DATABASE_NAME>.firebaseio.com"</span><span class="pun">,</span><br> <span class="pln"> projectId</span><span class="pun">:</span><span class="pln"> </span><span class="str">"<PROJECT_ID>"</span><span class="pun">,</span><br> <span class="pln"> storageBucket</span><span class="pun">:</span><span class="pln"> </span><span class="str">"<BUCKET>.appspot.com"</span><span class="pun">,</span><br> <span class="pln"> messagingSenderId</span><span class="pun">:</span><span class="pln"> </span><span class="str">"<SENDER_ID>"</span><span class="pun">,</span><br> <span class="pln"> </span><span class="pun">};</span></span></i></pre> <p class="MsoNormal" style='margin-left:.5in'><span style='font-size:9.0pt; line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <h4><a name="node32" id="node32"></a>Add Firebase to your web project</h4> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>To receive Firebase messaging (push notifications) in your web app, you need to perform a few basic tasks:</span></p> <p class="MsoListParagraphCxSpFirst" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>-<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Import firebase specific scripts</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>-<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Set the Firebase configurations which you got from Firebase console</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>-<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Initialize Firebase module</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>-<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Get an FCM token and send it to your server</span></p> <p class="MsoListParagraphCxSpLast" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>-<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Implement <i>onMessage()</i> and <i>setBackgroundMessageHandler()</i> to receive and handle push notification messages</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Below we will present a simple, but fully working example. This will consist of two files: a html page with the necessary Javascript imports and code to initialize the Firebase messaging module as a service worker Javasript file, which handles notifications, when the web page is in “background”.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Below is the fcm.html file source code:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#4472C4'><!DOCTYPE html></span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#4472C4'><html></span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#4472C4'><head></span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#4472C4'> <meta charset="utf-8" /></span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#4472C4'> <title>FCM Test</title></span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#4472C4'> <script src="https://www.gstatic.com/firebasejs/5.0.3/firebase.js"></script></span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#4472C4'> <!-- Firebase App is always required and must be first --></span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#4472C4'> <script src="https://www.gstatic.com/firebasejs/5.0.3/firebase-app.js"></script></span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#4472C4'> <!-- Add additional services you want to use --></span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#4472C4'> <script src="https://www.gstatic.com/firebasejs/5.0.3/firebase-messaging.js"></script></span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#4472C4'> </span></i><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'><script></span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><a name="_Hlk515522017"><i><span style='font-size:9.0pt;line-height:107%; color:#833C0B'> </span></i></a><i><span style='font-size:9.0pt; line-height:107%;color:#767171'>// configuration </span></i><i><span style='font-size:9.0pt;line-height:107%;color:#767171'>copied from Firebase console. Replace this code with your own.</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> var config = {</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> apiKey: "AIzaSyCREU-8xSHkP093-OrE7dSouPYa5lwI380",</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> authDomain: "voippush-da64b.firebaseapp.com",</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> databaseURL: "https://voippush-da64b.firebaseio.com",</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> projectId: "voippush-da64b",</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> storageBucket: "voippush-da64b.appspot.com",</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> messagingSenderId: "191412546148"</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> };</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> </span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> </span></i><i><span style='font-size:9.0pt;line-height:107%;color:#767171'>// Initialize Firebase module</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> firebase.initializeApp(config);</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> var messaging = firebase.messaging();</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> </span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> </span></i><i><span style='font-size:9.0pt;line-height:107%;color:#767171'>// Request permission to show notifications</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> messaging.requestPermission()</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> .then(function ()</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> {</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> console.log('Notification permission granted');</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> </span></i><i><span style='font-size:9.0pt;line-height:107%;color:#767171'>// Request token</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> return messaging.getToken();</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> })</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> .then(function (token)</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> {</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> </span></i><i><span style='font-size:9.0pt;line-height:107%;color:#767171'>// token is received here</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> console.log('My FCM token is: ' + token);</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> </span></i><i><span style='font-size:9.0pt;line-height:107%;color:#767171'>// send token to server - add sip header in SIP signaling</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> })</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> .catch(function (err)</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> {</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> </span></i><i><span style='font-size:9.0pt;line-height:107%;color:#767171'>// log error message to console in case if user denied permission to show notification or getToken() failed</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> console.error('ERROR, Request notification permission failed');</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> });</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> </span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> </span></i><i><span style='font-size:9.0pt;line-height:107%;color:#767171'>// implement onMessage() handler. Here we will receive push notification </span></i><a href="start.htm#_VoIP_push_notification"><i><span style='font-size:9.0pt;line-height: 107%'>messages</span></i></a><i><span style='font-size:9.0pt;line-height:107%; color:#767171'> ONLY when the web page is in foreground</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> messaging.onMessage(function (payload)</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> {</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> console.log('onMessage: ' + payload);</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> });</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> </script></span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#4472C4'></head></span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#4472C4'><body></span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#4472C4'> FCM Test</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#4472C4'></body></span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#4472C4'></html></span></i></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>To send the token and SIP account details to the server you can use <span style='color: #833C0B'>X-MPUSH </span><span style='color:black'>(with the provider set to “</span><span style='color:#833C0B'>w</span><span style='color:black'>”)</span><span style='color:#833C0B'> </span>and the <span style='color:#833C0B'>X-PIID </span><span style='color:black'>headers or implement </span></span><a href="https://tools.ietf.org/html/rfc8599"><span style='font-size:9.0pt; line-height:107%'>RFC 8599</span></a><span style='font-size:9.0pt;line-height: 107%'>. For the details see the </span><a href="start.htm#_SIP_signaling_1"><span style='font-size:9.0pt;line-height:107%'>SIP Signaling</span></a><span style='font-size:9.0pt;line-height:107%'> chapter. </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>NOTE: In <i>onMessage()</i> handler we will receive push notification messages only when the web page is in foreground. We also have to implement a service worker to receive push messages when the app is in background.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>The service worker javascript file must have this exact name: “<i>firebase-messaging-sw.js</i>” and must be located in the root directory of your web page where you are hosting the webphone (NOT in the root directory of the webphone). Example: </span><a href="https://www.domain.com/firebase-messaging-sw.js"><span style='font-size: 9.0pt;line-height:107%'>https://www.domain.com/firebase-messaging-sw.js</span></a></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>NOTE: If this file is not located in the root directory of your web site, Firebase push notification will not work at all, not even in foreground.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Below is an example code “<i>firebase-messaging-sw.js</i>” source code:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#767171'>// import necessary scripts</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>importScripts('https://www.gstatic.com/firebasejs/5.0.3/firebase-app.js');</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>importScripts('https://www.gstatic.com/firebasejs/5.0.3/firebase-messaging.js');</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#767171'>// configuration copied from Firebase console. Replace this code with your own (same as in the fcm.html file)</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>var config = {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> apiKey: "AIzaSyCREU-8xSHkP093-OrE7dSouPYa5lwI380",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> authDomain: "voippush-da64b.firebaseapp.com",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> databaseURL: "https://voippush-da64b.firebaseio.com",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> projectId: "voippush-da64b",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> storageBucket: "voippush-da64b.appspot.com",</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> messagingSenderId: "191412546148"</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> };</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#767171'>// Initialize Firebase module</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>firebase.initializeApp(config);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>var messaging = firebase.messaging();</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:#767171'>// implement setBackgroundMessageHandler() handler to receive push notification messages when the web page is in background</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>messaging.setBackgroundMessageHandler(function(payload)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>{</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> console.log('[firebase-messaging-sw.js] Received background message ', payload);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> </span><span style='font-size:9.0pt;line-height:107%;color:#767171'>// Customize notification here</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> var notificationTitle = 'Message title';</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> var notificationBody = 'Message body: ' + JSON.stringify(payload);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> var notificationOptions = {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> body: notificationBody,</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> icon: '' </span><span style='font-size:9.0pt;line-height:107%;color:#767171'>// icon image path, ex: 'images/notification-icon.png'</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> };</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#767171'>// Present the notification to the user</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> return self.registration.showNotification(notificationTitle, notificationOptions);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>});</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <h4><a name="node33" id="node33"></a>Configure the server or gateway</h4> <pre style='background:white'><span style='font-size:9.0pt'> </span></pre><pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>You need to set the following global config options (from the “Configurations” form):</span></pre><pre style='margin-left:.5in;text-indent:-.25in;background:white'><span style='font-size:9.0pt;font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>pushnotification_fcm: set to 1</span></pre><pre style='margin-left:.5in;text-indent:-.25in;background:white'><span style='font-size:9.0pt;font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>fcm_key: your FCM server key</span></pre><pre style='margin-left:.5in;text-indent:-.25in;background:white'><span style='font-size:9.0pt;font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>fcm_app: your package name</span></pre> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif; color:black'>The FCM server key must be loaded from firebase console -> project settings (gear icon in the top left near the “Project Overview”) -> Cloud Messaging page -> Server key (so it is NOT the “Web API Key” and NOT the “Legacy server key”)</span></pre> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>More details about the server configuration can be found </span><a href="start.htm#_Configure_VoIP_push"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size:9.0pt;line-height:107%'>.</span></p> <h4><a name="node34" id="node34"></a>Register to the server or gateway</h4> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>You will need to send your app package name and token to the server with SIP REGISTER requests. For this you can implement </span><a href="https://tools.ietf.org/html/rfc8599"><span style='font-size:9.0pt; line-height:107%'>RFC 8599</span></a><span style='font-size:9.0pt;line-height: 107%'> or send the <span style='color:#833C0B'>X-MPUSH </span><span style='color:black'> (with the provider set to “w”)</span><span style='color:#833C0B'> </span>and <span style='color:#833C0B'>X-PIID </span>SIP headers with the REGISTER requests in the SIP signaling.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>All the details are described in the </span><a href="start.htm#_SIP_signaling_1"><span style='font-size:9.0pt;line-height:107%'>SIP Signaling</span></a><span style='font-size:9.0pt;line-height:107%'> chapter.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <h2><a name="_Toc117069570"></a><a name="_WebPhone"></a>WebPhone</h2> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>This chapter is only about the Mizutech </span><a href="https://www.mizu-voip.com/Software/WebPhone.aspx"><span style='font-size: 9.0pt;line-height:107%'>browser SIP client</span></a><span style='font-size: 9.0pt;line-height:107%'>. The notifications are handled the same way as </span><a href="start.htm#_Web"><span style='font-size:9.0pt;line-height:107%'>described above</span></a><span style='font-size:9.0pt;line-height:107%'> for a generic web client, but since the Mizu webphone already comes with push notifications support, you have less to do in this case.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>Push notifications <i>are specific for the webphone WebRTC engine only. With the NS engine you already have a local service which can listen for incoming calls even if the browser is not running, providing a much superior always-on experience for endusers.</i></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><i><span style='font-size:9.0pt'> </span></i></p> <p class="MsoNormal"><i><span style='font-size:9.0pt;line-height:107%'>Please note that push notifications support in browsers is not so suitable for VoIP yet. They can’t wake-up the browser or auto-launch any webpage on incoming calls or emit any sound. They just displays a popup (if the browser is already running) where the user can click to launch your website and these notifications are known to be frequently blocked by users. </span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><i><span style='font-size:9.0pt'> </span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>SIP push notifications are supported by the webphone by default but this is a service which also requires server-side support. You have the following possibilities:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Via the free Mizu PUSH service. If you are using the Mizutech WebRTC-SIP gateway service, then you also have server side push notifications support. In this case </span><span style='font-size:9.0pt'>you just need to set the webphone <span style='color:#833C0B'>backgroundcalls </span>parameter to<span style='color:#833C0B'> 1 </span>and there is no need for anything else. You can skip this documentation.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Directly with your SIP server if your server has support for push notifications. Contact your server vendor or check your server </span><a href="https://www.zoiper.com/en/tutorials/push-notifications"><span style='font-size:9.0pt;line-height:107%'>documentations</span></a><span style='font-size:9.0pt;line-height:107%'> for the details and implement it accordingly for the webphone as it has less to do with this documentation (except that you might utilize part of the example code presented here).</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Using the webphone with the Mizu </span><a href="https://www.mizu-voip.com/Software/VoIPServer.aspx"><span style='font-size:9.0pt'>SIP Softswitch</span></a><span style='font-size:9.0pt'> or </span><a href="https://www.mizu-voip.com/Software/VoIPServer/WindowsPBX.aspx"><span style='font-size:9.0pt'>IP-PBX</span></a><span style='font-size:9.0pt'>. Push notifications are supported by all Mizu server side products. </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>With the Mizu </span><a href="https://www.mizu-voip.com/Software/WebRTCtoSIP.aspx"><span style='font-size:9.0pt'>WebRTC-SIP</span></a><span style='font-size:9.0pt'> or </span><a href="https://www.mizu-voip.com/Software/VoIPPushGateway.aspx"><span style='font-size:9.0pt'>voip push gateway</span></a><span style='font-size: 9.0pt'>. In case if your SIP server don’t support push notifications then instead of using our free service, you can setup your dedicated gateway to handle the push notifications. </span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>The last two points are covered by this documentation. Follow the below description in case if you wish to use the Mizu server or gateway to add push notification support for your webphone.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <h4><a name="node35" id="node35"></a>In short</h4> <p class="MsoListParagraphCxSpFirst" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Create a Firebase project and set the config parameters in Webphone. Also add your server key and package name to the Mizu server global config (<span style='color:black'>fcm_key and fcm_app</span>)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Enable push notifications by settings “backgroundcalls” webphone parameter to 1.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Create “firebase-messaging-sw.js” service worker to receive notifications in “background”.</span></p> <h4><a name="node36" id="node36"></a>Prerequisites</h4> <p class="MsoListParagraphCxSpFirst" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Webphone must be hosted on secure website (HTTPS).</span></p> <p class="MsoListParagraphCxSpLast" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>The browser must support </span><a href="https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API"><span style='font-size:9.0pt;line-height:107%'>service worker API</span></a><span style='font-size:9.0pt;line-height:107%'>.</span></p> <h4><a name="node37" id="node37"></a>Create a Firebase project</h4> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>To use Firebase messaging (notifications) in your app you'll need a Firebase project and the Firebase configurations for your web app.</span></p> <p class="MsoListParagraphCxSpFirst" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Create a Firebase project in the </span><a href="https://console.firebase.google.com/"><span style='font-size:9.0pt;line-height:107%'>Firebase console</span></a><span style='font-size:9.0pt;line-height:107%'>, if you don't already have one. If you already have an existing Google project associated with your mobile app, click <b>Import Google Project</b>. Otherwise, click <b>Add project</b>.</span></p> <p class="MsoListParagraphCxSpMiddle"><span style='font-size:9.0pt;line-height: 107%'> </span></p> <p class="MsoListParagraphCxSpLast" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Click <b>Add Firebase to your Web app</b> and follow the setup steps. If you're importing an existing Google project, this may happen automatically and you can just copy the configurations which will have the following format:</span></p> <pre style='margin-left:.5in'><span class="kwd"><i><span style='font-size:9.0pt'>var</span></i></span><span class="pln"><i><span style='font-size:9.0pt'> config </span></i></span><span class="pun"><i><span style='font-size:9.0pt'>=</span></i></span><span class="pln"><i><span style='font-size:9.0pt'> </span></i></span><span class="pun"><i><span style='font-size:9.0pt'>{</span></i></span><i><span style='font-size:9.0pt'><br> <span class="pln"> apiKey</span><span class="pun">:</span><span class="pln"> </span><span class="str">"<API_KEY>"</span><span class="pun">,</span><br> <span class="pln"> authDomain</span><span class="pun">:</span><span class="pln"> </span><span class="str">"<PROJECT_ID>.firebaseapp.com"</span><span class="pun">,</span><br> <span class="pln"> databaseURL</span><span class="pun">:</span><span class="pln"> </span><span class="str">"https://<DATABASE_NAME>.firebaseio.com"</span><span class="pun">,</span><br> <span class="pln"> projectId</span><span class="pun">:</span><span class="pln"> </span><span class="str">"<PROJECT_ID>"</span><span class="pun">,</span><br> <span class="pln"> storageBucket</span><span class="pun">:</span><span class="pln"> </span><span class="str">"<BUCKET>.appspot.com"</span><span class="pun">,</span><br> <span class="pln"> messagingSenderId</span><span class="pun">:</span><span class="pln"> </span><span class="str">"<SENDER_ID>"</span><span class="pun">,</span><br> <span class="pln"> </span><span class="pun">};</span></span></i></pre> <h4><a name="node38" id="node38"></a>Set Firebase configuration in your webphone</h4> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>To enable Firebase messaging (push notifications) in your webphone, you need to perform a few basic tasks:</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Overwrite the Firebase config “webphone_api.js” (at the beginning of the file) with the one you retrieved from Firebase console in the previous step. </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Also, overwrite the Firebase config in the service worker file “firebase-messaging-sw.js” (at the beginning of the file) with the one you retrieved from Firebase console in the previous step.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Move the service worker file “firebase-messaging-sw.js” to the root directory of your web page where you are hosting the webphone (NOT in the root directory of the webphone). This is very important, otherwise web push notifications will not work. Example: https://www.domain.com/firebase-messaging-sw.js</span></p> <pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif; color:black'>Enable push notifications in your webphone using the </span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:#833C0B'>backgroundcalls</span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'> parameter (set to 1). See more details in the </span><a href="https://www.mizu-voip.com/Portals/0/Files/Webphone_Documentation.pdf"><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>webphone documentation</span></a><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>.</span></pre><pre style='background:white'><span style='font-size:9.0pt;color:black'> </span></pre> <h4><a name="node39" id="node39"></a>Configure the Mizutech server or gateway</h4> <pre style='background:white'><span style='font-size:9.0pt'> </span></pre><pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>You need to set the following global config options (from the “Configurations” form):</span></pre><pre style='margin-left:.5in;text-indent:-.25in;background:white'><span style='font-size:9.0pt;font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>pushnotification_fcm: set to 1</span></pre><pre style='margin-left:.5in;text-indent:-.25in;background:white'><span style='font-size:9.0pt;font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>fcm_key: your FCM server key</span></pre><pre style='margin-left:.5in;text-indent:-.25in;background:white'><span style='font-size:9.0pt;font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>fcm_app: your package name</span></pre> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif; color:black'>The FCM server key must be loaded from firebase console -> project settings (gear icon in the top left near the “Project Overview”) -> Cloud Messaging page -> Server key (so it is NOT the “Web API Key” and NOT the “Legacy server key”).</span></pre><pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif; color:black'> </span></pre> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>More details about the server configuration can be found </span><a href="start.htm#_Configure_VoIP_push"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size:9.0pt;line-height:107%'>.</span></p> <h4><a name="node40" id="node40"></a>Register to server or gateway</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Just register with a SIP account to Mizu server/gateway (this is usually done automatically by the webphone depending on the <span style='color:#833C0B'>register</span> parameter or you can use the <span style='color:#833C0B'>register()</span> API)</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <h4><a name="node41" id="node41"></a>Receive and handle notifications</h4> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>When the webphone is in “background”, the push notification message will be received in the “firebase-messaging-sw.js” service worker in the <i>setBackgroundMessageHandler()</i> callback function. When the VoIP push notification </span><a href="start.htm#_VoIP_push_notification"><span style='font-size:9.0pt;line-height:107%'>message</span></a><span style='font-size:9.0pt;line-height:107%'> is received a browser notification will be displayed. This notification can be customized in “firebase-messaging-sw.js”.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <h2><a name="_Toc117069571"></a><a name="_AJVoIP"></a>AJVoIP</h2> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>This chapter is only about the Mizutech </span><a href="https://www.mizu-voip.com/Software/SIPSDK/AndroidSIPSDK.aspx"><span style='font-size:9.0pt;line-height:107%'>Android SIP library</span></a><span style='font-size:9.0pt;line-height:107%'> in case if you wish to implement push notifications using the </span><a href="https://www.mizu-voip.com/Software/VoIPPushGateway.aspx"><span style='font-size:9.0pt;line-height:107%'>MPUSH gateway</span></a><span style='font-size:9.0pt;line-height:107%'> or </span><a href="https://www.mizu-voip.com/Software/VoIPServer.aspx"><span style='font-size:9.0pt;line-height:107%'>Softswitch</span></a><span style='font-size:9.0pt;line-height:107%'>.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>The notifications are handled the same way as </span><a href="start.htm#_Android"><span style='font-size:9.0pt;line-height:107%'>described above</span></a><span style='font-size:9.0pt;line-height:107%'> for a generic android client, but since the Mizu android SIP SDK already comes with push notifications support, you have less to do in this case. </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>You need this integration only if you wish to implement push notifications directly with your SIP server or via dedicated </span><a href="https://www.mizu-voip.com/Software/VoIPPushGateway.aspx"><span style='font-size:9.0pt;line-height:107%'>push gateway</span></a><span style='font-size:9.0pt;line-height:107%'>. Otherwise AJVoIP is capable for push notifications by default, using the mizutech push notification service (free tier offered by all customers) and its </span><a href="start.htm#_AJVoIP_with_the"><span style='font-size:9.0pt;line-height:107%'>implementation</span></a><span style='font-size:9.0pt;line-height:107%'> is even more simple.</span></p> <h4><a name="node42" id="node42"></a>In short</h4> <p class="MsoListParagraphCxSpFirst" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Create a Firebase project and add its json config file to your project’s module directory. Also add your server key and package name to the Mizu server global config (<span style='color:black'>fcm_key and fcm_app</span>)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Implement Firebase as described </span><a href="https://console.firebase.google.com/"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size: 9.0pt;line-height:107%'>, </span><a href="https://firebase.google.com/docs/cloud-messaging/"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size: 9.0pt;line-height:107%'> and </span><a href="https://firebase.google.com/docs/cloud-messaging/android/client"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size: 9.0pt;line-height:107%'> (Firebase registration and handling the push notifications)</span></p> <h4><a name="node43" id="node43"></a>Prerequisites</h4> <p class="MsoListParagraphCxSpFirst" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>A device running Android 4.0 (Ice Cream Sandwich) or newer, and Google Play services 11.8.0 or higher</span></p> <p class="MsoListParagraphCxSpLast" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>The latest version of </span><a href="https://developer.android.com/studio/index.html"><span style='font-size:9.0pt;line-height:107%'>Android Studio</span></a><span style='font-size:9.0pt;line-height:107%'> (You can also use other IDE such as Eclipse, however this guide is guide is for Android Studio)</span></p> <h4><a name="node44" id="node44"></a>Online resources</h4> <p class="MsoListParagraphCxSpFirst" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://console.firebase.google.com/"><span style='font-size:9.0pt;line-height:107%'>Firebase console</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span class="MsoHyperlink"><span style='font-size:9.0pt;line-height:107%;font-family: Symbol;color:windowtext;text-decoration:none'>·<span style='font:7.0pt "Times New Roman"'> </span></span></span><a href="https://firebase.google.com/docs/cloud-messaging/"><span style='font-size:9.0pt;line-height:107%'>FCM Messaging</span></a><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://firebase.google.com/docs/cloud-messaging/android/client"><span style='font-size:9.0pt;line-height:107%'>Add FCM support to Android project</span></a></p> <p class="MsoListParagraphCxSpLast" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://www.codementor.io/flame3/send-push-notifications-to-android-with-firebase-du10860kb"><span style='font-size:9.0pt;line-height:107%'>Tutorial</span></a></p> <h4><a name="node45" id="node45"></a>Create a Firebase project</h4> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>To add Firebase to your app you'll need a Firebase project and a Firebase configuration file for your app.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Create a Firebase project in the </span><a href="https://console.firebase.google.com/"><span style='font-size:9.0pt;line-height:107%'>Firebase console</span></a><span style='font-size:9.0pt;line-height:107%'>, if you don't already have one. If you already have an existing Google project associated with your mobile app, click <b>Import Google Project</b>. Otherwise, click <b>Add project</b>.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Click <b>Add Firebase to your Android app</b> and follow the setup steps. If you're importing an existing Google project, this may happen automatically and you can just </span><a href="http://support.google.com/firebase/answer/7015592"><span style='font-size:9.0pt;line-height:107%'>download the config file</span></a><span style='font-size:9.0pt;line-height:107%'>.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>When prompted, enter your app's package name. It's important to enter the package name your app is using; this can only be set when you add an app to your Firebase project.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>4.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>At the end, you'll download a google-services.json file. You can </span><a href="http://support.google.com/firebase/answer/7015592"><span style='font-size:9.0pt;line-height:107%'>download this file</span></a><span style='font-size:9.0pt;line-height:107%'> again at any time.</span></p> <p class="MsoNormal" style='margin-left:.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>5.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>If you haven't done so already, copy this into your project's module folder, typically app/.</span></p> <p class="MsoNormal"> </p> <h4><a name="node46" id="node46"></a>Configure Firebase for your app</h4> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>To integrate the Firebase libraries into one of your own Android project, you need to add Firebase to your Android project. This can be done in the following way:</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>First, add rules to your root-level build.gradle file, to include the google-services plugin and the Google's Maven repository:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;background:white'><span style='font-size:9.0pt;font-family:"Courier New"; color:black'>buildscript {<br> repositories {<br> jcenter()<br> google()<br> }<br> dependencies {<br> </span><b><span style='font-size:9.0pt;font-family:"Courier New";color:green'> </span></b><span style='font-size:9.0pt;font-family:"Courier New";color:black'>classpath </span><b><span style='font-size:9.0pt;font-family:"Courier New";color:green'>'com.google.gms:google-services:3.0.0'<br> </span></b><span style='font-size:9.0pt;font-family:"Courier New"; color:black'>}<br> }<br> <br> allprojects {<br> repositories {<br> jcenter()<br> google()<br> }<br> }</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Then, in your module Gradle file (usually the app/build.gradle), add firebase messaging to dependencies and the apply plugin line at the bottom of the file to enable the Gradle plugin:</span></p> <pre style='background:white'><span style='font-size:9.0pt;color:black'>//...</span></pre><pre style='background:white'><span style='font-size:9.0pt;color:black'>dependencies {<br> compile </span><b><span style='font-size:9.0pt;color:green'>'com.google.firebase:firebase-messaging:10.0.1'</span></b><span style='font-size:9.0pt;color:black'><br> }<br> apply </span><b><span style='font-size:9.0pt;color:green'>plugin</span></b><span style='font-size:9.0pt;color:black'>: </span><b><span style='font-size:9.0pt; color:green'>'com.google.gms.google-services'</span></b></pre><pre style='background:white'><span style='font-size:9.0pt;color:black'> </span></pre><pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif; color:black'>Also, be sure to set <i>minSdkVersion 9</i> or higher in the app's build.gradle to support FCM.</span></pre> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <h4><a name="node47" id="node47"></a>Manifest configuration</h4> <p class="MsoNormal"> </p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Add the following Services to your Android Manifest:</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>A service that extends FirebaseMessagingService. This provides the functionality to receive notifications.</span></p> <pre><span class="tag"><span style='font-size:9.0pt'><service</span></span><span style='font-size:9.0pt'><br> <span class="pln"> </span><span class="atn">android:name</span><span class="pun">=</span><span class="atv">".MyFirebaseMessagingService"</span><span class="tag">></span><br> <span class="pln"> </span><span class="tag"><intent-filter></span><br> <span class="pln"> </span><span class="tag"><action</span><span class="pln"> </span><span class="atn">android:name</span><span class="pun">=</span><span class="atv">"com.google.firebase.MESSAGING_EVENT"</span><span class="tag">/></span><br> <span class="pln"> </span><span class="tag"></intent-filter></span><br> <span class="tag"></service></span></span></pre> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>A service that extends FirebaseInstanceIdService to handle the creation, rotation, and updating of registration tokens.</span></p> <pre><span class="tag"><span style='font-size:9.0pt'><service</span></span><span style='font-size:9.0pt'><br> <span class="pln"> </span><span class="atn">android:name</span><span class="pun">=</span><span class="atv">".MyFirebaseInstanceIDService"</span><span class="tag">></span><br> <span class="pln"> </span><span class="tag"><intent-filter></span><br> <span class="pln"> </span><span class="tag"><action</span><span class="pln"> </span><span class="atn">android:name</span><span class="pun">=</span><span class="atv">"com.google.firebase.INSTANCE_ID_EVENT"</span><span class="tag">/></span><br> <span class="pln"> </span><span class="tag"></intent-filter></span><br> <span class="tag"></service></span></span></pre><pre><span style='font-size:9.0pt'> </span></pre> <h4><a name="node48" id="node48"></a>Get the device registration token</h4> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>On initial startup of your softphone, the FCM SDK generates a registration token for the client app instance. This token will be used later by the FCM server to send notifications to a specific device. To retrieve the current token, call </span><a href="https://firebase.google.com/docs/reference/android/com/google/firebase/iid/FirebaseInstanceId.html#public-methods"><span style='font-size:9.0pt;line-height:107%'>FirebaseInstanceId.getInstance().getToken()</span></a><span style='font-size:9.0pt;line-height:107%'>. This method returns null if the token has not yet been generated.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Below is the implementation of </span><span class="atv"><span style='font-size:9.0pt; line-height:107%'>MyFirebaseInstanceIDService used for receiving the token updates:</span></span></p> <pre style='background:white'><b><span style='font-size:9.0pt;color:navy'>import </span></b><span style='font-size:9.0pt;color:black'>com.google.firebase.iid.FirebaseInstanceId;<br> </span><b><span style='font-size:9.0pt;color:navy'>import </span></b><span style='font-size:9.0pt;color:black'>com.google.firebase.iid.FirebaseInstanceIdService;<br> <br> </span><b><span style='font-size:9.0pt;color:navy'>public class </span></b><span style='font-size:9.0pt;color:black'>MyFirebaseInstanceIDService </span><b><span style='font-size:9.0pt;color:navy'>extends </span></b><span style='font-size: 9.0pt;color:black'>FirebaseInstanceIdService<br> {<br> </span><span style='font-size:9.0pt;color:olive'>@Override<br> </span><b><span style='font-size:9.0pt;color:navy'>public void </span></b><span style='font-size:9.0pt;color:black'>onTokenRefresh()<br> {<br> </span><i><span style='font-size:9.0pt;color:gray'>// Get updated token and store it<br> </span></i><span style='font-size:9.0pt;color:black'>String updatedToken = FirebaseInstanceId.<i>getInstance</i>().getToken();<br> }<br> <br> }</span></pre><pre style='background:white'><span style='font-size:9.0pt; color:black'> </span></pre> <h4><a name="node49" id="node49"></a>Configure the server or gateway</h4> <pre style='background:white'><span style='font-size:9.0pt'> </span></pre><pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif'>You need to set the following global config options (from the “Configurations” form):</span></pre><pre style='margin-left:.5in;text-indent:-.25in;background:white'><span style='font-size:9.0pt;font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>pushnotification_fcm: set to 1</span></pre><pre style='margin-left:.5in;text-indent:-.25in;background:white'><span style='font-size:9.0pt;font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>fcm_key: your FCM server key</span></pre><pre style='margin-left:.5in;text-indent:-.25in;background:white'><span style='font-size:9.0pt;font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>fcm_app: your package name</span></pre><pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif; color:black'> </span></pre><pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>The FCM server key must be loaded from firebase console -> project settings (gear icon in the top left near the “Project Overview”) -> Cloud Messaging page -> Server key (so it is NOT the “Web API Key” and NOT the “Legacy server key”)</span></pre><pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif; color:black'> </span></pre> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>More details about the server configuration can be found </span><a href="start.htm#_Configure_VoIP_push"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size:9.0pt;line-height:107%'>.</span></p> <h4><a name="node50" id="node50"></a>MBuilder</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>This chapter is useful only for MizuTech support to build your library with preconfigured push notification settings. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>The following push related parameters can be preconfigured: </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Common.pushnotifications = 1; // -1: auto (def), 0: disabled, 1: enabled auto, 2: enabled direct,3: enabled via gateway </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Common.packagename = "com.company.appname.app"; //application package name or project ID. default is com.mizuvoip.mizudroid.app and loaded from the app</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Common.fcmgateway = "fcm.webvoipphone.com:35060"; //default gateway address (default value is fcm.webvoipphone.com:35060)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Common.pushtype = -1; //-1: auto (default auto guess) , 1: X-MPUSH, 2: RFC8599</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Common.cfcm = "iX_cfcm.json" //google-services.json (also uploaded to web/ftp storage folder)</span></p> <h4><a name="node51" id="node51"></a>Enable push notifications</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>You just need to use a single API to enable/disable push notification in AJVoIP:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><b><span style='font-size:9.0pt;line-height:107%;color:black'>boolean SetPushNotifications(int pushnotifications, String fcmclientid, String packagename, String gateway)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'>Parameters:</span></p> <pre style='margin-left:.25in;text-indent:-.25in;background:white'><span style='font-size:9.0pt;font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>pushnotifications: </span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>-1=auto guess, 0=disabled, 1=enabled auto, 2=enabled direct, 3=enabled via gateway</span></pre><pre style='margin-left:.25in;text-indent:-.25in;background:white'><span style='font-size:9.0pt;font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>clientid: </span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>token received from FCM</span></pre><pre style='margin-left:.25in;text-indent:-.25in;background:white'><span style='font-size:9.0pt;font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>packagename: </span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>your app package name or project ID (for example com.mycompany.coolapp.voip)</span></pre><pre style='margin-left:.25in;text-indent:-.25in;background:white'><span style='font-size:9.0pt;font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>gateway: </span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>address of your MPUSH gateway or SBC (if you wish to use a gateway for push notifications)</span></pre><pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif; color:black'>Will return </span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif; color:black'>true on success, false on failure (check the log on failure).</span></pre> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>You should call it just after you called the Init or the Start API.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><u><span style='font-size:9.0pt;line-height:107%'>For example:</span></u></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>-<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>to enable push notifications, you would call the API function like this:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>SetPushNotifications(2, token, packagename, “”);</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%'> </span></i></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>-<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>to disable push notifications:</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>SetPushNotifications(0, “”, “”, “”);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><u><span style='font-size:9.0pt;line-height:107%'>Other related settings:</span></u></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Usually you don’t need to change any of these JVoIP parameters unless you have a good reason (just use the SetPushNotification API instead):</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>pushnotifications: -1: auto (def), 0: disabled, 1: enabled auto, 2: enabled direct,3: enabled via gateway </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>packagename: application package name or project ID</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>fcmgateway: default gateway address (default value is fcm.webvoipphone.com:35060)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>pushtype: -1: auto (default auto guess) , 1: X-MPUSH, 2: RFC8599</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>For more details see the </span><a href="https://www.mizu-voip.com/Portals/0/Files/AndroidSIPSDK.pdf"><span style='font-size:9.0pt;line-height:107%'>Android SIP library documentation</span></a><span style='font-size:9.0pt;line-height:107%'>.</span></p> <h4><a name="node52" id="node52"></a>Receive and handle notifications</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>On </span><a href="start.htm#_VoIP_push_notification"><span style='font-size:9.0pt;line-height:107%'>incoming notification</span></a><span style='font-size:9.0pt;line-height:107%'> your app might do the followings:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>On text message (chat): just display it as a notification (user can tap on it to launch your app and see more details)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>On call: just wake-up the app (once your app is started, it will auto-register and it will receive the incoming INVITE thus it can handle the incoming call as normally)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>You can also handle other events if you have some specific needs</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>We are using the Java language for the below example code. You can follow the same logic with other language such as Kotlin.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>To receive notifications we need to implement </span><span class="atv"><i><span style='font-size:9.0pt;line-height:107%'>MyFirebaseMessagingService.</span></i></span><span class="atv"><span style='font-size:9.0pt;line-height:107%'> Below is an example of that:</span></span></p> <pre style='background:white'><b><span style='font-size:9.0pt;color:navy'>import </span></b><span style='font-size:9.0pt;color:black'>com.google.firebase.messaging.FirebaseMessagingService;<br> </span><b><span style='font-size:9.0pt;color:navy'>import </span></b><span style='font-size:9.0pt;color:black'>com.google.firebase.messaging.RemoteMessage;<br> </span><b><span style='font-size:9.0pt;color:navy'>import </span></b><span style='font-size:9.0pt;color:black'>java.util.Map;<br> <br> </span><b><span style='font-size:9.0pt;color:navy'>public class </span></b><span style='font-size:9.0pt;color:black'>MyFirebaseMessagingService </span><b><span style='font-size:9.0pt;color:navy'>extends </span></b><span style='font-size: 9.0pt;color:black'>FirebaseMessagingService<br> {<br> </span><span style='font-size:9.0pt;color:olive'>@Override<br> </span><b><span style='font-size:9.0pt;color:navy'>public void </span></b><span style='font-size:9.0pt;color:black'>onMessageReceived(RemoteMessage remoteMessage)<br> {<br> </span><i><span style='font-size:9.0pt;color:gray'> </span></i><b><span style='font-size:9.0pt;color:navy'>if </span></b><span style='font-size:9.0pt; color:black'>(remoteMessage != </span><b><span style='font-size:9.0pt; color:navy'>null </span></b><span style='font-size:9.0pt;color:black'>&& remoteMessage.getData().size() > </span><span style='font-size:9.0pt;color:blue'>0</span><span style='font-size:9.0pt; color:black'>)<br> {</span></pre><pre style='background:white'><i><span style='font-size: 9.0pt;color:gray'> // ex: {nfrom=1002, ntype=0}</span></i><span style='font-size:9.0pt;color:black'><br> Map<String, String> data = remoteMessage.getData();</span><i><span style='font-size:9.0pt;color:gray'><br> </span></i><b><span style='font-size:9.0pt;color:navy'>if </span></b><span style='font-size:9.0pt;color:black'>(data != </span><b><span style='font-size: 9.0pt;color:navy'>null</span></b><span style='font-size:9.0pt;color:black'>)<br> {<br> Log.v(LOG_TAG, </span><b><span style='font-size:9.0pt; color:green'>" FCM onMessageReceived message: " </span></b><span style='font-size:9.0pt;color:black'>+ data.toString());</span></pre><pre style='background:white'><span style='font-size:9.0pt;color:black'><br> String ntype = data.get(</span><b><span style='font-size:9.0pt; color:green'>"ntype"</span></b><span style='font-size:9.0pt; color:black'>); </span><i><span style='font-size:9.0pt;color:gray'>// ntype: 0=call, 1=message<br> </span></i><span style='font-size:9.0pt;color:black'>String nfrom = data.get(</span><b><span style='font-size:9.0pt;color:green'>"nfrom"</span></b><span style='font-size:9.0pt;color:black'>);<br> String nmsg = data.get(</span><b><span style='font-size:9.0pt; color:green'>"nmsg"</span></b><span style='font-size:9.0pt; color:black'>);<br> <br> </span><b><span style='font-size:9.0pt;color:navy'>if </span></b><span style='font-size:9.0pt;color:black'>(ntype == </span><b><span style='font-size: 9.0pt;color:navy'>null</span></b><span style='font-size:9.0pt;color:black'>) ntype = </span><b><span style='font-size:9.0pt;color:green'>"0"</span></b><span style='font-size:9.0pt;color:black'>;<br> </span><b><span style='font-size:9.0pt;color:navy'>if </span></b><span style='font-size:9.0pt;color:black'>(nfrom == </span><b><span style='font-size: 9.0pt;color:navy'>null</span></b><span style='font-size:9.0pt;color:black'>) nfrom = </span><b><span style='font-size:9.0pt;color:green'>""</span></b><span style='font-size:9.0pt;color:black'>;<br> </span><b><span style='font-size:9.0pt;color:navy'>if </span></b><span style='font-size:9.0pt;color:black'>(nmsg == </span><b><span style='font-size: 9.0pt;color:navy'>null</span></b><span style='font-size:9.0pt;color:black'>) nmsg = </span><b><span style='font-size:9.0pt;color:green'>""</span></b><span style='font-size:9.0pt;color:black'>;</span></pre><pre style='background:white'><span style='font-size:9.0pt;color:black'> </span></pre><pre style='background: white'><span style='font-size:9.0pt;color:black'> ProcessNotification(ntype, nfrom, nmsg);<br> <br> }</span></pre><pre style='background:white'><span style='font-size:9.0pt;color:black'> }</span></pre><pre style='margin-left:.5in;background:white'><span style='font-size:9.0pt; color:black'> }<br> <br> </span><b><span style='font-size:9.0pt;color:navy'>public void </span></b><span style='font-size:9.0pt;color:black'>ProcessNotification(String ntype, String nfrom, String nmsg)<br> {</span></pre><pre style='background:white'><span style='font-size:9.0pt; color:black'> </span><i><span style='font-size:9.0pt;color:gray'>// display notification to user or wake up your application</span></i></pre><pre style='margin-left:.5in;background:white'><span style='font-size:9.0pt; color:black'>}</span></pre><pre style='background:white'><i><span style='font-size:9.0pt;color:gray'><br> </span></i><span style='font-size:9.0pt;color:black'>}</span></pre><pre style='background:white'><span style='font-size:9.0pt;color:black'> </span></pre><pre style='background:white'><u><span style='font-size:9.0pt;font-family:"Calibri",sans-serif; color:black'>Important note:</span></u><span style='font-size:9.0pt;font-family: "Calibri",sans-serif;color:black'> In Android you have the option to “wake” up your app, more exactly to start it and bring it to foreground, you don’t have to necessarily display a notification to the user. This can be achieved by sending an <i>Intent</i> to your application’s main <i>Activity</i>. Example code:</span></pre><pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif; color:black'> </span></pre><pre style='background:white'><span style='font-size:9.0pt;color:black'>Intent intentWake = </span><b><span style='font-size:9.0pt;color:navy'>new </span></b><span style='font-size:9.0pt; color:black'>Intent(</span><b><span style='font-size:9.0pt;color:navy'>this</span></b><span style='font-size:9.0pt;color:black'>, MainActivity.</span><b><span style='font-size:9.0pt;color:navy'>class</span></b><span style='font-size:9.0pt; color:black'>);<br> intentWake.setFlags(Intent.</span><b><i><span style='font-size:9.0pt; color:#660E7A'>FLAG_ACTIVITY_NEW_TASK</span></i></b><span style='font-size: 9.0pt;color:black'>);<br> startActivity(intentWake);</span></pre><pre style='background:white'><span style='font-size:9.0pt;color:black'> </span></pre> <h2><a name="_Toc117069572"></a><a name="_AJVoIP_with_the"></a>AJVoIP -Mizu PUSH service</h2> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>This chapter is only about the Mizutech </span><a href="https://www.mizu-voip.com/Software/SIPSDK/AndroidSIPSDK.aspx"><span style='font-size:9.0pt;line-height:107%'>Android SIP library</span></a><span style='font-size:9.0pt;line-height:107%'> in case if you wish to implement push notifications using the Mizutech push notification service. We provide this service for all our customers (free tier).</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>In case if you wish to use a dedicated push gateway, then follow the </span><a href="start.htm#_AJVoIP"><span style='font-size:9.0pt;line-height:107%'>above chapter</span></a><span style='font-size:9.0pt;line-height:107%'> instead.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>The notifications are handled the same way as </span><a href="start.htm#_Android"><span style='font-size:9.0pt;line-height:107%'>described</span></a><span style='font-size:9.0pt;line-height:107%'> for a generic android client, but since the Mizu android SIP SDK already comes with push notifications support, you have less to do in this case.</span></p> <h4><a name="node53" id="node53"></a>Prerequisites</h4> <p class="MsoListParagraphCxSpFirst" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>A device running Android 4.0 (Ice Cream Sandwich) or newer, and Google Play services 11.8.0 or higher</span></p> <p class="MsoListParagraphCxSpLast" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>The latest version of </span><a href="https://developer.android.com/studio/index.html"><span style='font-size:9.0pt;line-height:107%'>Android Studio</span></a><span style='font-size:9.0pt;line-height:107%'> (You can also use other IDE such as Eclipse, however this guide is guide is for Android Studio)</span></p> <h4><a name="node54" id="node54"></a>Online resources</h4> <p class="MsoListParagraphCxSpFirst" style='text-indent:-.25in'><span class="MsoHyperlink"><span style='font-size:9.0pt;line-height:107%;font-family: Symbol;color:windowtext;text-decoration:none'>·<span style='font:7.0pt "Times New Roman"'> </span></span></span><a href="https://firebase.google.com/docs/cloud-messaging/"><span style='font-size:9.0pt;line-height:107%'>FCM Messaging</span></a><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://firebase.google.com/docs/cloud-messaging/android/client"><span style='font-size:9.0pt;line-height:107%'>Add FCM support to Android project</span></a></p> <p class="MsoListParagraphCxSpLast"><span style='font-size:9.0pt;line-height: 107%'> </span></p> <h4><a name="node55" id="node55"></a>Configure Firebase for your app</h4> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>To integrate the Firebase libraries into one of your own Android project, you need to add Firebase to your Android project. This can be done in the following way:</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Download the google-services.json file from </span><a href="https://www.mizu-voip.com/Portals/0/Files/google-services.json"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size: 9.0pt;line-height:107%'> and copy this into your project's module folder, typically app/. This is the Mizutech FCM service configuration file and must be shipped with your app.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Now you need to add some rules to your root-level build.gradle file, to include the google-services plugin and the Google's Maven repository:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;background:white'><span style='font-size:9.0pt;font-family:"Courier New"; color:black'>buildscript {<br> repositories {<br> jcenter()<br> google()<br> }<br> dependencies {<br> </span><b><span style='font-size:9.0pt;font-family:"Courier New";color:green'> </span></b><span style='font-size:9.0pt;font-family:"Courier New";color:black'>classpath </span><b><span style='font-size:9.0pt;font-family:"Courier New";color:green'>'com.google.gms:google-services:3.0.0'<br> </span></b><span style='font-size:9.0pt;font-family:"Courier New"; color:black'>}<br> }<br> <br> allprojects {<br> repositories {<br> jcenter()<br> google()<br> }<br> }</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Then, in your module Gradle file (usually the app/build.gradle), add firebase messaging to dependencies and the apply plugin line at the bottom of the file to enable the Gradle plugin:</span></p> <pre style='background:white'><span style='font-size:9.0pt;color:black'>//...</span></pre><pre style='background:white'><span style='font-size:9.0pt;color:black'>dependencies {<br> compile </span><b><span style='font-size:9.0pt;color:green'>'com.google.firebase:firebase-messaging:10.0.1'</span></b><span style='font-size:9.0pt;color:black'><br> }<br> apply </span><b><span style='font-size:9.0pt;color:green'>plugin</span></b><span style='font-size:9.0pt;color:black'>: </span><b><span style='font-size:9.0pt; color:green'>'com.google.gms.google-services'</span></b></pre><pre style='background:white'><span style='font-size:9.0pt;color:black'> </span></pre><pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif; color:black'>Also, be sure to set <i>minSdkVersion 9</i> or higher in the app's build.gradle to support FCM.</span></pre> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <h4><a name="node56" id="node56"></a>Manifest configuration</h4> <p class="MsoNormal"> </p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Add the following Services to your Android Manifest:</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>A service that extends FirebaseMessagingService. This provides the functionality to receive notifications.</span></p> <pre><span class="tag"><span style='font-size:9.0pt'><service</span></span><span style='font-size:9.0pt'><br> <span class="pln"> </span><span class="atn">android:name</span><span class="pun">=</span><span class="atv">".MyFirebaseMessagingService"</span><span class="tag">></span><br> <span class="pln"> </span><span class="tag"><intent-filter></span><br> <span class="pln"> </span><span class="tag"><action</span><span class="pln"> </span><span class="atn">android:name</span><span class="pun">=</span><span class="atv">"com.google.firebase.MESSAGING_EVENT"</span><span class="tag">/></span><br> <span class="pln"> </span><span class="tag"></intent-filter></span><br> <span class="tag"></service></span></span></pre> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>A service that extends FirebaseInstanceIdService to handle the creation, rotation, and updating of registration tokens.</span></p> <pre><span class="tag"><span style='font-size:9.0pt'><service</span></span><span style='font-size:9.0pt'><br> <span class="pln"> </span><span class="atn">android:name</span><span class="pun">=</span><span class="atv">".MyFirebaseInstanceIDService"</span><span class="tag">></span><br> <span class="pln"> </span><span class="tag"><intent-filter></span><br> <span class="pln"> </span><span class="tag"><action</span><span class="pln"> </span><span class="atn">android:name</span><span class="pun">=</span><span class="atv">"com.google.firebase.INSTANCE_ID_EVENT"</span><span class="tag">/></span><br> <span class="pln"> </span><span class="tag"></intent-filter></span><br> <span class="tag"></service></span></span></pre><pre><span style='font-size:9.0pt'> </span></pre> <h4><a name="node57" id="node57"></a>Get the device registration token</h4> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>On initial startup of your softphone, the FCM SDK generates a registration token for the client app instance. This token will be used later by the FCM server to send notifications to a specific device. To retrieve the current token, call </span><a href="https://firebase.google.com/docs/reference/android/com/google/firebase/iid/FirebaseInstanceId.html#public-methods"><span style='font-size:9.0pt;line-height:107%'>FirebaseInstanceId.getInstance().getToken()</span></a><span style='font-size:9.0pt;line-height:107%'>. This method returns null if the token has not yet been generated.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>Below is the implementation of </span><span class="atv"><span style='font-size:9.0pt; line-height:107%'>MyFirebaseInstanceIDService used for receiving the token updates:</span></span></p> <pre style='background:white'><b><span style='font-size:9.0pt;color:navy'>import </span></b><span style='font-size:9.0pt;color:black'>com.google.firebase.iid.FirebaseInstanceId;<br> </span><b><span style='font-size:9.0pt;color:navy'>import </span></b><span style='font-size:9.0pt;color:black'>com.google.firebase.iid.FirebaseInstanceIdService;<br> <br> </span><b><span style='font-size:9.0pt;color:navy'>public class </span></b><span style='font-size:9.0pt;color:black'>MyFirebaseInstanceIDService </span><b><span style='font-size:9.0pt;color:navy'>extends </span></b><span style='font-size: 9.0pt;color:black'>FirebaseInstanceIdService<br> {<br> </span><span style='font-size:9.0pt;color:olive'>@Override<br> </span><b><span style='font-size:9.0pt;color:navy'>public void </span></b><span style='font-size:9.0pt;color:black'>onTokenRefresh()<br> {<br> </span><i><span style='font-size:9.0pt;color:gray'>// Get updated token and store it<br> </span></i><span style='font-size:9.0pt;color:black'>String updatedToken = FirebaseInstanceId.<i>getInstance</i>().getToken();<br> }<br> <br> }</span></pre><pre style='background:white'><span style='font-size:9.0pt; color:black'> </span></pre> <h4><a name="node58" id="node58"></a>Enable push notifications</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>This can be achieved by calling the following API:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'>boolean SetPushNotifications(int pushnotifications, String fcmclientid, String packagename, String gateway)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'>Parameters:</span></p> <pre style='margin-left:.5in;background:white'><span style='font-size:9.0pt; font-family:"Calibri",sans-serif;color:black'>pushnotifications: </span><span style='font-size:9.0pt;font-family:"Calibri",sans-serif;color:black'>-1=auto guess, 0=disabled, 1=enabled auto, 2=enabled direct, 3=enabled via gateway<br> clientid: token received from FCM<br> packagename: app package name. Must be set to com.mizuvoip.mizudroid.app<br> gateway: address of the gateway if you wish to use a gateway for push notifications<br> return true on success, false on failure (check the log on failure)</span></pre> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>You should call it just after you called the Init or the Start API.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>For example:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>-<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>to enable push notifications, you would call the API function like this:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>API_SetPushNotifications(3, TOKEN, “com.mizuvoip.mizudroid.app”, “fcm.webvoipphone.com:35060”);</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt'><i><span style='font-size:9.0pt;line-height:107%'> </span></i></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>-<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>to disable push notifications:</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>API_SetPushNotifications(0, “”, “”, “”);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>For more details see the </span><a href="https://www.mizu-voip.com/Portals/0/Files/AndroidSIPSDK.pdf"><span style='font-size:9.0pt;line-height:107%'>Android SIP library documentation</span></a><span style='font-size:9.0pt;line-height:107%'>.</span></p> <h4><a name="node59" id="node59"></a>Receive and handle notifications</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>On </span><a href="start.htm#_VoIP_push_notification"><span style='font-size:9.0pt;line-height:107%'>incoming notification</span></a><span style='font-size:9.0pt;line-height:107%'> your app might do the followings:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>On text message (chat): just display it as a notification (user can tap on it to launch your app and see more details)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>On call: just wake-up the app (once your app is started, it will auto-register and it will receive the incoming INVITE thus it can handle the incoming call as normally)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Others such as call cancel and custom messages</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>We are using the Java language for the below example code. You can follow the same logic with other language such as Kotlin.</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>To receive notifications we need to implement </span><span class="atv"><i><span style='font-size:9.0pt;line-height:107%'>MyFirebaseMessagingService.</span></i></span><span class="atv"><span style='font-size:9.0pt;line-height:107%'> Below is an example of that:</span></span></p> <pre style='background:white'><b><span style='font-size:9.0pt;color:navy'>import </span></b><span style='font-size:9.0pt;color:black'>com.google.firebase.messaging.FirebaseMessagingService;<br> </span><b><span style='font-size:9.0pt;color:navy'>import </span></b><span style='font-size:9.0pt;color:black'>com.google.firebase.messaging.RemoteMessage;<br> </span><b><span style='font-size:9.0pt;color:navy'>import </span></b><span style='font-size:9.0pt;color:black'>java.util.Map;<br> <br> </span><b><span style='font-size:9.0pt;color:navy'>public class </span></b><span style='font-size:9.0pt;color:black'>MyFirebaseMessagingService </span><b><span style='font-size:9.0pt;color:navy'>extends </span></b><span style='font-size: 9.0pt;color:black'>FirebaseMessagingService<br> {<br> </span><span style='font-size:9.0pt;color:olive'>@Override<br> </span><b><span style='font-size:9.0pt;color:navy'>public void </span></b><span style='font-size:9.0pt;color:black'>onMessageReceived(RemoteMessage remoteMessage)<br> {<br> </span><i><span style='font-size:9.0pt;color:gray'> </span></i><b><span style='font-size:9.0pt;color:navy'>if </span></b><span style='font-size:9.0pt; color:black'>(remoteMessage != </span><b><span style='font-size:9.0pt; color:navy'>null </span></b><span style='font-size:9.0pt;color:black'>&& remoteMessage.getData().size() > </span><span style='font-size:9.0pt;color:blue'>0</span><span style='font-size:9.0pt; color:black'>)<br> {</span></pre><pre style='background:white'><i><span style='font-size: 9.0pt;color:gray'> // ex: {nfrom=1002, ntype=0}</span></i><span style='font-size:9.0pt;color:black'><br> Map<String, String> data = remoteMessage.getData();</span><i><span style='font-size:9.0pt;color:gray'><br> </span></i><b><span style='font-size:9.0pt;color:navy'>if </span></b><span style='font-size:9.0pt;color:black'>(data != </span><b><span style='font-size: 9.0pt;color:navy'>null</span></b><span style='font-size:9.0pt;color:black'>)<br> {<br> Log.v(LOG_TAG, </span><b><span style='font-size:9.0pt; color:green'>" FCM onMessageReceived message: " </span></b><span style='font-size:9.0pt;color:black'>+ data.toString());</span></pre><pre style='background:white'><span style='font-size:9.0pt;color:black'><br> String ntype = data.get(</span><b><span style='font-size:9.0pt; color:green'>"ntype"</span></b><span style='font-size:9.0pt; color:black'>); </span><i><span style='font-size:9.0pt;color:gray'>// ntype: 0=call, 1=message<br> </span></i><span style='font-size:9.0pt;color:black'>String nfrom = data.get(</span><b><span style='font-size:9.0pt;color:green'>"nfrom"</span></b><span style='font-size:9.0pt;color:black'>);<br> String nmsg = data.get(</span><b><span style='font-size:9.0pt; color:green'>"nmsg"</span></b><span style='font-size:9.0pt; color:black'>);<br> <br> </span><b><span style='font-size:9.0pt;color:navy'>if </span></b><span style='font-size:9.0pt;color:black'>(ntype == </span><b><span style='font-size: 9.0pt;color:navy'>null</span></b><span style='font-size:9.0pt;color:black'>) ntype = </span><b><span style='font-size:9.0pt;color:green'>"0"</span></b><span style='font-size:9.0pt;color:black'>;<br> </span><b><span style='font-size:9.0pt;color:navy'>if </span></b><span style='font-size:9.0pt;color:black'>(nfrom == </span><b><span style='font-size: 9.0pt;color:navy'>null</span></b><span style='font-size:9.0pt;color:black'>) nfrom = </span><b><span style='font-size:9.0pt;color:green'>""</span></b><span style='font-size:9.0pt;color:black'>;<br> </span><b><span style='font-size:9.0pt;color:navy'>if </span></b><span style='font-size:9.0pt;color:black'>(nmsg == </span><b><span style='font-size: 9.0pt;color:navy'>null</span></b><span style='font-size:9.0pt;color:black'>) nmsg = </span><b><span style='font-size:9.0pt;color:green'>""</span></b><span style='font-size:9.0pt;color:black'>;</span></pre><pre style='background:white'><span style='font-size:9.0pt;color:black'> </span></pre><pre style='background: white'><span style='font-size:9.0pt;color:black'> ProcessNotification(ntype, nfrom, nmsg);<br> <br> }</span></pre><pre style='background:white'><span style='font-size:9.0pt;color:black'> }</span></pre><pre style='margin-left:.5in;background:white'><span style='font-size:9.0pt; color:black'> }<br> <br> </span><b><span style='font-size:9.0pt;color:navy'>public void </span></b><span style='font-size:9.0pt;color:black'>ProcessNotification(String ntype, String nfrom, String nmsg)<br> {</span></pre><pre style='background:white'><span style='font-size:9.0pt; color:black'> </span><i><span style='font-size:9.0pt;color:gray'>// display notification to user or wake up your application</span></i></pre><pre style='margin-left:.5in;background:white'><span style='font-size:9.0pt; color:black'>}</span></pre><pre style='background:white'><i><span style='font-size:9.0pt;color:gray'><br> </span></i><span style='font-size:9.0pt;color:black'>}</span></pre><pre style='background:white'><span style='font-size:9.0pt;color:black'> </span></pre><pre style='background:white'><u><span style='font-size:9.0pt;font-family:"Calibri",sans-serif; color:black'>Important note:</span></u><span style='font-size:9.0pt;font-family: "Calibri",sans-serif;color:black'> In Android you have the option to “wake” up your app, more exactly to start it and bring it to foreground, you don’t have to necessarily display a notification to the user. This can be achieved by sending an <i>Intent</i> to your application’s main <i>Activity</i>. Example code:</span></pre><pre style='background:white'><span style='font-size:9.0pt;font-family:"Calibri",sans-serif; color:black'> </span></pre><pre style='background:white'><span style='font-size:9.0pt;color:black'>Intent intentWake = </span><b><span style='font-size:9.0pt;color:navy'>new </span></b><span style='font-size:9.0pt; color:black'>Intent(</span><b><span style='font-size:9.0pt;color:navy'>this</span></b><span style='font-size:9.0pt;color:black'>, MainActivity.</span><b><span style='font-size:9.0pt;color:navy'>class</span></b><span style='font-size:9.0pt; color:black'>);<br> intentWake.setFlags(Intent.</span><b><i><span style='font-size:9.0pt; color:#660E7A'>FLAG_ACTIVITY_NEW_TASK</span></i></b><span style='font-size: 9.0pt;color:black'>);<br> startActivity(intentWake);</span></pre><pre style='background:white'><span style='font-size:9.0pt;color:black'> </span></pre> <h2><a name="_Toc117069573">Customized MizuDroid</a></h2> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>This chapter is for customers integrating customized MizuDroid with their own SIP - push server. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>Our </span><a href="https://www.mizu-voip.com/Software/Softphones/AndroidSoftphone.aspx"><span style='font-size:9.0pt'>android softphone</span></a><span style='font-size: 9.0pt'> is capable to use our SIP-PUSH proxy by default (in case if your server doesn’t have push notification capabilities). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>However, we can also provide customized softphone using push notifications directly with your server or gateway. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>Your custom app package name will be com.companyname.brandname in lower case with no spaces and special characters (only characters a-z, A-Z, 0-9, _, -).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>For example if your company name is "My Company" and your app name is "MyPhone", then your package name will be "com.mycompany.myphone".</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>Create a Firebase project for this and send us the google-services.json. Then we can send you a customized softphone with your settings preconfigured. More details </span><a href="https://www.mizu-voip.com/Support/Wiki/tabid/99/Default.aspx?topic=How+to+setup+Firebase+push+notifications"><span style='font-size:9.0pt'>here</span></a><span style='font-size:9.0pt'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <h2><a name="_Toc117069574">Others</a></h2> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>In the above chapters we have described how to implement VoIP push notifications for iOS native (both FCM and PushKit from XCode), Android native (FCM implemented with Java from Android Studio) and Web (browser HTML5 clients). These are the most important platform when push notifications are used, however this doesn’t means that you are limited to these platforms. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>You can use push notifications also on other platforms such as Windows, MAC or Linux (although on desktop you can just use a service or daemon), using any IDE (Visual Studio, QT, Eclipse, Xamarin, VS Code and many more) and any language (JavaScript, C#, C++, Java, Kotlin, Swift, ObjectC or any other).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>If your IDE or language is not covered in this guide, then just pickup the guide for the closest platform, have a look at the online tutorials and adapt it to your environment as there is nothing platform specific with the implementation. For the interaction with the Mizu gateway or server all you need to do is to add the two extra line for your SIP REGISTER requests (X-MPUSH and X-PIID) and follow the best practices for your platform to add push notification support with Google FCM or Apple PushKit APNS. Alternatively you can use the Push Notification for SIP standard as described in RFC 8599. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <h1><a name="_Toc117069575"></a><a name="_SIP_signaling_1"></a><b>SIP Signaling</b></h1> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>To be able to receive push notifications on incoming calls or chat messages (to wake up your app), your apps needs to request a token first from APNs/FCM and then needs to send this token somehow to the mizu push gateway or server. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>The <u>token</u> means the registration token obtained from Google FCM or device token obtained from Apple APNs. You just need to use the API provided by the OS to get the token.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>There are two ways to send the token to the gateway/server and request push notifications:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_X-PUSH"><span style='font-size:9.0pt;line-height:107%'>Mizutech proprietary</span></a><span style='font-size:9.0pt;line-height:107%'> format using the X-PUSH header</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_RFC_8599"><span style='font-size:9.0pt;line-height: 107%'>Standards based</span></a><span style='font-size:9.0pt;line-height:107%'> format using the Media Feature Tags in the Contact header and Feature-Caps as described in </span><a href="https://tools.ietf.org/html/rfc8599"><span style='font-size:9.0pt;line-height:107%'>RFC 8599</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>You can use any of these in your apps (and there is no much reason to implement both).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>In case if you are using the Mizu server, then you can send these required SIP headers directly to the server with the REGISTER requests. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>If you are using our MPUSH gateway or SBC then you need to set it as the outbound proxy in your app, thus all messages will flow via the gateway. <br> If you don’t have a SIP proxy setting option then set it as your app SIP domain.<br> In this case the signaling will flow like this: SIP Client -> [REGISTER] -> Mizu SBC/Gateway -> [REGISTER] -> Your SIP server.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>On incoming call/chat, your app will receive a push message (capable to wake-up the app if required). Once the push message is received by your app, it should immediately register (or re-register refresh binding) and it will receive the incoming request (INVITE, MESSAGE or other session), which can be handled as usually.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Please note that WebRTC clients are also supported if you have the WebRTC module installed. In this case the SIP signaling is transmitted using websocket transport as described in </span><a href="https://tools.ietf.org/html/rfc7118"><span style='font-size:9.0pt; line-height:107%'>RFC 7118</span></a><span style='font-size:9.0pt;line-height: 107%'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <h2><a name="_Toc117069576"></a><a name="_X-PUSH"></a><a name="_X-MPUSH"></a>X-MPUSH </h2> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <h4><a name="node60" id="node60"></a>In short (summary)</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Send the X-MPUSH header with every REGISTER request: <span style='color:#833C0B'>X-MPUSH: PROVIDER:PACKAGENAME:TOKEN</span><span style='color:black'>.</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Optionally send the <span style='color:#833C0B'>X-PIID </span>and/or the </span><span style='font-size: 9.0pt;line-height:107%;color:#833C0B'>X-Sy.Uppersrv</span><span style='font-size:9.0pt;line-height:107%'> headers.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <h4><a name="node61" id="node61"></a>Description</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>The reason why such proprietary protocol exists is that the RFC 8599 have been published only in 2019, before we implemented push for VoIP. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%'>In case if you wish to avoid proprietary protocols, then just skip this chapter and look at the </span></i><a href="start.htm#_RFC_8599"><i><span style='font-size:9.0pt;line-height:107%'>RFC 8599</span></i></a><i><span style='font-size:9.0pt;line-height:107%'> chapter for the standards based implementation.</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Otherwise, you just need to send a few lines in the SIP signaling to the Mizu server/gateway to handle the push notifications. <br> It is enough if you send these with the REGISTER requests.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <h4><a name="node62" id="node62"></a>Token</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>You must send the user token to the server in a X-MPUSH header so it can bind the SIP user with the token.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>X-MPUSH:PROVIDER:PACKAGENAME:TOKEN</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Where:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>X-MPUSH: is the SIP header</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>PROVIDER: can have the following values</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:"Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>a: android FCM</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:"Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>i: apple APNS</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:"Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>j: means iOS FCM (rarely used)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:"Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>w: webpush</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>PACKAGENAME: is the FCM Project ID or your Apple app Bundle ID</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>TOKEN: registration token obtained from Google FCM or device token obtained from Apple APNs</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Example: <span style='color:#833C0B'>X-MPUSH: a:com.voip.phone:9C2F93A6D1319D3CB5712B469226A719B78C3BE37CCB6E8FD27985F0A0285DF9</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:8.0pt;line-height:107%'>It is also possible to specify from the client side whether you wish to use the sandbox/test or the production gateway by prefixing the X-MPUSH header with a special character:</span></i></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:8.0pt;line-height:107%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><i><span style='font-size:8.0pt;line-height:107%;color:#833C0B'>s</span></i><i><span style='font-size:8.0pt;line-height:107%'> means sandbox/test (for example gateway.sandbox.push.apple.com:2195 for the legacy binary APNS or api.</span></i><i><span style='font-size:10.0pt;line-height:107%'> </span></i><i><span style='font-size:8.0pt;line-height:107%'>development.push.apple.com for the new HTTP/2 APNS)</span></i></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:8.0pt;line-height:107%; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><i><span style='font-size:8.0pt;line-height:107%;color:#833C0B'>p</span></i><i><span style='font-size:8.0pt;line-height:107%'> means production (for example gateway.push.apple.com:2195 for the legacy binary APNS or api.push.apple.com for the new HTTP/2 APNS)</span></i></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:8.0pt;line-height:107%; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><i><span style='font-size:8.0pt;line-height:107%;color:#833C0B'>d</span></i><i><span style='font-size:8.0pt;line-height:107%'> means default as configured in the server/gateway global config (this can be omitted)</span></i></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:8.0pt;line-height:107%'> </span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:8.0pt;line-height:107%'>For example to send via apple APNS sandbox gateway: <span style='color:#833C0B'>X-MPUSH: s:i:APP_PACKAGE_NAME:REGISTRATION_TOKEN</span></span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <h4><a name="_Credentials"></a>Credentials</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>This might be used only if you are using the MPUSH gateway or SBC (not needed if you are using the Mizu softswitch).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>If your server doesn't keep registrations and you wish to maintain the registered state then you also need to send the authorization details with the SIP signaling in the following format:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>X-PIID: MD5(username + : + realm + : + password)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'>Where:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family: Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:black'>X-PIID: is the SIP header</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%; font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:black'>MD5 means MD5 hash hex string</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%; font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:black'>+ means string concatenation</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%; font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:black'>: means colon character</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%; font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:black'>username is the SIP username</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%; font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:black'>realm is the SIP realm (see comments below)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family: Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:black'>password is the SIP password</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'>For example if the username is “aaa”, your server realm is “cool” and the password is “xxx” then you should calculate like MD5("aaa:cool:xxx").</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'>Please note that the realm is your own SIP server realm (not the gateway realm). This is usually your server domain or IP or software name or as received in the Authorization request from your SIP server. Some servers are using a specific string. For example Asterisk often uses “asterisk” for the realm. You should verify this in any SIP log, trace or wireshark / pcap trace (check what realm value your server is sending with the Authenticate header). For example, a common auth challenge from a SIP server looks like this: </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:8.0pt; line-height:107%;color:#833C0B'>SIP/2.0 401 Unauthorized</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:8.0pt; line-height:107%;color:#833C0B'>Via: SIP/2.0/UDP 1.2.3.4:5060;branch=z9hG4bK-xxx</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:8.0pt; line-height:107%;color:#833C0B'>Call-ID: xxx</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:8.0pt; line-height:107%;color:#833C0B'>From: <sip:a@srv.com>;tag=aaa</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:8.0pt; line-height:107%;color:#833C0B'>To: <sip:b@srv.com>;tag=bbb</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:8.0pt; line-height:107%;color:#833C0B'>CSeq: 1 REGISTER</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:8.0pt; line-height:107%;color:#833C0B'>WWW-Authenticate: Digest realm="<b>asterisk</b>",nonce="xxx",algorithm=md5</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:8.0pt; line-height:107%;color:#833C0B'>Server: Asterisk</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:8.0pt; line-height:107%;color:#833C0B'>Content-Length: 0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>The realm value is "asterisk" in this case.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>In case if you don’t wish to supply the credentials, then you should use a large register expire interval (the maximum allowed by your server, such as 86400 for one day) and/or </span><span style='font-size:9.0pt;line-height:107%;color:black'>set the </span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>pushnotification_regrefresh </span><span style='font-size:9.0pt;line-height:107%;color:black'>config to 1 to keep waking up your app with push notifications once its register timeout expires. </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <h4><a name="_SIP_domain"></a>SIP domain</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>If you are using the MPUSH gateway then you might also send the target domain (the address of your SIP server) with the X-Sy.Uppersrv header, like this: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>X-Sy.Uppersrv: sip.mydomain.com<br> <br> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>This is required only if you have multiple SIP servers and you don’t wish to force a specific server to be used with the gateway configuration (global config or routing). In case if you have a SIP proxy to be used, it can be specified in the <span style='color:#833C0B'>X-Sy.Upperproxy</span> header. In case if your SIP server logical domain name or real differs from the SIP address, then you can send it with a <span style='color:#833C0B'>X-Sy.Uppersrvd</span> header (so in this case you will use the X-Sy.Uppersrv header to specify the server IP address and the X-Sy.Uppersrvd header to specify the domain)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>The latest version can extract the upper server also from the target URI. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>In this case you will have to configure your SIP clients in the following way:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Set the MPUSH gateway address as the proxy</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Set the upper/final SIP server address as the domain</span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>More details </span><a href="start.htm#_Can_I_use"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size:9.0pt;line-height:107%'>.</span></p> <h4><a name="node63" id="node63"></a>Example</h4> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>A typical registration request looks like this:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>REGISTER sip:gw.mydomain.com SIP/2.0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>Via: SIP/2.0/UDP 192.168.1.101:14501;alias;branch=z9hG4bK.edThn;rport</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>From: <sip:1111@gw.mydomain.com>;tag=tUgBfpF8h</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>To: sip:1111@gw.mydomain.com</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>CSeq: 2 REGISTER</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>Call-ID: enutmuwaynqib</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>Max-Forwards: 70</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>Contact: <sip:1111@192.168.1.101:14501></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>Authorization: Digest realm="sip.mydomain.com", nonce="WvDOe1rwzc2EDrmrsjELzwQLYnJ7tD3H", username="1111", uri="sip:gw.mydomain.com", response="1336341b517678240fb092e0cf1159a7"</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>Expires: 3600</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-size:8.0pt;color:#833C0B'>X-MPUSH: a:com.mycompany.myapp:c-10-ap_Kt0:G7SThkASJx2K4Rm1033iR0mIgzI1cLg5xxpST4cjrd_cqQquRLkHMi3eY4g</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-size:8.0pt;color:#833C0B'>X-PIID: 14d4f932e3897a39d6a17c13b526db</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><b><span style='font-size:8.0pt;line-height:107%;color:#833C0B'>X-Sy.Uppersrv: sip.mydomain.com</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>User-Agent: MyCoolApp</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>Content-Length: 0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'> </p> <p class="MsoNormal"><i><span style='font-size:9.0pt;line-height:107%'>Note: If your SIP server is sensitive for the URI used for the digest authentication, then you might use your SIP server URI or the URI returned by the <span style='color:#833C0B'>X-Sy.AuthURI</span> header instead of the gateway URI.</span></i></p> <h2><a name="_Toc117069577"></a><a name="_RFC_8599"></a>RFC 8599 </h2> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <h4><a name="node64" id="node64"></a>In short (summary)</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Implement </span><a href="https://tools.ietf.org/html/rfc8599"><span style='font-size:9.0pt; line-height:107%'>RFC 8599</span></a><span style='font-size:9.0pt;line-height: 107%'>: send the pn-* tags in the Contact URI.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Optionally send the <span style='color:#833C0B'>X-PIID </span>and/or the </span><span style='font-size: 9.0pt;line-height:107%;color:#833C0B'>X-Sy.Uppersrv</span><span style='font-size:9.0pt;line-height:107%'> headers.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <h4><a name="node65" id="node65"></a>Description</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>For this method you just need to implement the Push Notification with the Session Initiation Protocol standard as described in </span><a href="https://tools.ietf.org/html/rfc8599"><span style='font-size:9.0pt;line-height:107%'>RFC 8599</span></a><span style='font-size:9.0pt;line-height:107%'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>In short, your app just have to send the pn-provider, pn-param, pn-prid in the Contact header (Media Feature Tags).</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>pn-provider: pns type which must be “apns” for Apple, “fcm” for Google and “webpush” for generic push</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>pn-param: </span><span style='font-size:9.0pt;line-height:107%'>is the FCM Project ID or your Apple app Bundle ID</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>pn-prid: </span><span style='font-size:9.0pt;line-height:107%'>registration token obtained from Google FCM or device token obtained from Apple APNs</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>The mizu push service has support also for other details described in RFC 8599 including Feature-Caps (</span><a href="https://tools.ietf.org/html/rfc6809"><span style='font-size:9.0pt; line-height:107%'>RFC 6809</span></a><span style='font-size:9.0pt;line-height: 107%'>) and Query Network PNS Capabilities.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%'>Note: the service also recognized the old deprecated push-token-type / push-token-app / push-token-id format.</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <h4><a name="node66" id="node66"></a>Example</h4> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>A typical registration request looks like this:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:107%;color:#833C0B'>REGISTER sip:gw.mydomain.com SIP/2.0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:107%;color:#833C0B'>Via: SIP/2.0/UDP 192.168.1.101:14501;alias;branch=z9hG4bK.edThn;rport</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:107%;color:#833C0B'>From: <sip:1111@gw.mydomain.com>;tag=tUgBfpF8h</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:107%;color:#833C0B'>To: sip:1111@gw.mydomain.com</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:107%;color:#833C0B'>CSeq: 2 REGISTER</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:107%;color:#833C0B'>Call-ID: enutmuwaynqib</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:107%;color:#833C0B'>Max-Forwards: 70</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:107%;color:#833C0B'>Contact: </span><a href="sip:1111@192.168.1.101:14501;pn-provider=fcm;pn-param=com.mycompany.myapp;pn-prid=ZTY4ZDJlMzODE1NmUgKi0K"><span style='font-size:8.0pt;line-height:107%;color:#833C0B;text-decoration:none'>sip:1111@192.168.1.101:14501;<b>pn-provider=fcm;pn-param=com.mycompany.myapp;pn-prid=ZTY4ZDJlMzODE1NmUgKi0K</b></span></a><span style='font-size:8.0pt;line-height:107%;color:#833C0B'>></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#833C0B'>X-PIID: 14d4f932e3897a39d6a17c13b526db</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:107%;color:#833C0B'>X-Sy.Uppersrv: sip.mydomain.com</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:107%;color:#833C0B'>Authorization: Digest realm="sip.mydomain.com", nonce="WvDOe1rwzc2EDrmrsjELzwQLYnJ7tD3H", username="1111", uri="sip:gw.mydomain.com", response="1336341b517678240fb092e0cf1159a7"</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:107%;color:#833C0B'>Expires: 3600</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:107%;color:#833C0B'>User-Agent: MyCoolApp</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:107%;color:#833C0B'>Content-Length: 0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Note: the </span><a href="start.htm#_Credentials"><span style='font-size:9.0pt;line-height:107%'>X-PIID</span></a><span style='font-size:9.0pt;line-height:107%'> and X</span><a href="start.htm#_SIP_domain"><span style='font-size:9.0pt;line-height:107%'>-Sy.Uppersrv</span></a><span style='font-size:9.0pt;line-height:107%'> headers are non-standard and optional (more details below).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'> </p> <h4><a name="_Improvements"></a>Improvements</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>The Mizu gateways and servers implements a few features over the RFC 8599 standard to make the VoIP push notifications more effective.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><b><span style='font-size:9.0pt;line-height:107%'>Multiple upper server support</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>In case if your are using MPUSH gateway or SBC then it is possible to select the upper server from the client app by using the X-Sy.Uppersrv header as described </span><a href="start.htm#_SIP_domain"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size: 9.0pt;line-height:107%'>. Example: <span style='color:#833C0B'>X-Sy.Uppersrv: sip.mydomain.com</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'>Modification required in your app to support this feature: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'>Just send the desired target SIP server with the X-Sy.Uppersrv header (maybe also X-Sy.Uppersrvd and -Sy.Upperproxy if needed)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><b><span style='font-size:9.0pt;line-height:107%'>Keep push binding</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>After the 8599 RFC, push will stop to work if your app fails to refresh its registration binding before it expires. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>However, refreshing the register binding (avoid expire) requires push messages to be sent and app wake-up periodically to re-register which consumes battery and it is not so robust.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>To avoid continuous wake-up the mizu server can keep the push binding without the need for the app to send re-registers.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>If you are using the MPUSH gateway or SBC then you should send the credentials with the <span style='color:#833C0B'>X-PIID</span> header as described </span><a href="start.htm#_Credentials"><span style='font-size:9.0pt; line-height:107%'>here</span></a><span style='font-size:9.0pt;line-height:107%'>. </span><i><span style='font-size:8.0pt;line-height:107%'>(This is similar to sip.vapid described in </span></i><a href="https://tools.ietf.org/html/rfc8292"><i><span style='font-size:8.0pt;line-height:107%'>RFC 8292</span></i></a><i><span style='font-size:8.0pt;line-height:107%'> but easier to implement)</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>In this way the push binding is not removed, even if your app send an unregister or the register expires. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'>However the server will automatically removes the registration binding if it detects that the token is invalid (after one or more push or call failures, </span><a href="start.htm#_Advanced_configuration_options"><span style='font-size:9.0pt; line-height:107%'>configurable</span></a><span style='font-size:9.0pt; line-height:107%;color:black'>). For example if app sent an invalid token or app was uninstalled.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:black'>In case if you don’t want to send the X-PIID header from your app for some reason then you should set the pushnotification_regrefresh config to 1 to keep waking up your app once its register timeout expires. </span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>To force unregister and remove push notifications, your app should set the pn-prid to “<span style='color:#833C0B'>null</span>”. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>This can be sent in a register request to remove only push or in an un-register message to remove also the registration binding.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:8.0pt;line-height:107%'>It is also possible to remove the push binding if your app doesn’t send pn-* tags (for this set the <span style='color:#833C0B'>pushnotification_removeat_nopn </span>global config option to <span style='color:#833C0B'>1</span>) or if your app sends pn-provider but not pn-prid (for this set the <span style='color:#833C0B'>pushnotification_removeat_noprid </span>global config option to<span style='color:#833C0B'> 1</span>, otherwise it will just result in a push capabilities query).</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>More details about push unbind and unregister can be found </span><a href="start.htm#_How_to_unregister"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size: 9.0pt;line-height:107%'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>In case if you wish to disable this behavior for some reason, then set the following global configs for your server/gateway:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><i><span style='font-size:8.0pt; line-height:107%;color:#833C0B'>pushnotification_disableunreg: 0 </span></i><i><span style='font-size:8.0pt;line-height:107%;color:black'>(to enable forwarding unregister requests)</span></i></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><i><span style='font-size:8.0pt; line-height:107%;color:#833C0B'>pushnotification_upperexpire: -1 </span></i><i><span style='font-size:8.0pt;line-height:107%;color:black'>(will forward the same register expire intervals as received from your apps)</span></i></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><i><span style='font-size:8.0pt; line-height:107%;color:#833C0B'> </span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:7.0pt;line-height:107%;color:black'>You might also adjust the followings if you need so (but these will also turn off the ability the keep your app registered when closed/sleeping):</span></i></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><i><span style='font-size:7.0pt; line-height:107%;color:#833C0B'>pushnotification_persists: 0 </span></i><i><span style='font-size:7.0pt;line-height:107%;color:black'>(only if you wish to disable new register sessions created by the gateway itself) </span></i></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><i><span style='font-size:7.0pt; line-height:107%;color:#833C0B'>pushnotification_keepupperreg: 0 </span></i><i><span style='font-size:7.0pt;line-height:107%;color:black'>(send register to your server only when received from your apps)</span></i></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><i><span style='font-size:7.0pt; line-height:107%;color:#833C0B'>pushnotification_regrefresh: 2 </span></i><i><span style='font-size:7.0pt;line-height:107%;color:black'>(remove also push binding on unregister)</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:10.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><b><span style='font-size:9.0pt;line-height:107%'>Response code 555</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>RFC 8599 describes that for push capability requests the server/proxy might send 555 answers meaning Push Notification Service Not Supported. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>This is against the normal registration procedure where the client expects 200 OK for the REGISTER requests and sending 555 might confuse some apps and would require an additional REGISTER for the normal registration without push query. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>For this reason, the mizu push service will not send 555 answer code by default if the requested provider is not supported but it will just not list the provider in the </span><span style='font-size:8.0pt;line-height:107%'>Feature-Caps header. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:8.0pt;line-height:107%'>In case if you wish to disable this for some reason and prefer the standard behavior instead, just set the <span style='color:#833C0B'>pushnotification_send555 </span>global config option to 1.</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <h4><a name="node67" id="node67"></a>Reference</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>Related RFC’s, SIP headers and tags:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>RFC 8599 Push Notification for SIP: </span><a href="https://tools.ietf.org/html/rfc8599"><span style='font-size: 9.0pt'>https://tools.ietf.org/html/rfc8599</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>RFC 6809: Feature-Caps: feature-capability indicators: </span><a href="https://tools.ietf.org/html/rfc6809"><span style='font-size:9.0pt'>https://tools.ietf.org/html/rfc6809</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>RFC 8292: vapid encrypted identification </span><a href="https://tools.ietf.org/html/rfc8292"><span style='font-size:9.0pt'>https://tools.ietf.org/html/rfc8292</span></a><span style='font-size:9.0pt'> </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>RFC 8030: generic push: </span><a href="https://tools.ietf.org/html/rfc8030"><span style='font-size:9.0pt'>https://tools.ietf.org/html/rfc8030</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Contact tags (Media Feature Tags):</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:"Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>pn-provider: pns type: apple: apns, google: fcm, generic: webpush</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:"Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>pn-param: required for apple and google. not for generic webpush</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:"Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>pn-prid: user token coming from the sip client app</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:"Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>pn-purr: request midcall notifications (only if server sent sip.pnspurr)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:"Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>sip.pnsreg: client capable to re-register without the need for push (sent by the client. means that there is no need for push notifications (server should respond with Feature-Cap: sip.pnsreg=x in the answer))</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Feature-Caps tags (feature-capability indicators):</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:"Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>sip.pns: means push supported. Example: sip.pns=same as received in pn-provider </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:"Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>sip.pnspurr: means midcall push support (not requested by mizu gateways/servers)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:"Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>sip.pnsreg: server expects re-reregister without push required (but should send push if not received)</span></p> <h1><a name="_Toc117069578"></a><a name="_FAQ"></a><b>FAQ</b></h1> <h4><a name="node68" id="node68"></a>Abbreviations</h4> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:107%'>The following abbreviations are often used in this document:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span lang="HU" style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Server or gateway: this refers to the Miuztech push notification server side component and often used interchangeable</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span lang="HU" style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>PN: Push Notification</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span lang="HU" style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span lang="HU" style='font-size:9.0pt;line-height:107%'>PNS: Push Notification Service</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>FCM: Google Firebase push notification service (cloud messaging)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>PushKit: Apple push notification implementation</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>APNS: Apple push notification service (cloud messaging)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Register: SIP client connect/register as described by the SIP protocol using the REGISTER method sent via SIP signaling</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>SIP header: the key part of a “line” in the SIP signaling message, although commonly refers to the whole line (key: value)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span class="MsoHyperlink"><span style='font-size:9.0pt;line-height:107%;font-family: Symbol;color:windowtext;text-decoration:none'>·<span style='font:7.0pt "Times New Roman"'> </span></span></span><span style='font-size:9.0pt;line-height:107%'>MPUSH: the short name of the </span><a href="https://www.mizu-voip.com/Software/VoIPPushGateway.aspx"><span style='font-size:9.0pt;line-height:107%'>Mizutech VoIP Push Notification Gateway</span></a></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>PRID: unique Push Resource ID (user token)</span></p> <h4><a name="node69" id="node69"></a>How to test</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>Once you implemented SIP push notification support in your app as described in this document, you can test it by launching your app with push notifications enabled and make a call to it from another SIP endpoint (such as a SIP softphone).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>You should see the incoming push notification and the incoming SIP INVITE (this is the call setup message and it is resent until your app responds or timeouts).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>Check the logs if doesn’t work as expected or contact Mizutech </span><a href="mailto:support@mizu-voip.com"><span style='font-size:9.0pt'>support</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <h4><a name="node70" id="node70"></a>Troubleshooting</h4> <p class="MsoNormal"> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>The server will log the push module state and important issues which you can check at the “Logs” form in the MManage admin client.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>You can also request push notification statistics with the “pushstat” command (send this from the “Server Console” form)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>If the problem is a general issue, not related to push notifications (such as can’t register or call) check the </span><a href="https://www.mizu-voip.com/Portals/0/Files/SIP_SBC_Doc.pdf"><span style='font-size:9.0pt'>SBC documentation</span></a><span style='font-size: 9.0pt'> “Troubleshooting” chapter and resolve the problem first before to go forward using push notifications.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>If push notifications are not sent or your apps doesn’t receive them, verify the followings:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Make sure that your app actually </span><a href="start.htm#_SIP_client_integration"><span style='font-size:9.0pt'>obtains a device token</span></a><span style='font-size:9.0pt'> and it sends it to the server or gateway with the </span><a href="start.htm#_SIP_signaling_1"><span style='font-size: 9.0pt'>SIP signaling</span></a><span style='font-size:9.0pt'>.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Make sure that your app was successfully registered before (receive 200 OK answer from the server for the previous REGISTER request.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Check the server logs (File menu -> Folders -> Server Logs Directory). Find the SIP Call-ID of your incoming call to see what is happening. There should be push related logs at routing (between a-leg and b-leg INVITE). Search also for “ERROR” and “WARNING”.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt'>4.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>If you are using Apple APNS, check the pushkit.log file</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt'>5.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>If the server sent the push notification message successfully but your app haven’t received it, then the problem might be with the push provider (Google FCM or Apple APNS), although these are rare</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt'>6.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>If the push message was delivered to your app, then the problem will be with your app push notification handling code (doesn’t wake-up or displays notification). Fix your code to resolve the problem.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <h4><a name="node71" id="node71"></a>Problems with push notifications</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>Several problems might arise when using push notifications, most of them handled gratefully by MPUSH. </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Issues with push notification subscriptions due to bug in client side code or API availability. You should follow the examples presented in this documentation and follow best practices to avoid them.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Issues to trigger the notification or for the notification to reach the device, although cloud providers claims that their service are robust</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Issues with call routing to the correct device. This should be correctly handled by MPUSH as it fully supports also call forking and delayed resend</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Issues with app wake-up. Make sure that your wake-up code is correct or you might need to display only notification for message which doesn't require the app to run (such as chat messages)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Server side issues might happen on high load conditions when the server is overloaded with new calls such as during emergency period when everyone is attempting to make calls. Overprovisioning can solve this problem.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>Overall, however, push notifications are generally reliable, and a valuable feature for VoIP applications.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <h4><a name="node72" id="node72"></a>App doesn’t receive the push notification</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>Check the followings if no push notification have been received by your app:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Make sure that your app succeeded with the subscription for the push notification cloud service and received a valid token.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Make sure that you are sending the token correctly to the server with the M-PUSH SIP header or RFC 8599.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Make sure that the incoming call reached to the sever or gateway (check the current calls form, CDR form or the server logs)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Make sure that the server sent out the push notification correctly (check the server log and check the </span><a href="start.htm#_Configure_VoIP_push"><span style='font-size:9.0pt'>server config</span></a><span style='font-size:9.0pt'>)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>For common push notification delivery issues check </span><a href="https://developer.apple.com/library/content/technotes/tn2265/_index.html"><span style='font-size:9.0pt'>these notes</span></a><span style='font-size:9.0pt'> specific for PushKit.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <h4><a name="node73" id="node73"></a>App doesn’t receive the incoming call</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>To be able to receive the incoming calls, your app must be already registered to the server or initiate a new register when it wakes up during the call setup session due to the received push notification.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>If the SIP INVITE message doesn’t reach the app:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Make sure that the INVITE have been received by the gateway (check the current calls form, CDR form or the server logs)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Make sure that your app is registered to the server (normally or upon wake-up by push notification). Check the user status on the server (“Users and devices” form)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Check the server logs to see why the calls was not routed or misrouted</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <h4><a name="node74" id="node74"></a>App doesn’t receive text messages</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>In case if your app doesn’t receive incoming chat:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Make sure that your SIP server has support for SIP MESSAGE (</span><a href="https://www.ietf.org/rfc/rfc3428.txt"><span style='font-size:9.0pt'>RFC 3428</span></a><span style='font-size:9.0pt'>) </span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Follow the same steps as described in the above FAQ point with incoming calls (look for SIP MESSAGE instead of INVITE)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <h4><a name="node75" id="node75"></a>App receive push notification and calls even after unregister</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>You need to explicitly unbind the push registration with X-MPUSH or </span><span style='font-size: 9.0pt'>pn-prid set to null or disable the persistent register feature. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'>Otherwise the server will automatically removes the registration binding if it detects that the token is invalid (after one or more push or call failures, </span><a href="start.htm#_Advanced_configuration_options"><span style='font-size:9.0pt; line-height:107%'>configurable</span></a><span style='font-size:9.0pt; line-height:107%;color:black'>). For example if app sent an invalid token or app was uninstalled.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>For the details see the </span><a href="start.htm#_How_to_unregister"><span style='font-size:9.0pt'>below FAQ point</span></a><span style='font-size:9.0pt'> and </span><a href="start.htm#_Improvements"><span style='font-size:9.0pt'>here</span></a><span style='font-size:9.0pt'>.</span></p> <h4><a name="_How_to_unregister"></a>How to unregister from push notifications</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>Just set the X-MPUSH header or </span><span style='font-size:9.0pt'>pn-prid Contact tag to “<span style='color:#833C0B'>null</span>”</span><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>Example: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt;color:#833C0B'>X-MPUSH: null</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>It might be possible to receive a few more notifications after unregister. In this case just ignore them (don’t display any notification and don’t wake-up your app)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><i><span style='font-size:9.0pt'>Note: </span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><i><span style='font-size:9.0pt'>Unregistering with the Expires: 0 or contact expire=0 flags are skipped by default to avoid unwanted unregister behaviors from SIP endpoints as it is usually meaningless to enable both push notifications and unregistering at the same time. For real unregister (and unbind from push notifications) the endpoint must also send the X-MPUSH: null header</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><i><span style='font-size:9.0pt'> </span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><i><span style='font-size:9.0pt;line-height:107%;color:black'>In case if you wish to disable this behavior for some reason, then set the pushnotification_disableunreg, pushnotification_persists and pushnotification_keepupperreg global configs for your server/gateway to 0. In this case you might also set the pushnotification_regrefresh to 2.</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>If you are using RFC 8599, see the “Keep push binding” section </span><a href="start.htm#_Improvements"><span style='font-size:9.0pt'>here</span></a><span style='font-size:9.0pt'> for more details.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><i><span style='font-size:9.0pt'>Note: You can also use “upperunreg” </span></i><a href="https://www.mizu-voip.com/Portals/0/Files/VoIP_Server_API.pdf"><i><span style='font-size:9.0pt'>API</span></i></a><i><span style='font-size:9.0pt'> to remove push binding and force upper unregistration for a user.</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <h4><a name="node76" id="node76"></a>Difference from the RFC 8599 standard</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:10.0pt;line-height:107%;color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'>The Mizu Push service implements a few improvements above the RFC 8599 standard.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'>The only important difference which might require the app developer attention is the persistent register/push binding behavior, which means that with the default configuration the gateway will keep your app registered to the SIP server (and capable to receive incoming calls) even if your app unregisters (REGISTER with expires set to 0) or if the register timer expires.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'>In case if you wish to explicitly unregister and unbind from push, you should send a (un)register with the pn-prid parameter set to “null”. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'>It is also possible to disable this behavior and handle un-registrations in standard compliant way.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'>More details can be found </span><a href="start.htm#_How_to_unregister"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size:9.0pt;line-height:107%;color:black'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'>Unsupported features:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'>RFC 8292 sip.vapid is not supported (however if you wish, you can pass the credentials as described </span><a href="start.htm#_Credentials"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size:9.0pt;line-height:107%;color:black'>)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'>Push notifications for Mid-Dialog requests (pn-purr / sip.pnspurr) are not supported (our software acts as a gateway, in the signaling path, thus this is irrelevant)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'>Extra features:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%;color:black'>The push gateway/server implements a few extra features above the RFC 8599 standard as described </span><a href="start.htm#_Improvements"><span style='font-size:9.0pt;line-height:107%'>here</span></a><span style='font-size:9.0pt;line-height:107%;color:black'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <h4><a name="node77" id="node77"></a>High Availability</h4> <p class="MsoNormal"> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'>HA, failover and redundancy is supported by the MPUSH gateway for both downstream and upstream.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'>You can use a second backup gateway, multiple gateways for the same SIP server, handle multiple SIP servers by the same gateway or for the highest availability: use multiple gateways with multiple (same or different) SIP servers.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'> </span></p> <p class="MsoNormal"><b><u><span style='font-size:9.0pt;line-height:107%'>Client side failover:</span></u></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'>There are multiple possibilities to implement HA toward the SIP clients:</span></p> <p class="MsoListParagraph" style='margin-top:0in;margin-right:0in;margin-bottom: 0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in;line-height: 120%'><span style='font-size:9.0pt;line-height:120%;font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-size:9.0pt;line-height:120%'>SIP Load Balancer</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'>Deploy a SIP load balancer in front of the gateways to distribute the load among your gateways using any algorithm after your preference.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'>For this, you can use any hardware or software based SIP load balancer, including our </span><a href="https://www.mizu-voip.com/Software/SIPLoadBalancer.aspx"><span style='font-size:9.0pt;line-height:120%'>MLB SIP Load Balancer</span></a><span style='font-size:9.0pt;line-height:120%'>.</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:120%'><span style='font-size:9.0pt;line-height:120%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-size:9.0pt;line-height:120%'>API</span></b></p> <p class="MsoListParagraphCxSpMiddle" style='margin:0in;margin-bottom:.0001pt; line-height:120%'><span style='font-size:9.0pt;line-height:120%'>The best option is to implement a simple availability verification into the client software and failover to other instances if no answer or bad answer have been received. This can be done by using the <span style='color:#385623'>wsload</span> </span><a href="https://www.mizu-voip.com/Portals/0/Files/VoIP_Server_API.pdf"><span style='font-size:9.0pt;line-height:120%'>API</span></a><span style='font-size: 9.0pt;line-height:120%'> which will return one of the following answers: </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:120%'><span style='font-size:9.0pt; line-height:120%;font-family:"Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%;color:#385623'>ERROR, errortext</span><span style='font-size:9.0pt;line-height:120%'> indicates gateway malfunctioning</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:120%'><span style='font-size:9.0pt; line-height:120%;font-family:"Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%;color:#385623'>OK: WS Load: X type …</span><span style='font-size:9.0pt;line-height:120%'> indicates that the gateway is available. The X is a number from 0 to 4 indicating the gateway load (0-low, 1-normal, 2-high, 3-very high, 4-extreme). You can treat 4 as gateway malfunction, otherwise you should prioritize the gateway returning the lowest number.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;line-height:120%'><span style='font-size:9.0pt;line-height:120%'>If your gateways are geographically distributed, then you can check the response time to find out the nearest one (or more correctly, a combination of the gateway load and response time should be used).</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:120%'><span style='font-size:9.0pt;line-height:120%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-size:9.0pt;line-height:120%'>UAC failover</span></b></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:120%'><span style='font-size:9.0pt;line-height:120%'>Some SIP client might already have a failover mechanism implemented on the transport layer.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:120%'><span style='font-size:9.0pt;line-height:120%'>A simple way to handle gateway availability is on the SIP protocol level. Failover if there are no or bad response of the REGISTER (or OPTIONS/INVITE requests)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:120%'><span style='font-size:9.0pt;line-height:120%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-size:9.0pt;line-height:120%'>Network </span></b></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:120%'><span style='font-size:9.0pt;line-height:120%'>Another way to implement failover is to simply redirect your SIP clients to other gateways on failure. This is not so sophisticated like the above mentioned methods, but offers administrators a simple way to circumvent major outages. Failover can be forced by the following methods</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:120%'><span style='font-size:9.0pt;line-height:120%;font-family: "Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>domain name redirect (easy usage but propagation will take some time. You need to set also the A record as SRV records usually can’t be used from browser clients)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:120%'><span style='font-size:9.0pt;line-height:120%;font-family: "Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>BGP (requires some expertize and access to BGP, thus mostly available only for ISP’s)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:120%'><span style='font-size:9.0pt;line-height:120%;font-family: "Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>dynamic IP (most server hosting providers nowadays can provide dynamic IP service which can be used instead of domain redirection as an instant redirect for all peers)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><i><span style='font-size:9.0pt;line-height:120%'> </span></i></p> <p class="MsoNormal"><b><u><span style='font-size:9.0pt;line-height:107%'>Server side failover:</span></u></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'>This is about auto-prioritization among upper servers (your SIP servers).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'>You can configure multiple upper servers for a gateway and define various routing rules such as simple load balancing, quality based routing named (BRS) or any specific routing rules (depending on caller, called, time and other criteria). Check the </span><a href="https://www.mizu-voip.com/Portals/0/Files/Routing_guide.pdf"><span style='font-size:9.0pt;line-height:120%'>routing guide</span></a><span style='font-size:9.0pt;line-height:120%'> for a quick description.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'>Beside the routing rules, the MPUSH gateway is capable to auto-detect malfunctioning servers and automatically deprioritize them. This is part of the BRS algorithm, but you have a basic failover even if you are not using BRS (basic failover meant to detect bad routes and deprioritize them if there are better working SIP servers). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'>MPUSH implements failover on all levels:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:120%'><span style='font-size:9.0pt;line-height:120%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>Basic failover (“hard” failover, mentioned above, based on previous upper server behavior)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:120%'><span style='font-size:9.0pt;line-height:120%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>Routing automatic (“soft” prioritization, discussed above, based on detailed statistics)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:120%'><span style='font-size:9.0pt;line-height:120%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>Routing rules (upper server prioritizations/failover after pattern and/or destination priority)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:120%'><span style='font-size:9.0pt;line-height:120%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>Re-Register (redirect the registration to a working server on bad or no response)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:120%'><span style='font-size:9.0pt;line-height:120%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>Re-Dial (in-call failover when a bad or no response is received from the upper SIP server)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:120%'><span style='font-size:9.0pt;line-height:120%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>Or simply you might use a separate MPUSH gateway for each of your SIP servers</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'>More details can be found </span><a href="https://www.mizu-voip.com/Solutions/LargescaleVoIP.aspx"><span style='font-size:9.0pt;line-height:120%'>here</span></a><span style='font-size: 9.0pt;line-height:120%'>, </span><a href="https://www.mizu-voip.com/Portals/0/Files/VoIP_Server_HA_VoIP.pdf"><span style='font-size:9.0pt;line-height:120%'>here</span></a><span style='font-size: 9.0pt;line-height:120%'>, </span><a href="https://www.mizu-voip.com/Portals/0/Files/VoIP_Server_HA_Database.pdf"><span style='font-size:9.0pt;line-height:120%'>here</span></a><span style='font-size: 9.0pt;line-height:120%'> and </span><a href="https://www.mizu-voip.com/Portals/0/Files/VoIP_Server_DB_Failover.pdf"><span style='font-size:9.0pt;line-height:120%'>here</span></a><span style='font-size: 9.0pt;line-height:120%'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <h4><a name="_Problems_with_Push"></a>VoIP Push Notification security</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>When using the Mizu SIP server with VoIP push notification solutions, security is the same as in legacy SIP network. No account credentials needs to be transferred and account passwords are stored encrypted/hashed in the database as usually.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>When using the MPUSH gateway with third party SIP servers the clients might send their account credential to the gateway as an MD5 hash so the gateway can use the same hash for further registrations when your app is closed or sleeping. Accounts are automatically deleted from the gateway after some time of user inactivity (set to 30 days by default).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>Both the Mizutech servers and gateways are secure by default settings and you can further lock down with the security related configuration options as described in the </span><a href="https://www.mizu-voip.com/Portals/0/Files/VoIP_Server_Security.pdf"><span style='font-size:9.0pt'>SIP server security document</span></a><span style='font-size:9.0pt'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>You can also harden your infrastructure and user security by using the encrypted SIPS protocol with TLS/SRTP.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <h4><a name="node78" id="node78"></a>Ports</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>In addition of the usual ports used by the SIP protocol (5060 UDP/TCP for signaling, 5061 for TLS signaling and UDP RTP port range), when push notifications are enabled the client devices (web SIP clients from browsers and Android and iOS phones) will have to communicate also with the push cloud service. This is usually done via TCP ports 443, 2196, 5228, 5229 or 5230 thus you might need to explicitly enable these port if you are using some enterprise firewall.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>For the push server you should enable outbound ports 443, 2195 and 2196 to communicate with the cloud.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>Cloud providers does not provide specific IP addresses where their services are listening (only domain names where the underlying IP can be changed at any time).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><i><span style='font-size:8.0pt'>In case if you use the Mizu push service then also enable port 35060 for SIP (this is the port where this service is listening at fcm.webvoipphone.com / 88.150.183.67).</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <h4><a name="node79" id="node79"></a>Change SIP server address</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:14.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'>This is about changing your SIP server IP address or domain name (the upper SIP server where the calls are routed and received from) if you are using a single SIP server. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'>For example if you migrated your SIP server to a new location or if you have to change the upper SIP server details for any reason.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'>In case if you are using a licensed MPUSH gateway, make sure that your license allows the usage also with the new SIP server address.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'><br> <b>GUI configuration (this will not rewrite the upper server for existing users):</b></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'>You might go trough the “Configuration Wizard” again and configure your new SIP server.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'>Alternatively, just search for “fwdregistrations_” on the “Configurations” form and rewrite it to your new server address.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'>Add the new SIP server user record at the "Users and Devices" form.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'>Set the new SIP server on the “Routing” form.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><b><span style='font-size:9.0pt;line-height:120%'>From SQL:</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'>Replace OLDIP to your old SIP server IP and the NEWIP to the new SIP server IP address and then run the following SQL commands to change the upper SIP server address (copy-paste to the “Direct Query” form and hit the “Go” button):</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%;color:#385623'>update tb_users set hwid = REPLACE(hwid,'OLDIP','NEWIP'), ContractComment = REPLACE(ContractComment,'OLDIP','NEWIP'), ip = REPLACE(ip,'OLDIP','NEWIP'), authip = REPLACE(authip,'OLDIP','NEWIP'), domainname = REPLACE(domainname,'OLDIP','NEWIP'), proxyaddress = REPLACE(proxyaddress,'OLDIP','NEWIP'), transip = REPLACE(transip,'OLDIP','NEWIP'), name = REPLACE(name,'OLDIP','NEWIP'), username = REPLACE(username,'OLDIP','NEWIP')</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%;color:#385623'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%;color:#385623'>update tb_users_authip set authip = REPLACE(authip,'OLDIP','NEWIP')</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%;color:#385623'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%;color:#385623'>update tb_settings set valstr = REPLACE(valstr,'OLDIP','NEWIP')</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 120%'><span style='font-size:9.0pt;line-height:120%'>If you (also) use a domain name, then replace OLDIP to your old SIP server domain and the NEWIP to the new SIP server domain name and then run the SQL statements again.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:5.0pt'> </span></p> <h4><a name="_Can_I_use"></a>Can I use it with multiple servers?</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>Yes.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>The push notification gateway can be also used with multiple SIP servers. To be able to route the users to their respective servers (register, call, chat and other sessions) you have the following possibilities:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Make sure that the allowupperseverselction global config is set to 1 (it can be also set from the Configuration Wizard by selecting the “allow client driven upper server selection” checkbox on the “SIP Server” page.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Specify the upper server from the SIP client as the target URI (domain name setting) or make sure that it is sent by the <span style='color:#833C0B'>X-Sy.Uppersrv </span>SIP header. </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal; text-autospace:none'><span style='font-size:9.0pt'>More details: </span><a href="start.htm#_SIP_domain"><span style='font-size:9.0pt'>here</span></a><span style='font-size:9.0pt'>.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Specify the upper server from the gateway/server routing rules:</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal; text-autospace:none'><span style='font-size:9.0pt'> Add the new SIP server to the “Users and Devices”</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> Use the Routing form and specify your custom rules for the server selection.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> For the routing rules to be applied also for register requests, you need to set the <span style='color:#833C0B'>routingforregister </span>global config option is set to <span style='color:#833C0B'>1</span>.</span></p> <p class="MsoListParagraph" style='margin-top:0in;margin-right:0in;margin-bottom: 0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>4.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Both:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> You can use both routing rules and upper server suggestions from your SIP clients.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> If the allowupperserverselection settings is 1, then the client suggestion will overwrite your routing rules.</span></p> <p class="MsoListParagraph" style='margin-top:0in;margin-right:0in;margin-bottom: 0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>5.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Configure the gateway as your app SIP proxy address (and keep the SIP domain setting to point to your SIP server domain).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> In this case the gateway will load the upper server from the target URI.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>For all cases, make sure to create the necessary records from the “Users and devices” form for all your SIP servers:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Add them as “SIP Server” (for outbound) and as “Traffic Senders” (for inbound, usually with IP authentication).</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Then configure them in the “Routing” after your needs to specify what kind of users/calls have to be routed to which SIP server. </span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal; text-autospace:none'><span style='font-size:9.0pt'>For example you can just list them under the “default” pattern with equal priority for load balancing or configure any rules after your requirements.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>You might also set the following global config options:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;color:#833C0B'>routingforregister</span><span style='font-size:9.0pt'>: <span style='color:#833C0B'>1</span> (to use Routing also for register requests)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt; font-family:Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;color:#833C0B'>upperserverlookup</span><span style='font-size:9.0pt'>: <span style='color:#833C0B'>2</span> (lookup upper server from tb_users sipservers. -1: guess (not for mizuonly servers), 0: no, 1: if no upper server was set in global config, 2: always)</span></p> <h4><a name="node80" id="node80"></a>Can I use it with multiple applications?</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>Yes.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>Make sure to send your application package name with the X-MPUSH SIP header or pn-param Contact URI tag.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>If you are using Firebase, add all your applications with the fcm_appX and fcm_keyX global config options where X a number from 0 to 1000 (several applications might have the same server key or different).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'>If you are using Pushkit, then just copy the certificates from all your applications to the server folder (renamed to pushkit.YOURPACKAGENAME.pem).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><i><span style='font-size:9.0pt'>Note: Here on “application” we mean different SIP client software apps (not different user/instance of the same application as there is no special care required to handle multiple instances).</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <h4><a name="node81" id="node81"></a>Add push notification support to VoIP server old versions</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal"><i><span style='font-size:9.0pt;line-height:107%'>This step is required only if your server is an old version below v. 8.7 (released before 2018 April).<br> It is applicable only for the full version (not the compact versions).<br> Not for MPUSH gateway!</span></i></p> <p class="MsoListParagraphCxSpFirst" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Add missing fields:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in'><span style='font-size:9.0pt;line-height:107%'>Run the followings SQL (you can copy paste them to the “Direct Query” form in MManage or run from SQL management studio):</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.75in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>a.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>ALTER TABLE tb_users ADD [fcm] [varchar](256) NULL</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.75in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>b.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>ALTER TABLE tb_users ADD [md5x] [varchar](64) NULL</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Modify stored procedures:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in'><span style='font-size:9.0pt;line-height:107%'>Modify the following stored procedures to add the missing fields:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.75in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>a.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>v_check_calleduser: add the "fcm" field to the select list</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.75in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>b.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>v_checkuser: add "md5x" field to the select list</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Upgrade:</span></p> <p class="MsoListParagraphCxSpLast" style='margin-left:.25in'><span style='font-size:9.0pt;line-height:107%'>Download and unpack the </span><a href="https://www.mizu-voip.com/G/download/serverupgrade_2018may7.zip"><span style='font-size:9.0pt;line-height:107%'>upgrade package</span></a><span style='font-size:9.0pt;line-height:107%'> (or ask for latest from Mizutech) and overwrite the files in the server app folder with the content of the package.</span></p> <h4><a name="node82" id="node82"></a>Convert a VoIP server to a WebRTC-SIP gateway</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal"><i><span style='font-size:9.0pt;line-height:107%'>This step might be necessary only if you have installed the Mizutech VoIP server and you wish to convert into a push notification gateway. </span></i></p> <p class="MsoNormal"><i><span style='font-size:9.0pt;line-height:107%'>In case if you are using the Mizutech Softswitch, then this step is not required.<br> This step is required only for new installation of VoIP server/Softswitch. Not required for the MPUSH, SBC or MRTC.</span></i></p> <p class="MsoNormal"><i><span style='font-size:9.0pt;line-height:107%'>Do not perform this on a live server used as a Softswitch!</span></i></p> <p class="MsoListParagraphCxSpFirst" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Backup the database first.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Run the server configuration wizard (MManage -> Config menu -> Configuration wizard) and select “SBC” on the “Roles and Features” page.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>Run the “Convert to wr relay” form Config menu -> Database -> Upgrade / Change</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%'>4.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%'>The following global config options have to be set (this listing is only for informative purposes and are set automatically for SBC):</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>haswebrtc=0</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>hasflash=0</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>fs_use=0</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>haswebsocket=0</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>hasturn=0</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>enableconferencerooms=0</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>fs_pbx=0</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>forwardauthentifications=1</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>autocreatereguser=1</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>forwardauthpassword=1</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>fwdregistrations=2</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>allowupperserverselection=1 and/or fwdregistrations_ = your server details</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>fastauth=0</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>hasbilling=false</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>enforcestrongauth=false</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>MINUSERNAMELEN=2</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>minpwdlength=2</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>strongdigestauth=0</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>fwdunknownheaders=2</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>allowanonymouscaller=true</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>blocksatellitecalls=false</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>blockpremiumnumbers=0</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>blocknotbilledcalls=0</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>normalizedef=1</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>userautoaddwithowner=1</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>autonewusersencrypt=0</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>maxlinefornewunknownparents=?</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>maxlineforautotunnelusers=?</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.5in;text-indent:-.25in'><span style='font-size:9.0pt;line-height:107%;font-family:Wingdings;color:#833C0B'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:107%;color:#833C0B'>defroutertp=0</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal;text-autospace:none'><span style='font-size:9.0pt'>5.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Restart the service and now it will run as a gateway</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <h4><a name="node83" id="node83"></a>How to get support?</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:14.0pt;line-height:107%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>In case if you run into any issue, please send us the followings and we can help:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:115%'><span style='font-size:9.0pt;line-height:115%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:115%'>Problem description: What you did? What should happen? What happened?</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Mention also the (caller/called) username and/or SIP Call-ID of the problematic session(s).</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:115%'><span style='font-size:9.0pt;line-height:115%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:115%'>Detailed client log (from your app or Wireshark pcap trace file) about a failed connect/register or call session (enable max log/trace level in your WebRTC client software first if possible)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:115%'><span style='font-size:9.0pt;line-height:115%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:115%'>If the problem is with inbound call, send the SIP Call-ID or the gateway CDR ID of the failed incoming call or a detailed log from your SIP server which contains also the SIP signaling (enable max log/trace level in your SIP server first if possible)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:115%'><span style='font-size:9.0pt;line-height:115%;font-family: Symbol'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:115%'>Remote desktop (RDP) </span><a href="https://www.mizu-voip.com/Support/Wiki/tabid/99/Default.aspx?topic=Remote+desktop+login"><span style='font-size:9.0pt;line-height:115%'>access</span></a><span style='font-size:9.0pt;line-height:115%'> to the machine hosting the MPUSH gateway.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:115%'><span style='font-size:9.0pt;line-height:115%'>Make sure that your server has the minimum requirements for support: min. 4 GB RAM, good network connectivity.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>In case if you can't provide RDP access, then please send us the MPUSH gateway logs and sdf files:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:115%'><span style='font-size:9.0pt;line-height:115%;font-family: "Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:115%'>Stop the gateway first (Control menu -> Stop server) to release the currently opened log and sdf files.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:115%'><span style='font-size:9.0pt;line-height:115%;font-family: "Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:115%'>The SDF files can be found in app folder: mserver.sdf (usually at C:\Program Files (x86)\MPUSH\ or it can be accessed from the MPUSHAdmin -> File menu -> Folders -> Server Work directory)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:115%'><span style='font-size:9.0pt;line-height:115%;font-family: "Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:115%'>The log files can be found in the app Logs subfolder (can be accessed also from File menu -> Folders -> Server Logs directory).</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>We usually need the latest file(s) or the file which contains the failed register or call sessions.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:115%'><span style='font-size:9.0pt;line-height:115%;font-family: "Courier New"'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:115%'>Compress the files and send as email attachment or if too large then make it available to download (using any file-sharing service)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'><span style='font-size:9.0pt'> </span></p> <h1 style='margin-top:0in'><a name="_Toc117069579"></a><a name="_Toc478373711"><b>Resources</b></a></h1> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:14.0pt'> </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span class="MsoHyperlink"><span style='font-size:9.0pt; font-family:Symbol;color:black;text-decoration:none'>·<span style='font:7.0pt "Times New Roman"'> </span></span></span><a href="https://www.mizu-voip.com/"><span style='font-size:9.0pt;color:black'>Mizutech home page</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span class="MsoHyperlink"><span style='font-size:9.0pt; font-family:Symbol;color:black;text-decoration:none'>·<span style='font:7.0pt "Times New Roman"'> </span></span></span><a href="https://www.mizu-voip.com/Solutions/VoIPPush.aspx"><span style='font-size:9.0pt'>Mizutech VoIP PUSH notifications solutions</span></a><span class="MsoHyperlink"><span style='font-size:9.0pt;color:black'> </span></span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://www.mizu-voip.com/Software/VoIPPushGateway.aspx"><span style='font-size:9.0pt'>VoIP PUSH notification gateway</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://developer.apple.com/documentation/pushkit"><span style='font-size:9.0pt'>Apple PushKit</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;color:black'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://firebase.google.com/docs/cloud-messaging/"><span style='font-size:9.0pt'>Google Firebase</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span class="MsoHyperlink"><span style='font-size:9.0pt; font-family:Symbol;color:black;text-decoration:none'>·<span style='font:7.0pt "Times New Roman"'> </span></span></span><span style='font-size:9.0pt;color:black'><a href="mailto:info@mizu-voip.com?subject=VoIP%20push%20notifications"><span style='color:black'>Contact</span></a></span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:107%'>Copyright © </span><span style='font-size:9.0pt;line-height:107%'>Mizutech SRL</span></p> </div>
Contents
Topics
Search
About
How it works?
Softswitch vs Gateway
Usage
Server
Gateway configuration
Enable VoIP push notifications
Important configuration settings
Advanced configuration options
VoIP push notification messages
Monitoring
Client
Generic Instructions
Android
In short
Prerequisites
Online resources
Create a Firebase project
Configure Firebase for your app
Manifest configuration
Get the device registration token
Configure the server or gateway
Register to server or gateway
Receive and handle notifications
iOS with PushKit
In short
Online resources
Prerequisites
Create an App ID
VoIP push certificate
Set the app capabilities
Configure the server or gateway
Register to the server or gateway
Adding the code
iOS with FCM
In short
Online resources
Prerequisites
Add Firebase to your softphone
Add the SDK
Configuring APNs with FCM
Create the authentication key
Create an APP ID
Create the Provisioning Profile
Upload your APNs authentication key
Initialize Firebase in your app
Receive the current registration token
Configure the server or gateway
Register to the server/gateway
Handle notifications
Web
In short
Prerequisites
Online resources
Create a Firebase project
Add Firebase to your web project
Configure the server or gateway
Register to the server or gateway
WebPhone
In short
Prerequisites
Create a Firebase project
Set Firebase configuration in your webphone
Configure the Mizutech server or gateway
Register to server or gateway
Receive and handle notifications
AJVoIP
In short
Prerequisites
Online resources
Create a Firebase project
Configure Firebase for your app
Manifest configuration
Get the device registration token
Configure the server or gateway
MBuilder
Enable push notifications
Receive and handle notifications
AJVoIP -Mizu PUSH service
Prerequisites
Online resources
Configure Firebase for your app
Manifest configuration
Get the device registration token
Enable push notifications
Receive and handle notifications
Customized MizuDroid
Others
SIP Signaling
X-MPUSH
In short (summary)
Description
Token
Credentials
SIP domain
Example
RFC 8599
In short (summary)
Description
Example
Improvements
Reference
FAQ
Abbreviations
How to test
Troubleshooting
Problems with push notifications
App doesn’t receive the push notification
App doesn’t receive the incoming call
App doesn’t receive text messages
App receive push notification and calls even after unregister
How to unregister from push notifications
Difference from the RFC 8599 standard
High Availability
VoIP Push Notification security
Ports
Change SIP server address
Can I use it with multiple servers?
Can I use it with multiple applications?
Add push notification support to VoIP server old versions
Convert a VoIP server to a WebRTC-SIP gateway
How to get support?
Resources
Abbreviations
About
Add Firebase to your softphone
Add Firebase to your web project
Add push notification support to VoIP server old versions
Add the SDK
Adding the code
Advanced configuration options
AJVoIP
AJVoIP -Mizu PUSH service
Android
App doesn’t receive text messages
App doesn’t receive the incoming call
App doesn’t receive the push notification
App receive push notification and calls even after unregister
Can I use it with multiple applications?
Can I use it with multiple servers?
Change SIP server address
Client
Configure Firebase for your app
Configure Firebase for your app
Configure Firebase for your app
Configure the Mizutech server or gateway
Configure the server or gateway
Configure the server or gateway
Configure the server or gateway
Configure the server or gateway
Configure the server or gateway
Configuring APNs with FCM
Convert a VoIP server to a WebRTC-SIP gateway
Create a Firebase project
Create a Firebase project
Create a Firebase project
Create a Firebase project
Create an App ID
Create an APP ID
Create the authentication key
Create the Provisioning Profile
Credentials
Customized MizuDroid
Description
Description
Difference from the RFC 8599 standard
Enable push notifications
Enable push notifications
Enable VoIP push notifications
Example
Example
FAQ
Gateway configuration
Generic Instructions
Get the device registration token
Get the device registration token
Get the device registration token
Handle notifications
High Availability
How it works?
How to get support?
How to test
How to unregister from push notifications
Important configuration settings
Improvements
In short
In short
In short
In short
In short
In short
In short (summary)
In short (summary)
Initialize Firebase in your app
iOS with FCM
iOS with PushKit
Manifest configuration
Manifest configuration
Manifest configuration
MBuilder
Monitoring
Online resources
Online resources
Online resources
Online resources
Online resources
Online resources
Others
Ports
Prerequisites
Prerequisites
Prerequisites
Prerequisites
Prerequisites
Prerequisites
Prerequisites
Problems with push notifications
Receive and handle notifications
Receive and handle notifications
Receive and handle notifications
Receive and handle notifications
Receive the current registration token
Reference
Register to server or gateway
Register to server or gateway
Register to the server or gateway
Register to the server or gateway
Register to the server/gateway
Resources
RFC 8599
Server
Set Firebase configuration in your webphone
Set the app capabilities
SIP domain
SIP Signaling
Softswitch vs Gateway
Token
Troubleshooting
Upload your APNs authentication key
Usage
VoIP push notification messages
VoIP push certificate
VoIP Push Notification security
Web
WebPhone
X-MPUSH
SIP Push Gateway
