SUMMARY.md

Table of contents

PortSIP PBX

• What is PortSIP?
• The Advantages of PortSIP PBX vs. Other PBXs
• Cloud PBX Empowering Service Provider
• What is CPaaS? Communications Platform as a Service Explained
• UCaaS: Shaping the Future of Unified Communications
• PortSIP PBX Administration Guide
  • Overview
  • PortSIP PBX Features
  • PortSIP Security Features
  • Upgrading PortSIP PBX to New Versions
    • Upgrading to the Latest v22.x Release
    • Upgrading to the Latest v16.x Release
  • Summary of Changes
  • Before Started
  • Installation of the PortSIP PBX Beta Version
  • 1 Installation of the PortSIP PBX
  • 2 Configuring the PortSIP PBX
  • 3 Tenant Management
  • 4 Phone Device Management
    • Managing Phones
    • Auto Provisioning Security
    • Custom IP Phone Template
    • Bulk Importing Users and Auto Provisioning IP Phones
    • Zero Touch Provisioning Phones
    • Provision Phone Using PnP
    • PnP Auto Provisioning IP Phone Multicast Debug
    • Provision Phone Using RPS
    • Provision Phone Using DHCP Option 66
    • Provision Phone Using TFTP
    • Provisioning Cisco 79xx IP Phones
    • Provision Yealink DECT IP Phones
    • Provision SNOM DECT IP Phones
  • 5 User Management
    • Users
    • How to Configure the Endpoints?
    • User Groups
    • DND and Automatic Callback
    • Speed Dial 8
    • Speed Dial 100
  • 6 Transport Management
  • 7 Trunk Management
    • Configuring SIP Trunk
    • Handle Outbound Calls Through SIP Trunk
  • 8 Call Route Management
    • Configuring Inbound Rule
    • Configuring Outbound Rule
  • 9 Configuring SBC for WebRTC
  • 10 Configuring SBC for MS Teams
    • Architecture
    • Configuring Microsoft Teams
    • Configuring SBC and PBX
    • Configure an SBC for Multiple Tenants
  • 11 Deploy the SBC Cluster
  • 12 Configuring Virtual Receptionist
    • Managing Virtual Receptionist
    • Visual IVR Editor Guide
    • Direct Inward System Access (DISA)
  • 13 Configuring Ring Group
  • 14 Call Parking
    • PortSIP Call Parking Feature
    • Using Call Parking Feature
    • Using Enhanced Call Park on Fanvil IP Phones
    • Using Enhanced Call Park on Yealink IP Phones
    • Using Enhanced Call Park on Dinstar IP Phones
  • 15 Shared Voicemail
  • 16 Call Queue
    • Configuring Call Queue
    • Configuring Queue Callback
    • Agent States and Work Modes
    • Skills-Based Routing
    • Silent Monitoring
    • Wallboards
  • 17 Roles and Permissions
  • 18 E164 Number Processing
  • 19 Billing
  • 20 CDR and Call Recordings
    • CDR
    • Call Recordings
    • CDR Field Descriptions
  • 21 Call Reports
  • 22 Dealers
  • 23 Feature Access Codes
  • 24 Call Pickup
  • 25 Meetings
    • Joining a Meeting with the Invite Link
  • 26 Hot Desking
  • 27 STIR/SHAKEN
    • Configuring STIR/SHAKEN
  • 28 Digital Engagement Channels
    • SMS Channel
    • WhatsApp Channel
  • Office Hours and Holiday Schedule
    • Configuring Office Hours and Holiday Schedule
    • Routing Calls Based on Office Hours and Holidays
  • PBX and SIP Trunk using PortSIP SBC
  • Configuring Email Notifications
  • SIP Header Manipulation
  • Microsoft 365 Integration
  • Rebranding PortSIP PBX, SBC
  • System Service Extension Numbers
  • Certificates for TLS/HTTPS/WebRTC
    • Preparing TLS Certificates
    • Update Certificates
  • Backup and Restore: An Essential Guide
    • Backup and Restore PortSIP PBX
    • Backup and Restore PortSIP SBC
  • Storing Into AWS S3
  • Trace Server - A Better Way to Monitoring SIP Messages and QoS for PortSIP PBX
• Configuring SIP Trunks
  • QuestBlue SIP Trunk
    • Purchase a DID on QuestBlue Platform
    • Configuring QuestBlue IP Authentication Trunk
    • Configuring QuestBlue Register Authentication Trunk
    • Configuring Outbound & Inbound Calls
    • QuestBlue SMS Integration
  • Twilio SIP Trunk
    • Purchase a DID on the Twilio
    • Configuring Twilio Register Based Trunk
    • Configuring Twilio Interconnect Trunk
    • Configuring Outbound & Inbound Calls
    • Twilio SMS Integration
  • Telnyx SIP Trunk
    • Purchase a DID on Telnyx Platform
    • Configuring Telnyx IP Authentication Trunk
    • Configuring Telnyx Register Authentication Trunk
    • Configuring Outbound & Inbound Calls
    • Telnyx SMS Integration
  • Vonage SIP Trunk
    • Purchase a DID on Vonage Platform
    • Configuring Vonage IP Authentication Trunk
    • Configuring Vonage Register Authentication Trunk
    • Configuring Outbound & Inbound Calls
    • Vonage SMS Integration
  • VoIP.ms SIP Trunk
    • Purchase a DID on VoIP.ms
    • Configuring VoIP.ms Register Based Trunk
    • Configuring Outbound & Inbound Calls
    • VoIP.ms SMS Integration
  • Voxtelesys SIP Trunk
    • Purchase a DID on Voxtelesys Platform
    • Configuring Voxtelesys IP Authentication Trunk
    • Configuring Voxtelesys Register Authentication Trunk
    • Configuring Outbound & Inbound Calls
    • Voxtelesys SMS Integration
  • Wavix SIP Trunk
    • Purchase a DID on Wavix Platform
    • Configuring Wavix IP Authentication Trunk
    • Configuring Wavix Digest Trunk
    • Configuring Outbound & Inbound Calls
    • Wavix SMS Integration
  • Gamma SIP Trunk
• PBX Cluster
  • Topology
  • Preparing Cluster Servers
  • Configuring Cluster Servers
  • Managing Cluster
  • Configuring Cluster Servers for High Availability
• High Availability
  • High Availability for On-Premise
    • PortSIP PBX High Availability Architecture
    • High Availability Installations on Ubuntu
  • High Availability and Scalability on AWS
    • PortSIP PBX High Availability Architecture
    • High Availability Installations on AWS
    • Increase Size of EBS Volume
    • Scaling Servers on AWS for HA
• PortSIP SBC Administration Guide
  • Upgrading PortSIP SBC to New Versions
  • Summary of Changes
  • Overview
  • Before Started
  • 1 Installation of the PortSIP SBC
  • 2 Configure the PortSIP SBC
• PortSIP UCaaS
• FAQ
  • Troubleshooting Call Issues
  • What is the Multi-Tenant PBX?
  • Is the PortSIP PBX built on Asterisk, FreeSwitch?
  • Configuring the Endpoints with PortSIP PBX
  • What is the SBC?
  • What is the PBX? Features, Benefits
  • Simplifying Unified Communications with WebRTC and SIP
  • What File Format Is Required for PortSIP PBX Prompt?
  • What is Direct Inward Dialing (DID)?
  • What is the DID Pool?
  • What are IP Phones Work with PortSIP PBX?
  • Hardware Specifications
  • How to Adjust the REST API Rate Limit?
  • How to Activate License key?
  • SIP Status Code of Response
  • What is SIP ALG and Why You Need to Disable It?
  • Essential Factors for Choosing a Could PBX Solution
  • Migrate from legacy FCM APIs to HTTP v1 for Android Push Notifications
  • PortSIP SDK License Agreement
  • PortSIP Software End-User License Agreement

DEVELOPING WITH PORTSIP

• Getting Started
• Calling APIs
  • User Manual for Windows
  • User Manual for iOS
  • User Manual for Android
  • User Manual for macOS
• REST APIs
  • Version 22.0
    • About
    • API reference
      • Info
      • Login
        • By microsoft
      • Logout
      • Network
      • Sbc
        • Token
          • Destroy
      • Im
        • Token
          • Destroy
      • Dealers
        • Password
        • Destroy
      • Mobile push
        • Destroy
      • Ip filters
        • Destroy
        • Export
      • Transports
        • Destroy
        • Status
      • Tenants
        • Switch
        • Dealers
          • Destroy
        • Destroy
      • Tenant
        • Status
        • Notification
        • Password policy
        • Billing
        • Balance
        • Custom headers
      • Conference servers
        • Status
        • Destroy
      • Media servers
        • Status
        • Destroy
      • License
      • Key
      • Brand
      • Dealer
        • Status
        • Username
        • Password
      • Roles
        • Destroy
      • User
        • Password
        • Extension password
        • Profile
        • Status
        • Presence
        • Balance
        • Greetings
          • Enable
          • Disable
          • Destroy
        • Phones
          • Destroy
        • Cdrs
          • Sync tokens
            • Diff
        • Recordings
          • Destroy
        • Speed dial 8
          • Destroy
        • Speed dial 100
          • Destroy
        • Meetings
          • Destroy
          • Mute
          • Unmute
          • Lock
          • Unlock
          • Start
          • Stop
          • Start recording
          • Stop recording
          • Participants
            • Layout
            • Invite
            • Mute
            • Unmute
            • Chairman
            • Position
            • Destroy
        • Holidays
          • Destroy
        • Global holidays
        • Contacts
          • Favorite
          • Unfavorite
          • Destroy
          • Sync tokens
            • Diff
        • Call queues
          • Agent
        • Outbound caller ids
        • Ring groups
        • Business contacts
          • Favorite
          • Unfavorite
          • Sync tokens
            • Diff
        • Extension contacts
          • Favorite
          • Unfavorite
          • Sync tokens
            • Diff
      • Users
        • Profile
        • Password
        • Extension password
        • Role
        • Ms365 binding
          • Destroy
        • Destroy
        • Status
          • Destroy status
        • Balance
        • Greetings
          • Enable
          • Disable
          • Destroy
        • Phones
          • Destroy
        • Holidays
          • Destroy
        • Global holidays
        • Call queues
          • Agent
      • Extension numbers
      • Groups
        • Destroy
        • Members
          • Destroy
      • Voicemails
        • Set read
        • Set unread
        • Destroy
      • Recordings
        • Destroy
      • Call queue servers
        • Status
        • Destroy
      • Call queues
        • Status
        • Destroy
        • Waiting
          • Pickup
        • Agents
      • Exclusive numbers
        • Destroy
        • Call queues
          • Agents
          • Destroy
        • Export
      • Vip numbers
        • Destroy
        • Export
      • Call queue blacklisted numbers
        • Destroy
        • Export
      • Call queue blacklist prompts
      • Sessions
        • Directly
        • Hold
        • Unhold
        • Refer
        • Attended refer
        • Destroy
      • Conference rooms
        • Destroy
        • Status
        • Mute
        • Unmute
        • Lock
        • Unlock
        • Start recording
        • Stop recording
        • Participants
          • Layout
          • Invite
          • Mute
          • Unmute
          • Chairman
          • Position
          • Destroy
        • Recordings
          • Destroy
          • Set read
          • Set unread
      • Contacts
        • Destroy
        • Export
      • Emergency numbers
        • Destroy
      • Files
        • Destroy
      • Blobs
        • Uploads
          • Append
          • Complete
          • Status
          • Destroy
      • Inbound rules
        • Destroy
        • Export
      • Moh server
        • Musics
          • Destroy
      • Monitor
      • Monitor groups
        • Destroy
        • Members
          • Destroy
        • Managers
          • Destroy
      • Call park
      • Call park groups
        • Destroy
        • Members
          • Destroy
      • Call pickup groups
        • Destroy
        • Members
      • Voicemail
      • Acb
      • Outbound rules
        • Destroy
        • Export
        • Applied groups
          • Destroy
      • Phone models
      • Phones
        • Reprovision
        • Assignee
        • Reboot
        • Reject
      • Dect phone models
      • Dect phones
        • Destroy
        • Members
      • Providers
        • Status
        • Destroy
        • Export
        • Assignees
          • Destroy
      • Ring groups
        • Agents
        • Destroy
      • Shared voicemails
        • Destroy
        • Voicemails
          • Set read
          • Set unread
          • Destroy
        • Greetings
          • Enable
          • Disable
          • Destroy
      • Holidays
        • Destroy
      • Allowed country codes
      • Disallowed codes
        • Destroy
        • Export
      • Blacklisted numbers
        • Destroy
        • Export
      • Call rates
        • Destroy
        • Export
      • Ivr servers
        • Status
        • Destroy
      • Ivrs
        • Status
        • Destroy
        • Action urls
          • Destroy
      • Hotdesking
        • Status
        • Logout
        • Destroy
      • Sms
        • Destroy
      • Whatsapp
        • Destroy
      • Cdrs
      • Call reports
        • Destroy
      • Completed call reports
        • Destroy
      • Feature access codes
      • Default email templates
      • Custom email templates
      • Audit logs
      • Event logs
      • Test email
      • Ms365
        • Certificate
        • Users
      • Admin
        • Status
        • Username
        • Password
        • Settings
        • Notification
      • Templates
        • Phones
          • Destroy
  • Authentication
  • Accessing CDRs and Recordings
• Call Control APIs
• Messaging APIs
  • Protocol
  • API Examples
• WSI: Pub/Sub
• Webhook Events
  • Registering a Webhook
  • Receiving Events via a Webhook
  • Event Reference
• Mobile Push Notifications
  • How Do Push Notifications Work with PortSIP PBX?
  • Integrating the Push Notifications in Native iOS APP
  • Integrating the Push Notifications in Android APP

PBX v12.x (EOL)

• PortSIP PBX v12.x is EOL
• High Availability
  • PortSIP PBX High Availability
  • UCaaS High Availability
  • Deploy the PortSIP PBX HA on AWS
  • Deploy PortSIP PBX HA for CentOS
  • Deploy PortSIP PBX HA for Ubuntu
  • Migrate the HA data
• Push Notifications
  • How do push notifications work with PortSIP PBX?
  • Implement the PUSH notifications in Xamarin iOS APP with PortSIP PBX 12.x
  • Implement the PUSH notifications in native iOS APP with PortSIP PBX 12.x
  • Implement PUSH notifications in Android APP with PortSIP PBX 12.x
  • Implement PUSH notifications in Xamarin Android APP with PortSIP PBX 12.x
• Tutorials
  • REST API Examples
  • Trace server - A Better Way to Debug PortSIP UC
  • Setup SSL Certificates for HTTPS/WebRTC
  • Going Real-Time with PortSIP PBX Pub/Sub
  • Upgrade PortSIP PBX for offline
  • PortSIP UC Architecture
  • PortSIP PBX Features
  • PortSIP Security Feature
  • Hardware Specifications
  • Setup PortSIP PBX for Linux
  • Upgrade PortSIP PBX
  • Upgrade PortSIP PBX v12.x to the v12.8.7
  • Add Extended Media Server
  • Store the recording files to AWS S3
  • Configure Notifications for Kubernetes
  • Rebranding PortSIP PBX