The sip:carrier Handbook mr5.5.12

Table of Contents

1. Introduction
1.1. About this Handbook
1.2. What is the sip:carrier?
1.3. The Advantages of the sip:carrier
1.4. Who is the sip:carrier for?
1.5. Getting Help
1.5.1. Phone Support
1.5.2. Ticket System
2. System Architecture
2.1. Hardware Architecture
2.2. Component Architecture
2.2.1. Provisioning
2.2.2. Signaling and Media Relay
2.2.3. Scaling beyond one Hardware Chassis
2.2.4. Architecture for central core and local satellites
3. VoIP Service Administration Concepts
3.1. Contacts
3.2. Resellers
3.3. SIP Domain
3.3.1. Additional SIP Domains
3.4. Contracts
3.5. Customers
3.5.1. Residential and SOHO customers
3.5.2. Business customers with the Cloud PBX service
3.5.3. SIP Trunking
3.5.4. Mobile subscribers
3.5.5. Pre-paid subscribers who use your calling cards
3.6. Subscribers
3.7. SIP Peerings
4. VoIP Service Configuration Scenario
4.1. Creating a SIP Domain
4.2. Creating a Customer
4.3. Creating a Subscriber
4.4. Domain Preferences
4.5. Subscriber Preferences
4.6. Creating Peerings
4.6.1. Creating Peering Groups
4.6.2. Creating Peering Servers
4.6.3. Authenticating and Registering against Peering Servers
4.7. Configuring Rewrite Rule Sets
4.7.1. Inbound Rewrite Rules for Caller
4.7.2. Inbound Rewrite Rules for Callee
4.7.3. Outbound Rewrite Rules for Caller
4.7.4. Outbound Rewrite Rules for Callee
4.7.5. Emergency Number Handling
4.7.6. Assigning Rewrite Rule Sets to Domains and Subscribers
4.7.7. Creating Dialplans for Peering Servers
4.7.8. Call Routing Verification
5. Features
5.1. Managing System Administrators
5.1.1. Configuring Administrators
5.1.2. Access Rights of Administrators
5.2. Access Control for SIP Calls
5.2.1. Block Lists
5.2.2. NCOS Levels
5.2.3. IP Address Restriction
5.3. Call Forwarding and Call Hunting
5.3.1. Setting a simple Call Forward
5.3.2. Advanced Call Hunting
5.4. Local Number Porting
5.4.1. Local LNP Database
5.4.2. External LNP via LNP API
5.5. Emergency Mapping
5.5.1. Emergency Mapping Description
5.5.2. Emergency Mapping Configuration
5.6. Emergency Priorization
5.6.1. Call-Flow with Emergency Mode Enabled
5.6.2. Configuration of Emergency Mode
5.6.3. Activating Emergency Mode
5.7. Header Manipulation
5.7.1. Header Filtering
5.7.2. Codec Filtering
5.7.3. Enable History and Diversion Headers
5.8. SIP Trunking with SIPconnect
5.8.1. User provisioning
5.8.2. Inbound calls routing
5.8.3. Number manipulations
5.8.4. Registration
5.9. Trusted Subscribers
5.10. Peer Probing
5.10.1. Introduction to Peer Probing Feature
5.10.2. Configuration of Peer Probing
5.10.3. Monitoring of Peer Probing
5.10.4. Further Details for Advanced Users
5.11. Fax Server
5.11.1. Fax2Mail Architecture
5.11.2. Sendfax and Mail2Fax Architecture
5.12. Voicemail System
5.12.1. Accessing the IVR Menu
5.12.2. IVR Menu Structure
5.12.3. Type Of Messages
5.12.4. Folders
5.12.5. Voicemail Languages Configuration
5.12.6. Flowcharts with Voice Prompts
5.13. Configuring Subscriber IVR Language
5.14. Sound Sets
5.14.1. Configuring Early Reject Sound Sets
5.15. Conference System
5.15.1. Configuring Call Forward to Conference
5.15.2. Configuring Conference Sound Sets
5.15.3. Joining the Conference
5.15.4. Conference Flowchart with Voice Prompts
5.16. Malicious Call Identification (MCID)
5.16.1. Setup
5.16.2. Usage
5.16.3. Advanced configuration
5.17. Subscriber Profiles
5.17.1. Subscriber Profile Sets
5.18. SIP Loop Detection
5.19. Call-Through Application
5.19.1. Administrative Configuration
5.19.2. Call Flow
5.20. Calling Card Application
5.20.1. Administrative Configuration
5.20.2. Call Flow
5.21. Invoices and Invoice Templates
5.21.1. Invoices Management
5.21.2. Invoice Templates
5.21.3. Invoices Generation
5.22. Email Reports and Notifications
5.22.1. Email events
5.22.2. Initial template values and template variables
5.22.3. Password reset email template
5.22.4. New subscriber notification email template
5.22.5. Invoice email template
5.22.6. Email templates management
5.23. The Vertical Service Code Interface
5.23.1. Vertical Service Codes for PBX customers
5.23.2. Configuration of Vertical Service Codes
5.23.3. Voice Prompts for Vertical Service Code Configuration
5.24. Handling WebRTC Clients
5.25. XMPP and Instant Messaging
5.26. Call Recording
5.26.1. Introduction to Call Recording Function
5.26.2. Information on Files and Directories
5.26.3. Configuration
5.26.4. REST API
5.27. SMS (Short Message Service) on Sipwise NGCP
5.27.1. Configuration
5.27.2. Monitoring, troubleshooting
5.27.3. REST API
6. Customer Self-Care Interface and Menus
6.1. The Customer Self-Care Web Interface
6.1.1. Login Procedure
6.1.2. Site Customization
6.2. The Voicemail Menu
7. Billing Configuration
7.1. Billing Profiles
7.1.1. Creating Billing Profiles
7.1.2. Creating Billing Fees
7.1.3. Creating Off-Peak Times
7.2. Prepaid Accounting
7.3. Fraud Detection and Locking
7.3.1. Fraud Lock Levels
7.4. Billing Customizations
7.4.1. Billing Networks
7.4.2. Profile Mapping Schedule
7.4.3. Profile Packages
7.4.4. Vouchers
7.4.5. Top-up
7.4.6. Balance Overviews
7.4.7. Usage Examples
7.5. Notes on Billing and Call Rating
7.6. Billing Data Export
7.6.1. Glossary of Terms
7.6.2. File Name Format
7.6.3. File Format
7.6.4. File Transfer
8. Provisioning REST API Interface
8.1. API Workflows for Customer and Subscriber Management
8.2. API performance considerations
9. Configuration Framework
9.1. Configuration templates
9.1.1. .tt2 and .customtt.tt2 files
9.1.2. .prebuild and .postbuild files
9.1.3. .services files
9.2. config.yml, constants.yml and network.yml files
9.3. ngcpcfg and its command line options
9.3.1. apply
9.3.2. build
9.3.3. commit
9.3.4. decrypt
9.3.5. diff
9.3.6. encrypt
9.3.7. help
9.3.8. initialise
9.3.9. pull
9.3.10. push
9.3.11. services
9.3.12. status
10. Network Configuration
10.1. General Structure
10.1.1. Available Host Options
10.1.2. Interface Parameters
10.2. Advanced Network Configuration
10.2.1. Extra SIP Sockets
10.2.2. Extra SIP and RTP Sockets
10.2.3. Cluster Sets
11. Licenses
11.1. What is Subject to Licensing?
11.2. How Licensing Works
11.3. How to Configure Licenses
11.4. How to Monitor License Client
12. Software Upgrade
12.1. Release Notes
12.2. Overview
12.3. Planning a software upgrade
12.4. Preparing the software upgrade
12.4.1. Log into the standby management server (web01a/db01a).
12.4.2. Log into the remaining servers
12.5. Upgrading the sip:carrier
12.5.1. Preparing for maintenance mode
12.5.2. ngcp-upgrade options
12.5.3. Upgrading ONLY the first standby management node "A" (web01a/db01a)
12.5.4. Upgrading the standby database node "A" (db*a)
12.5.5. Upgrading other standby nodes "A" (lb*a/prx*a)
12.5.6. Promote ALL standby nodes "A" to active.
12.5.7. Upgrading ALL standby nodes "B" (web*b/db*b/lb*b/prx*b)
12.6. Post-upgrade steps
12.6.1. Disabling maintenance mode
12.6.2. Post-upgrade checks
13. Backup, Recovery and Database Maintenance
13.1. sip:carrier Backup
13.1.1. What data to back up
13.1.2. The built-in backup solution
13.2. Recovery
13.3. Reset Database
13.4. Accounting Data (CDR) Cleanup
13.4.1. Cleanuptools Configuration
13.4.2. Accounting Database Cleanup
13.4.3. Exported CDR Cleanup
14. Platform Security, Performance and Troubleshooting
14.1. Sipwise SSH access to sip:carrier
14.2. Firewalling
14.2.1. Firewall framework
14.2.2. NGCP firewall configuration
14.2.3. IPv4 System rules
14.2.4. Custom rules
14.2.5. Example firewall configuration section
14.3. Password management
14.3.1. The "root" account
14.3.2. The "administrator" account
14.3.3. The "cdrexport" account
14.3.4. The MySQL "root" user
14.3.5. The "ngcpsoap" account
14.4. SSL certificates.
14.5. Securing your sip:carrier against SIP attacks
14.5.1. Denial of Service
14.5.2. Bruteforcing SIP credentials
14.6. Topology Hiding
14.6.1. Introduction to Topology Hiding on NGCP
14.6.2. Configuration of Topology Hiding
14.6.3. Considerations for Topology Hiding
14.7. System Requirements and Performance
14.8. Troubleshooting
14.8.1. Collecting call information from logs
14.8.2. Collecting SIP traces
15. Monitoring and Alerting
15.1. Internal Monitoring
15.1.1. Process monitoring via monit
15.1.2. System monitoring via Telegraf
15.1.3. NGCP-specific monitoring via ngcp-witnessd
15.1.4. Monitoring data in InfluxDB
15.2. Statistics Dashboard
15.3. External Monitoring Using SNMP
15.3.1. Overview and Initial Setup
15.3.2. Details
16. Extensions and Additional Modules
16.1. Cloud PBX
16.1.1. PBX Device Provisioning
16.1.2. Preparing PBX Rewrite Rules
16.1.3. Creating Customers and Pilot Subscribers
16.1.4. Creating Regular PBX Subscribers
16.1.5. Assigning Subscribers to a Device
16.1.6. Configuring Sound Sets for the Customer PBX
16.1.7. Auto-Attendant Function
16.1.8. Configuring Call Queues
16.1.9. Device Auto-Provisioning Security
16.1.10. Device Bootstrap and Resync Workflows
16.1.11. Device Provisioning and Deployment Workflows
16.1.12. List of available pre-configured devices
16.1.13. Phone features
16.1.14. Shared line appearance
16.2. Sipwise sip:phone App (SIP client)
16.2.1. Zero Config Launcher
16.2.2. Mobile Push Notification
16.3. Lawful Interception
16.3.1. Introduction
16.3.2. Architecture and Configuration of LI Service
16.3.3. X1, X2 and X3 Interface Specification
16.4. 3rd Party Call Control
16.4.1. Introduction
16.4.2. Details of Call Processing with PCC
16.4.3. Voicemail Notification
16.4.4. Incoming Short Message Acceptance
16.4.5. Configuration of PCC
16.4.6. Troubleshooting of PCC
A. Basic Call Flows
1. General Call Setup
2. Endpoint Registration
3. Basic Call
4. Session Keep-Alive
5. Voicebox Calls
B. NGCP configs overview
1. config.yml Overview
1.1. apps
1.2. asterisk
1.3. autoprov
1.4. backuptools
1.5. bootenv
1.6. cdrexport
1.7. checktools
1.8. cleanuptools
1.9. cluster_sets
1.10. database
1.11. faxserver
1.12. general
1.13. haproxy
1.14. heartbeat
1.15. intercept
1.16. kamailio
1.17. lnpd
1.18. mediator
1.19. modules
1.20. nginx
1.21. ntp
1.22. ossbss
1.23. pbx (only with additional cloud PBX module installed)
1.24. prosody
1.25. pushd
1.26. qos
1.27. rate-o-mat
1.28. redis
1.29. reminder
1.30. rsyslog
1.31. rtpproxy
1.32. security
1.33. sems
1.34. sms
1.35. snmpagent
1.36. sshd
1.37. sudo
1.38. voisniff
1.39. www_admin
2. constants.yml Overview
3. network.yml Overview
C. NGCP-Faxserver Configuration
1. Faxserver Components
2. Enabling Faxserver
3. Fax Templates Configuration
4. Fax Services Configuration per Subscriber
5. Fax2Mail and SendFax Settings
6. Mail2Fax Settings
7. Sending Fax from Web Panel
8. Faxserver Mail2Fax Configuration
9. Sending Fax Using E-mail Clients
10. Managing Faxes via the REST API
10.1. Configuring Fax Settings
10.1.1. Retrieving Fax Settings
10.1.2. Updating Fax Settings
10.2. Sending a Fax
10.3. Receiving a Fax
10.4. Configuring Mail2Fax Settings
10.4.1. Retrieving Mail2Fax Configuration
10.4.2. Updating Mail2Fax Configuration
10.5. Using Advanced Faxserver and Mail2Fax Settings via the REST API
11. Troubleshooting
11.1. Session ID (SID)
11.2. Fax Storage Location
12. Adjusting the PBX Devices Configuration
12.1. Setting up Device Models
12.2. Uploading Device Firmwares
12.3. Creating Device Configurations
12.4. Creating Device Profiles
D. RTC:engine
1. Overview
2. RTC:engine enabling
2.1. Enabling services via CLI
2.2. Enabling via Panel for resellers and subscribers
2.3. Create RTC:engine session
2.3.1. Create sessions
2.3.2. Receive sessions
3. RTC:engine protocol details
3.1. Terminology
3.1.1. Connector
3.1.2. Router
3.1.3. User
3.1.4. App
3.1.5. Network
3.1.6. Session
3.1.7. Account
3.1.8. Browser SDK
3.2. Messages
3.2.1. Fields
3.2.2. method
3.2.3. from
3.2.4. to
3.2.5. session
3.2.6. body
3.3. Account
3.3.1. Flow
3.3.2. Messages
3.3.3. account.connect
3.3.4. account.state
3.3.5. State reasons
3.3.6. States
3.4. Call
3.4.1. Flow
3.4.2. call.start
3.4.3. Body properties
3.4.4. id
3.4.5. gcid
3.4.6. account
3.4.7. replace
3.4.8. trickle
3.4.9. target
3.4.10. sdp
3.4.11. call.alive
3.4.12. call.ringing
3.4.13. call.accept
3.4.14. call.ack.accept
3.4.15. call.candidate
3.4.16. call.fullsdp
3.4.17. call.change….
3.4.18. call.change.lock.reset
3.4.19. call.change.lock
3.4.20. call.change.lock.ok
3.4.21. call.change.offer
3.4.22. call.change.answer
3.4.23. call.dtmf
3.4.24. call.end
3.4.25. call.ack.end
3.5. Session
3.5.1. Flow
3.5.2. Messages
3.5.4. session.validated
3.5.5. Reason types
E. comx-fileshare-service
1. Overview
2. Configuration and Usage
2.1. Change authentication method
2.2. Database Structure
3. Activation of Filesharing Service on NGCP
4. Message Sequence Chart
4.1. Simple Message Sequence
4.2. Detailed Message Sequence
5. API of Filesharing Service
5.1. HTTP Authentication
5.2. Upload and Download with Simple Identification
5.3. Upload and Download with Session Identification
5.4. Curl Example for Simple Upload Request
5.5. Upload Parameters
5.5.1. file
5.5.2. user
5.5.3. TTL
5.6. Number of Possible Downloads
F. NGCP Internals
1. Pending reboot marker
2. Redis id constants
2.1. InfluxDB monitoring keys
3. Enum preferences

1. Introduction

1.1. About this Handbook

This handbook describes the architecture and the operational steps to install, operate and modify the Sipwise sip:carrier.

In various chapters, it describes the system architecture, the installation and upgrade procedures and the initial configuration steps to get your first users online. It then dives into advanced preference configurations such as rewrite rules, call blockings, call forwards, etc.

There is a description of the customer self-care interface, how to configure the billing system and how to provision the system via the provided APIs.

Finally, it describes the internal configuration framework, the network configuration and gives hints about tweaking the system for security and performance.

1.2. What is the sip:carrier?

The sip:carrier is a SIP based Open Source Class5 VoIP soft-switch platform providing rich telephony services. It offers a wide range of features to end users (call forwards, voicemail, conferencing, call blocking, click-to-dial, call-lists showing near-realtime accounting information, etc.), which can be configured by them using the customer-self-care web interface. For operators, it offers a fully web-based administrative panel, allowing them to configure users, peerings, billing profiles, etc., as well as viewing real-time statistics of the system. For tight integration into existing infrastructures, it provides a powerful REST API.

The sip:carrier comes pre-installed on six+ servers in one+ IBM Flex Chassis, see Section 2, “System Architecture”. Apart from your product specific configuration, there is no initial configuration or installation to be done to get started.

1.3. The Advantages of the sip:carrier

Opposed to other free VoIP software, the sip:carrier is not a single application, but a whole software platform, the Sipwise NGCP (Sipwise Next Generation Communication Platform), which is based on Debian GNU/Linux.

Using a highly modular design approach, the NGCP leverages popular open-source software like MySQL, NGINX, Kamailio, SEMS, Asterisk, etc. as its core building blocks. These blocks are glued together using optimized and proven configurations and workflows and are complemented by functionality developed by Sipwise to provide fully-featured and easy to operate VoIP services.

The installed applications are managed by the NGCP Configuration Framework, which makes it possible to change system parameters in a single place, so administrators don’t need to have any knowledge of the dozens of different configuration files of the different packages. This provides a very easy and bullet-proof way of operating, changing and tweaking the otherwise quite complex system.

Once configured, integrated web interfaces are provided for both end users and administrators to use the sip:carrier. By using the provided provisioning and billing APIs, it can be integrated tightly into existing OSS/BSS infrastructures to optimize workflows.

1.4. Who is the sip:carrier for?

The sip:carrier is specifically tailored to companies who want to provide fully-featured SIP-based VoIP service without having to go through the steep learning curve of SIP signalling, integrating the different building blocks to make them work together in a reasonable way. The sip:carrier is already deployed all around the world by all kinds of VoIP operators, using it as Class5 soft-switch, as Class4 termination platform or even as Session Border Controller with all kinds of access networks, like Cable, DSL, WiFi and Mobile networks.

1.5. Getting Help

1.5.1. Phone Support

Depending on your support contract, you are eligible to contact our Support Team by phone either in business hours or around the clock. Business hours refer to the UTC+1 time zone (Europe/Vienna). Please check your support contract to find out the type of support you’ve purchased.

Before calling our Support Team, please also open a ticket in our Ticket System and provide as much detail as you can for us to understand the problems, fix them and investigate the cause. Please provide the number of your newly created ticket when asked by our support personnel on the phone.

You can find phone numbers, Ticket System URL, and account information in your support contract. Please make this information available to the persons in your company maintaining the sip:carrier.

1.5.2. Ticket System

Depending on your support contract, you can create either a limited or an unlimited amount of support tickets on our Web-based Ticket System. Please provide as much information as possible when opening a ticket, especially the following:

  • WHAT is affected (e.g. the whole system is unreachable, or customers can’t register or place calls)
  • WHO is affected (e.g. all customers, only parts of it, and WHICH parts - only customers in a particular domain or customers with specific devices, etc.)
  • WHEN did the problem occur (time frames, or after the firmware of specific devices types have been updated, etc.)

Our Support Team will ask further questions via the Ticket System along the way of troubleshooting your issue. Please provide the information as soon as possible to solve your issue promptly.