How to program a ST500 APP to a SL2100 / SV9100

Pre-requisite:

A Static Public IP for the NEC system

Port forward "Register Port" on your external router to the LAN address of the CPU (10-12-09)

Port forward range (UDP 10020-10531) on your external router to the LAN address of the DSP (84-26-01).

SIP ALG disabled on the customers router

Hardware / License required:

SV9100:

	Quantity	Description
SV9100 CPU	1	System
GPZ-IPLE	1	VoIP Media card to convert RTP packets
BE114054-CP20	Per IP phone	SV9100 IP PHONE-01 LIC

BE1114054-PC20 appears as a 5111 lic on the system:

SL2100:

	Quantity	Description
SL2100 System	1	System
IP7WW-VOIPDB-C1	?	VoIP Media card to convert RTP packets
BE116746	Per IP phone	IP Phone License

Note: for the SV2100 VOIPDB is only required if you need to exceed 8 VoIP channels

BE116746 appears as a 5111 Lic on the system

System Programming:

PRG 10-12-03    Enter the default gateway

RRG 10-12-10    Subnet mask that matches the customers network

PRG 84-26-01    Valid IP address on the customers network ( by convention, one IP above 10-12-09 )

PRG 84-20-01    Check port number default = 5070 .. change to 45070

PRG 10-33-02    Enable Authentication Mode

Assign password to extension port

This feature is only available using PC Pro, HTTP access will only show extensions that has physical hardware attached ( Analogue blade , Digital blade or ports with a MAC address assigned )

In order to see “Unregistered” extension ports you must allow them to be viewed:

Open PCPro connect to the system and download the database then select:

Filter options > IP Phone list > Select unused extension ports

Assign a password in PRG 15-05-16, per extension

Enable NAT Plug and Play in PRG 15-05-45, per extension

ST500 iOS Push Notification Support 

Reference : TIB-SV9100 R9 Main Software-1.0

This feature supports the Apple PUSH Notification Service for iOS devices, in order to send PUSH Notifications to the ST450 / ST500 VoIP application for an incoming event targeted at a client with the PUSH Notification feature enabled. The incoming event can either be incoming calls or sending a MWI indication. The SV9100 initiates a PUSH Notification Request via a PUSH Proxy to the PUSH Notification Service provided by Apple. 

The PUSH Notification Service delivers a PUSH Notification payload to the ST500 VoIP application running in the background on the target device. The ST500 VoIP application while running in the background operates in a ‘sleep’ state and cannot receive the incoming event through a SIP message, but with PUSH Notification delivered by the PUSH Notification Service, it is possible to process the SIP message. The SV9100 requests the PUSH Notification Service to send the PUSH Notification prior to sending the incoming event by SIP message to the ST500 VoIP application. To support this feature the SV9100 requires access to the Internet. 

NOTE: iOS11 and later do not assure the receipt of incoming call notifications when the ST500 VoIP application is running in the background. This feature is effective under the assumption that the smart devices being used are running iOS11 or later. 

Benefits 

The ST500 Application whilst running in the background in a ‘sleep’ state, can receive notification of incoming calls and MWI indication at the client that otherwise would have been missed by the user. 

Required Licenses, Software and Hardware 

- SV9100 R9 Software 

- ST500 v2.0.0 or higher 

- BE114051 SV9100 Version License (R9) [License Feature Code 0419] 

- BE114042 System Port License [License Feature Code 0300] 

- BE114054 SV9100 IP Phone License [License Feature Code 5111] 

- GPZ-IPLE Daughter Board 

6.1 Operation 

Incoming call targeting ST500 on iOS 11 

1. When SV9100 receives a call request to the ST500 VoIP application, it sends a PUSH Notification Request (HTTPS) to the PUSH Proxy before calling the ST500 VoIP application. 

2. The PUSH Proxy sends the PUSH Notification Request to the specified PUSH Notification Service when the PUSH Proxy receives the PUSH Notification Request from SV9100. Then the PUSH Notification Service sends the PUSH Notification to the ST500 VoIP application. 

3. When the ST500 VoIP application receives the PUSH Notification, it updates its registration to SV9100. 

4. At the same time as when the SV9100 receives the registration update, it starts calling the VoIP application to terminate the incoming call. 

With this feature, SV9100 sends a PUSH Notification request for terminating an incoming call or sending a MWI notification (message waiting indication: RFC3842) to the ST500 VoIP application.

Requirements for using Push Notification

Item			Requirements
VoIP application	Supported OS	iOS 11 or higher
Supported firmware version			ST500 v2.0.0 or higher
SV9100 software version			SV9100 R9 or higher
Push Proxy server			aus01.nec-pushproxy.com
Push Notification Service			Apple Push Notification service (APNs)

Secure Communication 

In order for the communication between SV9100 and PUSH Proxy to be securely encrypted. A certificate for Amazon Web Services must be installed on the SV9100 via WebPro > Certificate Registration. 

-To Download the Root CA file, access amazon trust services web site. 

- From your PC, access https://www.amazontrust.com/repository/ 

- Find the file with the Name 'CN=Amazon Root CA 1,O=Amazon,C=US'. 

- Only certificates using a PEM format are supported by SV9100. Right-Click on the ‘file PEM’ to save on your PC. 

- Certificates can be added and deleted by WebPro under Certificate Registration. 

- Only MF, IN or UA level User can use Certificate Registration on WebPro. Certificate Registration is not displayed when SA or SB level user logs in. 

- Click Certificate Registration on WebPro Home Page, and upload the certificate file from your PC. 

- After the upload is complete, confirm Certificate File Name on WebPro Screen. 

- Set the above Certificate File Name in Program 10-76-03. 

Once the expiration date has attained, a new AWS Server Certificate needs to be downloaded and registered again.

System Programming 

PRG 10-76 Push Notification Service Basic Setup

Note: 

1. Do not change the default domain name entry in PRG 10-76-01 unless advised otherwise. 

2. If a HTTPS Proxy Server is not defined in PRG 10-76-04, DNS server IP address entries are required in PRG 10-12-13 (Primary DNS) and PRG 10-12-14 (Secondary DNS) for FQDN to IP address translation. 

3. Do not change the default access key in PRG 10-76-02 unless advised otherwise. 

4. The AWS server certificate name must match the filename, including filename extension, noted in WebPro > Certificate registration. 

PRG 24-02 Transfer System Options 

It is recommended to set the SIP out of range timer in PRG 24-02-15 = 7. If left at default value, the SIP terminal with Push Proxy enable may be unable to receive a call because this timer is short.

The Push Notification Service can be enabled on any iOS 11 or later smart device running the ST500 VoIP Application, by opening a configuration profile, and enabling the option Telephone System > Push Notification.

Service Conditions 

- When the ST500 VoIP application with PUSH Notification enabled is in a logout state, it cannot receive incoming calls. To receive incoming calls requires making the ST500 VoIP application foreground once or restarting the ST500 VoIP application to register to SV9100. The conditions for a logout state are as follows: 

- A system reset is performed 

- A system fail-over occurs in Net-Link system. 

Note: 

It is recommended to set the data for the ST500 extensions such as Department Hunting/Call Forwarding when the Standard SIP terminal is unable to receive a call. 

- To use PUSH Notification Service, SV9100 R9 or higher and SV9100 VERSION LIC (R9) are required. 

- The smart device where the ST500 VoIP application runs will receive the PUSH Notifications from the PUSH Notification Service. Therefore, each device must contain a SIM card or be able to access the Internet via Wi-Fi. It is strongly recommended to use a device equipped with a SIM card even when using Wi-Fi for seamless roaming. (It may take a while for the device to become available when the terminal moves to wireless radio range from outside.) 

- SV9100 requires an Internet connection because the PUSH Proxy runs on an Internet-based server. 

Note: For security reasons, it is strongly recommended that a firewall be set up between the SV9100 and the PUSH Proxy. Port 443 requires to be forwarded to the SV9100 IP address in PRG 10-12-09 

- To access the PUSH Proxy, the FQDN for the PUSH Proxy is already configured on SV9100. When not using Web Proxy, setting the address for the DNS server (primary/secondary) is required for IP address resolution. 

- For secure communication with the PUSH Proxy, it is recommended to register the Server Certificate. 

- To Download Root CA file, access amazon trust services web site and use Web Pro to add the server certificate 

Note: The server certificate must be valid for the feature to work. 

- This service feature is only available for situations in which the PUSH Notification can be sent to the ST500 VoIP application via the PUSH Proxy connected to the SV9100. 

- The ST500 VoIP application must complete the communication with the PUSH Notification Service and register itself to the SV9100 in advance of receiving a PUSH Notification. 

Note: The registration information contains the Application ID and the device token which are required for the PUSH Notification.

− With this service, the SV9100 uses the PUSH Notification Service such as APNs via the PUSH Proxy. It is a service that depends on external network services and cannot run if the following issues arise; 

- Network path failure 

- PUSH Proxy failure 

- PUSH Notification Service failure 

- Communication failure between PUSH Notification Service and the smart device 

- Unlike other SIP terminals, the ST500 VoIP application with PUSH Notification enabled does not periodically send REGISTER update to the SV9100. However, the SV9100 maintains the login state of the VoIP application even if it does not receive REGISTER update. As a result, even if the ST500 VoIP application is out of service (closed) or in an unusable state, it will not be logged out and the license will remain consumed. If the ST500 VoIP application is no longer required, use PRG 90-23 to release the license. 

- The timer of SIP Out of Range (PRG 24-02-15) must be adjusted to the customer’s network environment. The SIP terminal with Push Proxy enabled may be unable to receive a call because the default value is too short. 

- Standard SIP Terminals with or without Push Notification enabled can be used on the same SV9100. 

- PUSH Notification must be enabled on the ST500 VoIP Application configuration screen 

- While a ST500 VoIP application with PUSH Notification enabled is logged in to the system, if another ST500 VoIP application with the PUSH Notification disabled/unsupported logs in with the same station number, an override automatically occurs. The overridden ST500 VoIP application, the one with the PUSH Notification enabled, is logged out and not able to use this feature. 

- HTTPS connections is used for sending a PUSH Notification request. Depending on the network configuration, it may be necessary to assign Web Proxy-related data by the Program 10-76-04/05 in order to relay through the Web Proxy. 

- When a calling party makes a call to the ST500 VoIP application, the ST500 VoIP application is not called until the PUSH Notification is received and the registration to the SV9100 is completed. During this period, the calling party continues to hear silence. 

- The clock of the SV9100 must be adjusted to the correct current time. A significant difference between the set time and the current time may cause a connection failure to the PUSH Proxy.