~~Title: netsapiens~~
====== netsapiens ======

===== Features =====
^ Feature ^ Description ^
| Class of service | Yes via //dial policy// |
| Direct calls | Yes |
| Call forward RNA/Busy integration | Yes |
| DND | Yes |
| MWI | Direct to phone only. |
| Name changes | Yes, first and last names. |

===== Requirements =====
  * DuVoice 6.01 or above.
  * Lan connection.
  * Internet connection.
  * SNAPsolution v38 or greater
  * Endpoints v38 or greater for provisioning of VTech hospitality phones
  * Dial translations leading to the user must be “To User” type not “To User Residential” (Enhanced Voicemail enabled)

===== Notes =====
  * PBX plays it's own prompts during a transfer.

====== PBX Configuration ======

===== SNAPsolution Configuration =====

==== Create an OAuth Client ID and Secret ====
Each DuVoice system will require a Client ID and Secret, create a Client ID and Secret for the DuVoice system with these [[https://help.netsapiens.com/hc/en-us/articles/204923990-How-do-I-Generate-a-Client-ID-and-Client-Secret-|directions]].

==== Create Domain ====
Create the domain for the hotel as any other domain. 

==== Create DuVoice User ====
The DuVoice system needs a user to register and access the API.

  - Create a user with the following properties
    * Office Manager Scope.
    * Ensure “Add Phone Extension” is checked.
  - After creating the user
    * Edit the user.
    * Go to the Phones tab.
    * Edit the device.
    * Copy down the values from the “Settings” box.

==== Create Dial Translation for VMail ====
In the domain dial translation table, create a rule like follows (leave other fields default):

{{:images:pbx:netsapiens:dialtranslation.png|}}

^ Settings ^ Description ^
| //Source// | * |
| //Destination// | VMail |
| //Application// | To Device Add Header |
| //Application Parameter// | Diversion: <nowiki><LT>sip:<OwnUser>@<OwnDomain><GT>;reason=no-answer;</nowiki> |
| //Destination User Translation// | DuVoice User created in previous step |
| //Destination Host Translation// | <OwnDomain> |
| //Source Host Translation// | <OwnDomain> |

===== CDR Exporter (Optional) =====
This step is only needed when call accounting is being used. The call accounting software will reside on the DuVoice system, a port forward from the firewall will be needed to allow for uploading CDR records to the DuVoice system on the LAN. 

In Core Admin UI go to System > CDR Export > CDR Schedule, Complete the following fields.

{{:images:pbx:netsapiens:cdr.png|}}

^ Settings ^ Description ^
| //Schedule name// | name of the schedule (any value). |
| //Domain// | Name of the hotel’s domain. |
| //Period// | How often to send CDRs (5 is a good value for regular updates before checkout). |
| //Include Header// | yes |
| //Show Inbound// | yes |
| //Show Outbound// | yes |
| //Export Method// | ftp upload |
| //Hostname// | WAN IP/FQDN of the DuVoice/Call Accounting Server. |

  - Click Create to make the new export schedule.
  - Edit the schedule you just created and set the Next Run Time for the time and date it should start running.

===== Emergency Notification (Optional) =====
Hotels commonly want notification when and from which room an emergency (911) call was placed. See this [[https://help.netsapiens.com/hc/en-us/articles/228578567-How-Can-I-Enable-Notifications-for-Emergency-Calls-that-Have-Been-Placed-|document]] for information how to set up emergency notification. 

====== DuVoice Configuration ======

===== Setup =====

{{:images:pbx:netsapiens:setup.png|}}

Choose **Other \ SIP Enabled PBX**

===== Profile Configuration =====

==== Details ====

{{:images:pbx:netsapiens:profile1.png|}}

^ Settings ^ Description ^
| //PBX// | Choose **Netsapiens** |

==== PBX Link ====

{{:images:pbx:netsapiens:profile2.png|}}

All these setting must be supplied by Netsapiens.

^ Settings ^ Description ^
| //Server URL// | URL to post changes. Trailing slash is typically required. \\ **Example**: <nowiki>https://yourserver.domain.com/ns-api/</nowiki> |
| //OAuth URL// | URL for authentication using OAuth. Trailing slash is typically required. \\ **Example**: <nowiki>https://yourserver.domain.com/ns-api/oauth2/token/</nowiki> |
| //Username// | Required username for login. |
| //Password// | Required password for login. |
| //Domain// | Domain all users are located in. |
| //OAuthID// | OAuth ID.|
| //Secret// | OAuth secret key.|
| //Retries// | Number of retires before failure. |
| //Interval (seconds)// | Number of seconds to wait between retries. |
| //Timeout (seconds)// | Number of seconds to wait for response from server. |

===== SIP Configuration =====

==== PBX Settings ====

{{:images:pbx:netsapiens:sippbx.png|}}

^ Settings ^ Description ^
| //PBX IP or DNS// | DNS name of the netsapien server.
| //Port// | This port number may change, in our testing it was 5092. |
| //Domain Name// | Domain name lines are associated with. |
| //Register expire time// | Set this to 60. |
| //Realm// | Realm the line is a member. |
| //Transport Protocol// | Default UDP. |
| //Register using// | Choose **Domain Name**. |

==== Lines ====
Regardless of the number of lines the DuVoice is configured for only a single line registers and all extension fields should match. For line one only, enter the extension, account, and password to the line with register with.

{{:images:pbx:netsapiens:siplines.png|}}