The sip:provider PRO Handbook mr4.2.2
Table of Contents
1. Introduction
1.1. About this Document
1.2. Getting Help
1.2.1. Phone Support
1.2.2. Ticket System
1.3. What is the sip:provider PRO?
1.4. What is inside the sip:provider PRO?
1.5. Who should use the sip:provider PRO?
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
2.2. High Availability and Fail-Over
2.2.1. Overview
2.2.2. Core Concepts and Configuration
2.2.3. Administration
2.3. Fax Server Architecture
2.3.1. Software-Based Fax Server
2.3.1.1. Fax2Mail Architecture
2.3.1.2. Sendfax Architecture
2.3.2. Hardware-Based Fax Server
2.3.2.1. Fax2Mail Architecture
2.3.2.2. Sendfax Architecture
3. Upgrading the sip:provider PRO
3.1. Preparation
3.2. Upgrade
4. Installation
4.1. Hardware Specifications
4.1.1. Dimensions and Weight
4.1.2. Front View
4.1.3. Back View
4.2. Installation Prerequisites
4.3. Rack-Mount Installation
4.4. Power Supply Cabling
4.5. Network Cabling
5. Administrative Configuration
5.1. Creating a Customer
5.2. Creating a Subscriber
5.3. Domain Preferences
5.4. Subscriber Preferences
5.5. Creating Peerings
5.5.1. Creating Peering Groups
5.5.2. Creating Peering Servers
5.5.3. Authenticating and Registering against Peering Servers
5.5.3.1. Proxy-Authentication for outbound calls
5.5.3.2. Registering at a Peering Server
5.6. Configuring Rewrite Rule Sets
5.6.1. Inbound Rewrite Rules for Caller
5.6.2. Inbound Rewrite Rules for Callee
5.6.3. Outbound Rewrite Rules for Caller
5.6.4. Outbound Rewrite Rules for Callee
5.6.5. Emergency Number Handling
5.6.6. Assigning Rewrite Rule Sets to Domains and Subscribers
5.6.7. Creating Dialplans for Peering Servers
6. Advanced Subscriber Configuration
6.1. Access Control for SIP Calls
6.1.1. Block Lists
6.1.1.1. Block Modes
6.1.1.2. Block Lists
6.1.1.3. Block Anonymous Numbers
6.1.2. NCOS Levels
6.1.2.1. Creating NCOS Levels
6.1.2.2. Creating Rules per NCOS Level
6.1.2.3. Assigning NCOS Levels to Subscribers/Domains
6.1.2.4. Assigning NCOS Level for Forwarded Calls to Subscribers/Domains
6.1.3. IP Address Restriction
6.2. Call Forwarding and Call Hunting
6.2.1. Setting a simple Call Forward
6.2.2. Advanced Call Hunting
6.2.2.1. Configuring Destination Sets
6.2.2.2. Configuring Time Sets
6.3. Enable History and Diversion Headers
6.4. Limiting Subscriber Preferences via Subscriber Profiles
6.4.1. Subscriber Profile Sets
6.5. Voicemail System
6.5.1. Accessing the IVR Menu
6.5.1.1. Mapping numbers and codes to IVR access
6.5.1.2. External IVR access
6.5.2. IVR Menu Structure
6.5.3. Type Of Messages
6.5.3.1. Unavailable Message
6.5.3.2. Busy Message
6.5.3.3. Temporary Greeting
6.5.4. Folders
6.5.4.1. The Default Folder List
6.6. Configuring Subscriber IVR Language
6.7. Sound Sets
6.7.1. Configuring Early Reject Sound Sets
6.8. Conference System
6.8.1. Configuring Call Forward to Conference
6.8.2. Configuring Conference Sound Sets
6.8.3. Entering the Conference with a PIN
6.9. Malicious Call Identification (MCID)
6.9.1. Setup
6.9.2. Usage
6.9.3. Advanced configuration
7. Customer Self-Care Interfaces
7.1. The Customer Self-Care Web Interface
7.1.1. Login Procedure
7.1.2. Site Customization
7.2. The Vertical Service Code Interface
7.3. The Voicemail Interface
8. Billing Configuration
8.1. Billing Data Import
8.1.1. Creating Billing Profiles
8.1.2. Creating Billing Fees
8.1.3. Creating Off-Peak Times
8.1.4. Prepaid Accounting
8.1.5. Fraud Detection and Locking
8.2. Billing Data Export
8.2.1. File Name Format
8.2.2. File Format
8.2.2.1. File Header Format
8.2.2.2. File Body Format for Call Detail Records (CDR)
8.2.2.3. File Body Format for Event Detail Records (EDR)
8.2.2.4. File Trailer Format
8.2.3. File Transfer
9. Invoices and invoice templates
9.1. Invoices management
9.2. Invoice templates
9.2.1. Invoice Templates management
9.2.2. Invoice Template content
9.2.2.1. Layers
9.2.2.2. Edit SVG XML source
9.2.2.3. Change logo image
9.2.3. Save and preview invoice template content.
9.3. Invoices generation
10. Email templates
10.1. Email events
10.2. Initial template values and template variables
10.3. Password reset email template
10.4. New subscriber notification email template
10.5. Invoice email template
10.6. Email templates management
11. Provisioning interfaces
11.1. REST API
11.1.1. API Workflows
11.1.1.1. Managing Customers and Subscribers
11.2. SOAP and XMLRPC API
12. Configuration Framework
12.1. Configuration templates
12.1.1. .tt2 and .customtt.tt2 files
12.1.2. .prebuild and .postbuild files
12.1.3. .services files
12.2. config.yml, constants.yml and network.yml files
12.3. ngcpcfg and its command line options
12.3.1. apply
12.3.2. build
12.3.3. commit
12.3.4. decrypt
12.3.5. diff
12.3.6. encrypt
12.3.7. help
12.3.8. initialise
12.3.9. pull
12.3.10. push
12.3.11. services
12.3.12. status
13. Network Configuration
13.1. General Structure
13.2. Available Host Options
14. Advanced Network Configuration
14.1. Extra SIP Sockets
14.2. Extra SIP and RTP Sockets
15. Security and Maintenance
15.1. Sipwise SSH access to sip:provider PRO
15.2. Firewalling
15.3. Password management
15.4. SSL certificates.
15.5. Securing your sip:provider PRO against SIP attacks
15.5.1. Denial of Service
15.5.2. Bruteforcing SIP credentials
15.6. Backup and recovery
15.6.1. Backup
15.6.2. Recovery
15.7. Reset database
15.8. Synchronize database
15.9. System requirements and performance
15.10. Troubleshooting
15.10.1. Collecting call information from logs
15.10.2. Collecting SIP traces
16. Monitoring and Alerting
16.1. Internal Monitoring
16.2. Statistics Dashboard
16.3. External Monitoring Using SNMP
16.3.1. Overview and Initial Setup
16.3.2. Details
A. Cloud PBX
A.1. Configuring the Device Management
A.1.1. Setting up Device Models
A.1.2. Uploading Device Firmwares
A.1.3. Creating Device Configurations
A.1.4. Creating Device Profiles
A.2. Preparing PBX Rewrite Rules
A.2.1. Inbound Rewrite Rules for Caller
A.2.2. Inbound Rewrite Rules for Callee
A.2.3. Outbound Rewrite Rules for Caller
A.3. Creating Customers and Pilot Subscribers
A.3.1. Creating a PBX Customer
A.3.2. Creating a PBX Pilot Subscriber
A.4. Managing a Customer PBX
A.4.1. Creating more Subscribers
A.4.2. Assigning Subscribers to Devices
A.4.2.1. Synchronizing a PBX Device for initial Usage
A.4.3. Configuring Sound Sets for the Customer PBX
A.4.3.1. Uploading a Music-on-Hold File
A.4.3.2. Uploading Auto-Attendant Sound Files
A.4.4. Configuring the Auto Attendant
A.4.4.1. Preparing the Sound Set
A.4.4.2. Configuring the Auto Attendant Slots
A.4.4.3. Activating the Auto Attendant
A.5. Device Auto-Provisioning Security
A.5.1. Server Certificate Authentication
A.5.2. Client Certificate Authentication
A.6. Device Bootstrap and Resync Workflows
A.6.1. Cisco SPA Device Bootstrap
A.6.1.1. Initial Bootstrapping
A.6.1.2. Subsequent Device Resyncs
A.6.2. Panasonic Device Bootstrap
A.6.2.1. Initial Bootstrapping
A.6.2.2. Factory Reset
A.6.2.3. Subsequent Device Resyncs
A.6.3. Yealink Device Bootstrap
A.6.3.1. Initial Bootstrapping
A.6.3.2. Factory Enable Yealink Auto-Provisioning
A.6.3.3. Subsequent Device Resyncs
A.7. List of available pre-configured devices
B. Sipwise Clients and Apps
B.1. sip:phone Mobile App
B.1.1. Zero Config Launcher
B.1.1.1. 3rd Party Sign-Up Form
B.1.1.2. 3rd Party Launch Handler
B.1.2. Mobile Push Notification
B.1.2.1. Architecture
B.1.2.2. Configuring the Push Daemon
C. NGCP configs overview
C.1. config.yml overview
C.1.1. asterisk
C.1.2. autoprov
C.1.3. backuptools
C.1.4. cdrexport
C.1.5. checktools
C.1.6. cleanuptools
C.1.7. database
C.1.8. faxserver
C.1.9. general
C.1.10. heartbeat
C.1.11. intercept
C.1.12. kamailio
C.1.13. mediator
C.1.14. nginx
C.1.15. ntp
C.1.16. ossbss
C.1.17. pbx (only with additional cloud PBX module installed)
C.1.18. prosody
C.1.19. pushd
C.1.20. qos
C.1.21. rate-o-mat
C.1.22. redis
C.1.23. reminder
C.1.24. rsyslog
C.1.25. rtpproxy
C.1.26. security
C.1.27. sems
C.1.28. sshd
C.1.29. voisniff
C.1.30. www_admin
