VoIP Product Provisioning

TBS supports real time integration with 3rd party systems including provisioning of VoIP Platforms. This document provides an overview of this functionality.

Overview

Real time integration with 3rd party systems is accomplished in TBS using 1) Network Resources, 2) an Activity Queue and 3) Triggers. This document describes each of these system components and how they are used in TBS.

Network Resources - Network Resources are used in TBS to connect to and/or integrate with 3rd party systems. Any type of external API (Web Service) can be made into a TBS Network Resource. Some examples Network Resource types include:

  • VoIP Switches
  • 911 Providers
  • CNAM Providers
  • DID Providers / Carriers

The first API Integration in TBS is with the Netsapiens VoIP Platform. Many other integrations are planned for 2012.

The Network Resources Admin Tool allow users to manage connectivity to the Network Resources used by their organization. The Network Resources themselves are coded in the TBS System based on the underlying systems API.

There is also a Network Resources Defaults Admin Tool that allows users to manage default values to be sent to the Network Resource. This is used for global configuration values that will be sent to the resource with every call.

Activity Queue - The Activity Queue is used as the bridge between TBS and the 3rd party system. When a TBS Trigger is fired, a record is added to the Activity Queue. A TBS System process monitors the queue for any new records and processes them as they are inserted. The queue also tracks the processing status of each request made to a Network Resources and will show pending tasks and tasks that have failed the maximum number of allowed times. Once successful processed, pending tasks will be removed automatically from the queue.

Tasks that have failed the maximum number of times will remain in the queue. Users have the option of retrying the task or removing the task from the queue.

Users can use the Activities Types to override the default Maximum number of calls that will be made to a Network Resource.

User can use the Activities Log to view all calls made to a Network Resource. This log is available from the Admin Menu, Customer Information, Orders, Local Product , and USOC Detail pages.

Tiggers - Tiggers are used to "trigger" calls to a Network Resource. In TBS, users can associate one or more Network Resources with a Master USOC via the Master USOC Admin Tool. When a USOC is added to a line, edited or deleted, one record will be added to the Activity Queue for each Network Resources associated with that Master Usoc.

There are other system triggers that will add items to the Activity Queue for processing as well. These are:

  • Changes to a Device that are associated with lines that have Usocs with Network Resources
  • Changes to a Network Information records that are associated with lines that have Usocs with Network Resources

Users can view these Trigger events from the Activities Log as described above. This log is available from the Admin Menu, Customer Information, Orders, Local Product , and USOC Detail pages.