The sip:provider CE Handbook mr3.3.1


Table of Contents

1. Introduction
1.1. About this Document
1.2. Getting Help
1.2.1. Community Support
1.2.2. Commercial Support
1.3. What is the sip:provider CE?
1.4. What is inside the sip:provider CE?
1.5. Who should use the sip:provider CE?
2. Platform Architecture
2.1. SIP Signaling and Media Relay
2.1.1. SIP and Media Elements
2.1.1.1. SIP Load-Balancer
2.1.1.2. SIP Proxy/Registrar
2.1.1.3. SIP Back-to-Back User-Agent (B2BUA)
2.1.1.4. SIP App-Server
2.1.1.5. Media Relay
2.1.2. Basic Call Flows
2.1.2.1. Endpoint Registration
2.1.2.2. Basic Call
2.1.2.3. Session Keep-Alive
2.1.2.4. Voicebox Calls
3. Upgrading from previous versions
3.1. Upgrade from previous versions to mr3.3.1
4. Initial Installation
4.1. Prerequisites
4.2. Using the NGCP installer (recommended)
4.2.1. Installing the Operating System
4.2.1.1. Using special Debian setups
4.2.2. Installing the sip:provider CE
4.3. Using a pre-installed virtual machine
4.3.1. Vagrant box for VirtualBox
4.3.2. VirtualBox image
4.3.3. VMware image
5. Initial System Configuration
5.1. Network Configuration
5.2. Apply Configuration Changes
5.3. Start Securing Your Server
5.4. Configuring the Email Server
5.5. Advanced Network Configuration
5.5.1. Audiocodes devices workaround
5.5.2. Extra SIP listening ports
5.6. What’s next?
6. Administrative Configuration
6.1. Creating a Customer
6.2. Creating a Subscriber
6.3. Domain Preferences
6.4. Subscriber Preferences
6.5. Creating Peerings
6.5.1. Creating Peering Groups
6.5.2. Creating Peering Servers
6.5.3. Authenticating and Registering against Peering Servers
6.5.3.1. Proxy-Authentication for outbound calls
6.5.3.2. Registering at a Peering Server
6.6. Configuring Rewrite Rule Sets
6.6.1. Inbound Rewrite Rules for Caller
6.6.2. Inbound Rewrite Rules for Callee
6.6.3. Outbound Rewrite Rules for Caller
6.6.4. Outbound Rewrite Rules for Callee
6.6.5. Emergency Number Handling
6.6.6. Assigning Rewrite Rule Sets to Domains and Subscribers
6.6.7. Creating Dialplans for Peering Servers
7. Advanced Subscriber Configuration
7.1. Access Control for SIP Calls
7.1.1. Block Lists
7.1.1.1. Block Modes
7.1.1.2. Block Lists
7.1.1.3. Block Anonymous Numbers
7.1.2. NCOS Levels
7.1.2.1. Creating NCOS Levels
7.1.2.2. Creating Rules per NCOS Level
7.1.2.3. Assigning NCOS Levels to Subscribers/Domains
7.1.3. IP Address Restriction
7.2. Call Forwarding and Call Hunting
7.2.1. Setting a simple Call Forward
7.2.2. Advanced Call Hunting
7.2.2.1. Configuring Destination Sets
7.2.2.2. Configuring Time Sets
7.3. Limiting Subscriber Preferences via Subscriber Profiles
7.3.1. Subscriber Profile Sets
7.4. Voicemail System
7.4.1. IVR Menu Structure
8. Customer Self-Care Interfaces
8.1. The Customer Self-Care Web Interface
8.1.1. Login Procedure
8.1.2. Site Customization
8.2. The Vertical Service Code Interface
8.3. The Voicemail Interface
9. Billing Configuration
9.1. Billing Data Import
9.1.1. Creating Billing Profiles
9.1.2. Creating Billing Fees
9.1.3. Creating Off-Peak Times
9.1.4. Fraud Detection and Locking
9.2. Billing Data Export
9.2.1. File Name Format
9.2.2. File Format
9.2.2.1. File Header Format
9.2.2.2. File Body Format
9.2.2.3. File Trailer Format
9.2.3. File Transfer
10. Provisioning interfaces
10.1. REST API
10.2. SOAP and XMLRPC API
11. Configuration Framework
11.1. Configuration templates
11.1.1. .tt2 and .customtt.tt2 files
11.1.2. .prebuild and .postbuild files
11.1.3. .services files
11.2. config.yml, constants.yml and network.yml files
11.3. ngcpcfg and its command line options
11.3.1. apply
11.3.2. build
11.3.3. commit
11.3.4. decrypt
11.3.5. diff
11.3.6. encrypt
11.3.7. help
11.3.8. initialise
11.3.9. pull
11.3.10. push
11.3.11. services
11.3.12. status
12. Network Configuration
12.1. General Structure
12.2. Available Host Options
13. Security and Maintenance
13.1. Firewalling
13.2. Password management
13.3. SSL certificates.
13.4. Backup and recovery
13.4.1. Backup
13.4.2. Recovery
13.5. Reset database
13.6. System requirements and performance