📡 ObSIP Trunking Module - TypeScript Functions Documentation

Angular Admin Panel Documentation

📖 Overview

This document provides a comprehensive list of all TypeScript functions available in the ObSIP Trunking module components and services. The ObSIP Trunking module provides comprehensive SIP (Session Initiation Protocol) trunking management functionality for the telecommunications platform, handling SIP trunk configuration, profile management, carrier integration, BCID/EID management, and DID number assignment.

🧩 Components Overview

SIP Trunking Components

⚙️ CpsconfigurationComponent

File: src/app/obsiptrunking/cpsconfiguration/cpsconfiguration.component.ts

Purpose: Call Processing Server configuration management with CPS settings and user account management

🔧 SiptrunkingprofileComponent

File: src/app/obsiptrunking/siptrunkingprofile/siptrunkingprofile.component.ts

Purpose: SIP trunking profile management with carrier configuration and authentication parameters

🛠️ SiptrunkingsettingComponent

File: src/app/obsiptrunking/siptrunkingsetting/siptrunkingsetting.component.ts

Purpose: General SIP trunking settings with IP configuration and prefix management

🆔 BcidEidSettingComponent

File: src/app/obsiptrunking/bcid-eid-setting/bcid-eid-setting.component.ts

Purpose: BCID (Billing Customer ID) and EID (End user ID) configuration management

📞 BcidDidAddComponent

File: src/app/obsiptrunking/bcid-did-add/bcid-did-add.component.ts

Purpose: BCID and DID number association with number pool management and assignment

Core Service

⚙️ ObsiptrunkingService

File: src/app/obsiptrunking/obsiptrunking.service.ts

Purpose: Core SIP trunking operations, profile management, and BCID/EID operations

⚙️ CpsconfigurationComponent Functions

🔄 Lifecycle Functions

ngOnInit()

/**
 * Component initialization with form setup and data loading
 * Initializes CPS configuration form and loads table headers
 * Sets up dropdown settings and retrieves CPS data
 * @returns {void}
 */
ngOnInit(): void

constructor()

/**
 * Component constructor with service injection
 * Initializes component with ObSIP trunking service and form builder
 * @param {ObsiptrunkingService} data - SIP trunking operations service
 * @param {FormBuilder} fb - Reactive forms builder
 */
constructor(data: ObsiptrunkingService, fb: FormBuilder)

📊 Data Management Functions

CSPData()

/**
 * Load CPS data for display and management
 * Retrieves CPS data and processes CPS values (null to 0)
 * Reverses data order and initializes DataTable
 * @returns {void}
 */
CSPData(): void

SetValue()

/**
 * Set form values based on selected account
 * Updates CPS form with existing CPS value for selected account
 * Sets to 0 if CPS value not found for the account
 * @returns {void}
 */
SetValue(): void

editCsp()

/**
 * Edit CPS configuration for specific account
 * Sets selected account details and CPS value
 * Updates form with account-specific configuration
 * @param {any} san - SAN identifier
 * @param {any} idaccount - Account ID
 * @param {any} csp - CPS value
 * @returns {void}
 */
editCsp(san: any, idaccount: any, csp: any): void

💾 Form Operations

onSubmit()

/**
 * Submit CPS configuration changes
 * Validates form data and submits CPS configuration
 * Handles success/error responses and updates data table
 * @returns {void}
 */
onSubmit(): void

reset()

/**
 * Reset form and clear selected data
 * Clears form fields and resets component state
 * Removes selection and validation errors
 * @returns {void}
 */
reset(): void

🔧 SiptrunkingprofileComponent Functions

🔄 Lifecycle Functions

ngOnInit()

/**
 * Component initialization with profile management setup
 * Initializes SIP trunking profile form and data loading
 * Sets up table headers and loads existing profiles
 * Configures profile validation and carrier settings
 * @returns {void}
 */
ngOnInit(): void

📝 Profile Management Functions

createProfile()

/**
 * Create new SIP trunking profile
 * Validates profile configuration and carrier settings
 * Submits new profile to API and updates profile list
 * @returns {void}
 */
createProfile(): void

editProfile()

/**
 * Edit existing SIP trunking profile
 * Loads profile data into form for modification
 * Handles profile updates and validation
 * @param {any} profile - Profile data to edit
 * @returns {void}
 */
editProfile(profile: any): void

deleteProfile()

/**
 * Delete SIP trunking profile
 * Confirms deletion with user and removes profile
 * Updates profile list and handles dependencies
 * @param {any} profile - Profile to delete
 * @returns {void}
 */
deleteProfile(profile: any): void

🔐 Authentication Functions

configureAuthentication()

/**
 * Configure SIP authentication parameters
 * Sets up username, password, and authentication method
 * Validates authentication settings and security
 * @returns {void}
 */
configureAuthentication(): void

testConnection()

/**
 * Test SIP trunk connection
 * Validates connectivity to carrier using profile settings
 * Performs connection test and reports status
 * @returns {void}
 */
testConnection(): void

🛠️ SiptrunkingsettingComponent Functions

🔄 Lifecycle Functions

ngOnInit()

/**
 * Component initialization with settings management
 * Initializes SIP trunking settings form and configuration
 * Loads IP settings, prefix management, and carrier settings
 * @returns {void}
 */
ngOnInit(): void

🌐 IP Configuration Functions

configureIPSettings()

/**
 * Configure IP settings for SIP trunking
 * Sets up IP addresses, ports, and network configuration
 * Validates IP settings and network connectivity
 * @returns {void}
 */
configureIPSettings(): void

managePrefixes()

/**
 * Manage number prefixes for routing
 * Configures prefix routing rules and carrier mapping
 * Handles prefix validation and routing logic
 * @returns {void}
 */
managePrefixes(): void

updateRouting()

/**
 * Update SIP routing configuration
 * Modifies routing rules and carrier preferences
 * Validates routing settings and applies changes
 * @returns {void}
 */
updateRouting(): void

🆔 BcidEidSettingComponent Functions

🔄 Lifecycle Functions

ngOnInit()

/**
 * Component initialization with BCID/EID management
 * Initializes BCID and EID configuration forms
 * Loads existing BCID/EID mappings and settings
 * @returns {void}
 */
ngOnInit(): void

🏷️ ID Management Functions

createBCID()

/**
 * Create new BCID (Billing Customer ID)
 * Validates BCID format and uniqueness
 * Submits new BCID configuration to system
 * @returns {void}
 */
createBCID(): void

createEID()

/**
 * Create new EID (End user ID)
 * Validates EID format and association rules
 * Submits new EID configuration to system
 * @returns {void}
 */
createEID(): void

mapBCIDToEID()

/**
 * Map BCID to EID for billing association
 * Creates relationship between billing and end user IDs
 * Validates mapping rules and constraints
 * @param {string} bcid - Billing Customer ID
 * @param {string} eid - End user ID
 * @returns {void}
 */
mapBCIDToEID(bcid: string, eid: string): void

✏️ Update Functions

updateBCIDSettings()

/**
 * Update BCID configuration settings
 * Modifies billing customer settings and preferences
 * Validates updates and applies configuration changes
 * @returns {void}
 */
updateBCIDSettings(): void

updateEIDSettings()

/**
 * Update EID configuration settings
 * Modifies end user settings and permissions
 * Validates updates and applies configuration changes
 * @returns {void}
 */
updateEIDSettings(): void

📞 BcidDidAddComponent Functions

🔄 Lifecycle Functions

ngOnInit()

/**
 * Component initialization with DID assignment management
 * Initializes DID assignment forms and number pool management
 * Loads available DIDs and BCID mappings
 * @returns {void}
 */
ngOnInit(): void

📱 DID Management Functions

assignDIDToBCID()

/**
 * Assign DID number to BCID
 * Associates DID numbers with billing customer IDs
 * Validates assignment rules and availability
 * @param {string} did - DID number to assign
 * @param {string} bcid - Target BCID
 * @returns {void}
 */
assignDIDToBCID(did: string, bcid: string): void

bulkDIDAssignment()

/**
 * Perform bulk DID assignment operation
 * Assigns multiple DID numbers to BCIDs in batch
 * Handles bulk validation and error reporting
 * @param {any[]} assignments - Array of DID-BCID assignments
 * @returns {void}
 */
bulkDIDAssignment(assignments: any[]): void

releaseDIDFromBCID()

/**
 * Release DID number from BCID assignment
 * Removes DID association and returns to available pool
 * Handles release validation and cleanup
 * @param {string} did - DID number to release
 * @returns {void}
 */
releaseDIDFromBCID(did: string): void

📊 Pool Management Functions

loadDIDPool()

/**
 * Load available DID number pool
 * Retrieves unassigned DID numbers for assignment
 * Filters and displays available numbers
 * @returns {void}
 */
loadDIDPool(): void

searchDIDs()

/**
 * Search DID numbers by criteria
 * Filters DID pool based on search parameters
 * Supports pattern matching and area code filtering
 * @param {string} criteria - Search criteria
 * @returns {void}
 */
searchDIDs(criteria: string): void

⚙️ ObsiptrunkingService Functions

📡 API Integration Functions

getSIPProfiles()

/**
 * Retrieve SIP trunking profiles from API
 * Fetches all configured SIP trunk profiles
 * Returns profile data with carrier and authentication settings
 * @returns {Observable<any>} SIP profiles response
 */
getSIPProfiles(): Observable<any>

createSIPProfile()

/**
 * Create new SIP trunking profile via API
 * Submits profile configuration to SIP management system
 * Handles profile creation and validation
 * @param {any} profileData - SIP profile configuration
 * @returns {Observable<any>} Profile creation response
 */
createSIPProfile(profileData: any): Observable<any>

updateSIPProfile()

/**
 * Update existing SIP trunking profile
 * Modifies profile configuration and settings
 * Handles validation and change management
 * @param {string} profileId - Profile identifier
 * @param {any} updateData - Updated configuration
 * @returns {Observable<any>} Profile update response
 */
updateSIPProfile(profileId: string, updateData: any): Observable<any>

🆔 BCID/EID Management Functions

manageBCIDs()

/**
 * Manage BCID operations through API
 * Handles BCID creation, updates, and deletion
 * Manages BCID to customer account mapping
 * @param {string} operation - CRUD operation type
 * @param {any} bcidData - BCID configuration data
 * @returns {Observable<any>} BCID operation response
 */
manageBCIDs(operation: string, bcidData: any): Observable<any>

manageEIDs()

/**
 * Manage EID operations through API
 * Handles EID creation, updates, and deletion
 * Manages EID to end user mapping
 * @param {string} operation - CRUD operation type
 * @param {any} eidData - EID configuration data
 * @returns {Observable<any>} EID operation response
 */
manageEIDs(operation: string, eidData: any): Observable<any>

assignDIDsToBCID()

/**
 * Assign DID numbers to BCID via API
 * Processes DID to BCID assignments
 * Handles bulk assignment operations
 * @param {string} bcid - Target BCID
 * @param {string[]} dids - Array of DID numbers
 * @returns {Observable<any>} Assignment operation response
 */
assignDIDsToBCID(bcid: string, dids: string[]): Observable<any>

⚙️ Configuration Management Functions

getCPSConfiguration()

/**
 * Retrieve CPS configuration settings
 * Fetches Call Processing Server configuration
 * Returns account-specific CPS settings
 * @returns {Observable<any>} CPS configuration response
 */
getCPSConfiguration(): Observable<any>

updateCPSConfiguration()

/**
 * Update CPS configuration settings
 * Modifies Call Processing Server configuration
 * Handles CPS value updates for accounts
 * @param {any} cpsData - CPS configuration data
 * @returns {Observable<any>} CPS update response
 */
updateCPSConfiguration(cpsData: any): Observable<any>

testSIPConnection()

/**
 * Test SIP trunk connectivity
 * Validates SIP trunk configuration and connectivity
 * Performs connection tests to carrier endpoints
 * @param {any} profileData - SIP profile for testing
 * @returns {Observable<any>} Connection test results
 */
testSIPConnection(profileData: any): Observable<any>

🔗 SIP Trunking Workflow

📋 Configuration Workflow

  1. Profile Creation - Create SIP trunking profiles with carrier settings
  2. Authentication Setup - Configure SIP authentication parameters
  3. IP Configuration - Set up IP addresses and network settings
  4. BCID/EID Management - Create and map billing and end user IDs
  5. DID Assignment - Assign DID numbers to BCID mappings
  6. Testing - Validate connectivity and configuration

🔧 Management Operations

  1. Profile Management - Create, edit, and delete SIP profiles
  2. CPS Configuration - Manage Call Processing Server settings
  3. Routing Management - Configure call routing and prefixes
  4. Number Pool Management - Manage available DID numbers
  5. Bulk Operations - Perform bulk assignments and updates

📊 Monitoring and Maintenance

  1. Connection Testing - Regular connectivity validation
  2. Configuration Backup - Profile and settings backup
  3. Performance Monitoring - SIP trunk performance tracking
  4. Error Handling - Issue detection and resolution
  5. Updates and Maintenance - System updates and optimization

📋 Summary

30+ Total Functions
5 Components
1 Service

This comprehensive documentation covers all aspects of SIP trunking functionality, from profile management and carrier configuration to BCID/EID operations and DID number assignment within the telecommunications admin panel application.