The sip:provider CE Handbook mr4.4.2

The sip:provider CE Handbook mr4.4.2

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. General Call Setup
2.1.2.2. Endpoint Registration
2.1.2.3. Basic Call
2.1.2.4. Session Keep-Alive
2.1.2.5. Voicebox Calls

3. Upgrading from previous versions

3.1. Upgrade from previous versions to mr4.4.2

4. Initial Installation

4.1. Prerequisites

4.2. Using the NGCP install CD (recommended)

4.3. Using the NGCP installer

4.3.1. Installing the Operating System

4.3.1.1. Using special Debian setups

4.3.2. Installing the sip:provider CE

4.4. Using a pre-installed virtual machine

4.4.1. Vagrant box for VirtualBox
4.4.2. VirtualBox image
4.4.3. VMware image
4.4.4. Amazon EC2 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.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.2.4. Assigning NCOS Level for Forwarded Calls 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. Header Manipulation

7.3.1. Header Filtering
7.3.2. Codec Filtering
7.3.3. Enable History and Diversion Headers

7.4. SIP Trunking with SIPconnect

7.4.1. User provisioning

7.4.2. Inbound calls routing

7.4.3. Number manipulations

7.4.3.1. Rewrite rules
7.4.3.2. User parameter
7.4.3.3. Forwarding number
7.4.3.4. Allowed CLIs

7.4.4. Registration

7.4.4.1. Trusted sources

7.5. Limiting Subscriber Preferences via Subscriber Profiles

7.5.1. Subscriber Profile Sets

7.6. Creating Trusted Subscribers

7.7. Voicemail System

7.7.1. Accessing the IVR Menu

7.7.1.1. Mapping numbers and codes to IVR access
7.7.1.2. External IVR access

7.7.2. IVR Menu Structure

7.7.3. Type Of Messages

7.7.3.1. Unavailable Message
7.7.3.2. Busy Message
7.7.3.3. Temporary Greeting

7.7.4. Folders

7.7.4.1. The Default Folder List

7.8. XMPP Instant Messaging

7.9. Configuring Subscriber IVR Language

7.10. Sound Sets

7.10.1. Configuring Early Reject Sound Sets

7.11. Conference System

7.11.1. Configuring Call Forward to Conference
7.11.2. Configuring Conference Sound Sets
7.11.3. Entering the Conference with a PIN

7.12. Malicious Call Identification (MCID)

7.12.1. Setup
7.12.2. Usage
7.12.3. Advanced configuration

7.13. Handling WebRTC Clients

7.14. SIP loop detection

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.2.1. Vertical Service Codes for PBX customers
8.2.2. Configuration of Vertical Service Codes

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 for Call Detail Records (CDR)
9.2.2.3. File Body Format for Event Detail Records (EDR)
9.2.2.4. File Trailer Format

9.2.3. File Transfer

10. Invoices and invoice templates

10.1. Invoices management

10.2. Invoice templates

10.2.1. Invoice Templates management

10.2.2. Invoice Template content

10.2.2.1. Layers
10.2.2.2. Edit SVG XML source
10.2.2.3. Change logo image

10.2.3. Save and preview invoice template content.

10.3. Invoices generation

11. Email templates

11.1. Email events
11.2. Initial template values and template variables
11.3. Password reset email template
11.4. New subscriber notification email template
11.5. Invoice email template
11.6. Email templates management

12. Local Number Porting

12.1. Local LNP Database

12.1.1. LNP Carriers

12.1.2. LNP Numbers

12.1.3. Enabling local LNP support

12.1.4. LNP Routing Procedure

12.1.4.1. Calls to non-authoritative Carriers

12.1.5. Transit Calls using LNP

12.1.6. CSV Format

13. Provisioning interfaces

13.1. REST API

13.1.1. API Workflows

13.1.1.1. Managing Customers and Subscribers

13.2. SOAP and XMLRPC API

14. Configuration Framework

14.1. Configuration templates

14.1.1. .tt2 and .customtt.tt2 files
14.1.2. .prebuild and .postbuild files
14.1.3. .services files

14.2. config.yml, constants.yml and network.yml files

14.3. ngcpcfg and its command line options

14.3.1. apply
14.3.2. build
14.3.3. commit
14.3.4. decrypt
14.3.5. diff
14.3.6. encrypt
14.3.7. help
14.3.8. initialise
14.3.9. pull
14.3.10. push
14.3.11. services
14.3.12. status

15. Network Configuration

15.1. General Structure
15.2. Available Host Options

16. Advanced Network Configuration

16.1. Extra SIP Sockets
16.2. Extra SIP and RTP Sockets

17. Security and Maintenance

17.1. Sipwise SSH access to sip:provider CE

17.2. Firewalling

17.3. Password management

17.4. SSL certificates.

17.5. Securing your sip:provider CE against SIP attacks

17.5.1. Denial of Service
17.5.2. Bruteforcing SIP credentials

17.6. Backup and recovery

17.6.1. Backup

17.6.1.1. What data to back up
17.6.1.2. The built-in backup solution

17.6.2. Recovery

17.7. Reset database

17.8. System requirements and performance

17.9. Troubleshooting

17.9.1. Collecting call information from logs
17.9.2. Collecting SIP traces

A. NGCP configs overview

A.1. config.yml overview

Next