The sip:carrier Handbook mr4.5.13

The sip:carrier Handbook mr4.5.13

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 Configuration Scenario

3.1. Creating a Customer

3.2. Creating a Subscriber

3.3. Domain Preferences

3.4. Subscriber Preferences

3.5. Creating Peerings

3.5.1. Creating Peering Groups
3.5.2. Creating Peering Servers
3.5.3. Authenticating and Registering against Peering Servers

3.6. Configuring Rewrite Rule Sets

3.6.1. Inbound Rewrite Rules for Caller
3.6.2. Inbound Rewrite Rules for Callee
3.6.3. Outbound Rewrite Rules for Caller
3.6.4. Outbound Rewrite Rules for Callee
3.6.5. Emergency Number Handling
3.6.6. Assigning Rewrite Rule Sets to Domains and Subscribers
3.6.7. Creating Dialplans for Peering Servers
3.6.8. Call Routing Verification

4. Features

4.1. Managing System Administrators

4.1.1. Configuring Administrators
4.1.2. Access Rights of Administrators

4.2. Access Control for SIP Calls

4.2.1. Block Lists
4.2.2. NCOS Levels
4.2.3. IP Address Restriction

4.3. Call Forwarding and Call Hunting

4.3.1. Setting a simple Call Forward
4.3.2. Advanced Call Hunting

4.4. Local Number Porting

4.4.1. Local LNP Database
4.4.2. External LNP via LNP API

4.5. Emergency Mapping

4.5.1. Emergency Mapping Description
4.5.2. Emergency Mapping Configuration

4.6. Header Manipulation

4.6.1. Header Filtering
4.6.2. Codec Filtering
4.6.3. Enable History and Diversion Headers

4.7. SIP Trunking with SIPconnect

4.7.1. User provisioning
4.7.2. Inbound calls routing
4.7.3. Number manipulations
4.7.4. Registration

4.8. Trusted Subscribers

4.9. Fax Server

4.9.1. Fax2Mail Architecture
4.9.2. Sendfax and Mail2Fax Architecture

4.10. Voicemail System

4.10.1. Accessing the IVR Menu
4.10.2. IVR Menu Structure
4.10.3. Type Of Messages
4.10.4. Folders
4.10.5. Flowcharts with Voice Prompts

4.11. Configuring Subscriber IVR Language

4.12. Sound Sets

4.12.1. Configuring Early Reject Sound Sets

4.13. Conference System

4.13.1. Configuring Call Forward to Conference
4.13.2. Configuring Conference Sound Sets
4.13.3. Joining the Conference
4.13.4. Conference Flowchart with Voice Prompts

4.14. Malicious Call Identification (MCID)

4.14.1. Setup
4.14.2. Usage
4.14.3. Advanced configuration

4.15. Subscriber Profiles

4.15.1. Subscriber Profile Sets

4.16. SIP Loop Detection

4.17. Call-Through Application

4.17.1. Administrative Configuration
4.17.2. Call Flow

4.18. Calling Card Application

4.18.1. Administrative Configuration
4.18.2. Call Flow

4.19. Invoices and Invoice Templates

4.19.1. Invoices Management
4.19.2. Invoice Templates
4.19.3. Invoices Generation

4.20. Email Reports and Notifications

4.20.1. Email events
4.20.2. Initial template values and template variables
4.20.3. Password reset email template
4.20.4. New subscriber notification email template
4.20.5. Invoice email template
4.20.6. Email templates management

4.21. The Vertical Service Code Interface

4.21.1. Vertical Service Codes for PBX customers
4.21.2. Configuration of Vertical Service Codes
4.21.3. Voice Prompts for Vertical Service Code Configuration

4.22. Handling WebRTC Clients

4.23. XMPP and Instant Messaging

5. Customer Self-Care Interface and Menus

5.1. The Customer Self-Care Web Interface

5.1.1. Login Procedure
5.1.2. Site Customization

5.2. The Voicemail Menu

6. Billing Configuration

6.1. Billing Profiles

6.1.1. Creating Billing Profiles
6.1.2. Creating Billing Fees
6.1.3. Creating Off-Peak Times

6.2. Prepaid Accounting

6.3. Fraud Detection and Locking

6.3.1. Fraud Lock Levels

6.4. Billing Customizations

6.4.1. Billing Networks
6.4.2. Profile Mapping Schedule
6.4.3. Profile Packages
6.4.4. Vouchers
6.4.5. Top-up
6.4.6. Balance Overviews
6.4.7. Usage Examples

6.5. Notes on Billing and Call Rating

6.6. Billing Data Export

6.6.1. Glossary of Terms
6.6.2. File Name Format
6.6.3. File Format
6.6.4. File Transfer

7. Provisioning REST API Interface

7.1. API Workflows for Customer and Subscriber Management

8. Configuration Framework

8.1. Configuration templates

8.1.1. .tt2 and .customtt.tt2 files
8.1.2. .prebuild and .postbuild files
8.1.3. .services files

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

8.3. ngcpcfg and its command line options

8.3.1. apply
8.3.2. build
8.3.3. commit
8.3.4. decrypt
8.3.5. diff
8.3.6. encrypt
8.3.7. help
8.3.8. initialise
8.3.9. pull
8.3.10. push
8.3.11. services
8.3.12. status

9. Network Configuration

9.1. General Structure

9.1.1. Available Host Options
9.1.2. Interface Parameters

9.2. Advanced Network Configuration

9.2.1. Extra SIP Sockets
9.2.2. Extra SIP and RTP Sockets
9.2.3. Cluster Sets

10. Software Upgrade

10.1. Release Notes

10.2. Overview

10.3. Planning a Software Upgrade

10.4. Preparing for a Software Upgrade

10.4.1. Log into the inactive management server (web01a/db01a).
10.4.2. Log into all servers.

10.5. Upgrade sip:carrier from previous mr4.4/mr4.5 versions to mr4.5.13 LTS version

10.5.1. Upgrading the first inactive management node "A" ONLY (web01a/db01a)
10.5.2. Upgrading inactive database node "A" (db*a)
10.5.3. Upgrading other inactive nodes "A" (lb*a/prx*a)
10.5.4. Promote ALL inactive nodes "A" to active.
10.5.5. Upgrading ALL inactive nodes "B" (web*b/db*b/lb*b/prx*b)

10.6. Post-upgrade Checks

10.7. Upgrade sip:carrier from previous mr3.8 LTS version to mr4.5.13 LTS version

11. Backup, Recovery and Database Maintenance

11.1. sip:carrier Backup

11.1.1. What data to back up
11.1.2. The built-in backup solution

11.2. Recovery

11.3. Reset Database

11.4. Accounting Data (CDR) Cleanup

11.4.1. Cleanuptools Configuration
11.4.2. Accounting Database Cleanup
11.4.3. Exported CDR Cleanup

12. Platform Security, Performance and Troubleshooting

12.1. Sipwise SSH access to sip:carrier

12.2. Firewalling

12.3. Password management

12.4. SSL certificates.

12.5. Securing your sip:carrier against SIP attacks

12.5.1. Denial of Service
12.5.2. Bruteforcing SIP credentials

12.6. Topology Hiding

12.6.1. Introduction to Topology Hiding on NGCP
12.6.2. Configuration of Topology Hiding
12.6.3. Considerations for Topology Hiding

12.7. System Requirements and Performance

12.8. Troubleshooting

12.8.1. Collecting call information from logs
12.8.2. Collecting SIP traces

13. Monitoring and Alerting

13.1. Internal Monitoring

13.2. Statistics Dashboard

13.3. External Monitoring Using SNMP

13.3.1. Overview and Initial Setup
13.3.2. Details

14. Extensions and Additional Modules

14.1. Cloud PBX

14.1.1. Configuring the Device Management
14.1.2. Preparing PBX Rewrite Rules
14.1.3. Creating Customers and Pilot Subscribers
14.1.4. Creating Regular PBX Subscribers
14.1.5. Assigning Subscribers to Devices
14.1.6. Configuring Sound Sets for the Customer PBX
14.1.7. Configuring Auto Attendant
14.1.8. Configuring Call Queues
14.1.9. Device Auto-Provisioning Security
14.1.10. Device Bootstrap and Resync Workflows
14.1.11. Device Provisioning and Deployment Workflows
14.1.12. List of available pre-configured devices
14.1.13. Phone features

14.2. Sipwise sip:phone App (SIP client)

14.2.1. Zero Config Launcher
14.2.2. Mobile Push Notification

14.3. Lawful Interception

14.3.1. Introduction
14.3.2. Architecture and Configuration of LI Service
14.3.3. X1, X2 and X3 Interface Specification

A. Basic Call Flows

A.1. General Call Setup
A.2. Endpoint Registration
A.3. Basic Call
A.4. Session Keep-Alive
A.5. Voicebox Calls

B. NGCP configs overview

B.1. config.yml Overview

B.2. constants.yml Overview

B.3. network.yml Overview

C. NGCP-Faxserver Configuration

C.1. Faxserver Components

C.2. Enabling Faxserver

C.3. Fax Templates Configuration

C.4. Fax Services Configuration per Subscriber

C.5. Fax2Mail and SendFax Settings

C.6. Mail2Fax Settings

C.7. Sending Fax from Web Panel

C.8. Faxserver Mail2Fax Configuration

C.9. Sending Fax Using E-mail Clients

C.10. Managing Faxes via the REST API

C.10.1. Configuring Fax Settings

C.10.1.1. Retrieving Fax Settings
C.10.1.2. Updating Fax Settings

C.10.2. Sending a Fax

C.10.3. Receiving a Fax

C.10.4. Configuring Mail2Fax Settings

C.10.4.1. Retrieving Mail2Fax Configuration
C.10.4.2. Updating Mail2Fax Configuration

C.10.5. Using Advanced Faxserver and Mail2Fax Settings via the REST API

C.11. Troubleshooting

C.11.1. Session ID (SID)
C.11.2. Fax Storage Location

D. RTC:engine

D.1. Overview

D.2. RTC:engine enabling

D.2.1. Enabling services via CLI

D.2.2. Enabling via Panel for resellers and subscribers

D.2.3. Create RTC:engine session

D.2.3.1. Create sessions
D.2.3.2. Receive sessions

D.3. RTC:engine protocol details

D.3.1. Terminology

D.3.1.1. Connector
D.3.1.2. Router
D.3.1.3. User
D.3.1.4. App
D.3.1.5. Network
D.3.1.6. Session
D.3.1.7. Account
D.3.1.8. Browser SDK

D.3.2. Messages

D.3.2.1. Fields
D.3.2.2. method
D.3.2.3. from
D.3.2.4. to
D.3.2.5. session
D.3.2.6. body

D.3.3. Account

D.3.3.1. Flow
D.3.3.2. Messages
D.3.3.3. account.connect
D.3.3.4. account.state
D.3.3.5. State reasons
D.3.3.6. States

D.3.4. Call

D.3.4.1. Flow
D.3.4.2. call.start
D.3.4.3. Body properties
D.3.4.4. id
D.3.4.5. gcid
D.3.4.6. account
D.3.4.7. replace
D.3.4.8. trickle
D.3.4.9. target
D.3.4.10. sdp
D.3.4.11. call.alive
D.3.4.12. call.ringing
D.3.4.13. call.accept
D.3.4.14. call.ack.accept
D.3.4.15. call.candidate
D.3.4.16. call.fullsdp
D.3.4.17. call.change….
D.3.4.18. call.change.lock.reset
D.3.4.19. call.change.lock
D.3.4.20. call.change.lock.ok
D.3.4.21. call.change.offer
D.3.4.22. call.change.answer
D.3.4.23. call.dtmf
D.3.4.24. call.end
D.3.4.25. call.ack.end

D.3.5. Session

D.3.5.1. Flow
D.3.5.2. Messages
D.3.5.3. session.open
D.3.5.4. session.validated
D.3.5.5. Reason types

E. NGCP Internals

E.1. Pending reboot marker

E.2. Redis id constants

E.2.1. Redis monitoring keys

E.3. Enum preferences

Next