n8n-nodes-node-sippysoft

This is an n8n community node. It lets you use Sippy Software Softswitch in your n8n workflows.

Sippy Software Softswitch provides advanced VoIP billing, smart routing, network protection and border control mechanisms all on a single platform.

Development of this node has been prioritised for functions required by its author's. If you would like to contribute please feel free to submit a pull request for review.

n8n is a fair-code licensed workflow automation platform.

Installation Operations Credentials Compatibility Usage Resources Version history

Installation

Follow the installation guide in the n8n community nodes documentation.

Operations

The following lists operations and their implementation status. A link to the Sippy Software documentation for each operation is included for convinience.

Account Manipulation

• [X] List Accounts (listAccounts)
• [ ] Create Account ()
• [ ] Update Account (updateAccount)
• [X] Get Account Info (getAccountInfo)
• [X] Get Registration Status (getRegistrationStatus)
• [ ] Reset One Time Password (resetAccountOneTimePassword)
• [X] Add Account Credit (accountCredit)

Incoming Routes

• [ ] Update Incoming Route (updateIncomingRoute)
• [ ] Get Incoming Routes List (getIncomingRoutesList)

Follow Me Management

• [ ] Get Follow Me Options (getFollowMeOptions)
• [ ] Set Follow Me Options (setFollowMeOptions)
• [ ] List Follow Me Entries (listFollowMeEntries)
• [ ] Add Follow Me Entries (addFollowMeEntry)
• [ ] Update Follow Me Entry (updateFollowMeEntry)
• [ ] Delete Follow Me Entry (getFollowMeOptions)

Trunk Management

• [ ] createTrunk (createTrunk)
• [ ] updateTrunk
• [ ] deleteTrunk
• [ ] getTrunkInfo
• [ ] getTrunksList
• [ ] createTrunkConnection (createTrunkConnection)
• [ ] updateTrunkConnection
• [ ] deleteTrunkConnection
• [ ] getTrunkConnectionInfo
• [ ] getTrunkConnectionsList

Rates & Plans

• [ ] getAccountRates (getAccountRates)
• [ ] matchAccountMinutePlan (matchAccountMinutePlan)

CLI Mapping

• [ ] Add CLI Mapping (addCLIMapping)
• [ ] Update CLI Mapping (updateCLIMapping)
• [ ] Delete CLI Mapping (delCLIMapping)
• [ ] List CLI Mapping (listCLIMapping)
• [ ] Find CLI Mapping (findCLIMapping)

Smart Dials

• [ ] Add Smart Dial (addSmartDial)
• [ ] Update Smart Dial (updateSmartDial)
• [ ] Delete Smart Dial (deleteSmartDial)
• [ ] List Smart Dial (listSmartDial)

Post Authentiaction Rules

• [ ] listPostAuthRules (listPostAuthRules)
• [ ] getPostAuthRuleInfo
• [ ] deletePostAuthRule
• [ ] updatePostAuthRule
• [ ] addPostAuthRule

Hot Dial Numbers

• [ ] addHotDialNumber (addHotDialNumber)
• [ ] delHotDialNumber
• [ ] updateHotDialNumber
• [ ] listHotDialNumbers

Payments

• [ ] getPaymentInfo
• [ ] getPaymentsList
• [ ] rechargeVoucher (rechargeVoucher)
• [ ] Make Payment (makePayment)
• [ ] Make Payment By Card

Card Manipulation

Look, it is probably not the best idea to have raw credit card numbers pass through n8n, these calls should probably never be implemented, but have been included here for transparency on the implementation progress.

• [ ] addDebitCreditCard
• [ ] updateDebitCreditCard
• [ ] deleteDebitCreditCard
• [ ] getDebitCreditCardInfo
• [ ] listDebitCreditCards

Account Balance Manipulation

• [ ] accountAddFunds (accountAddFunds)
• [ ] accountDebit (accountDebit)

Vendor Balance Manipulation

• [ ] vendorAddFunds
• [ ] vendorCredit
• [ ] vendorDebit

Customer Balance Manipulation

• [ ] customerAddFunds
• [ ] customerCredit
• [ ] customerDebit

Low Balances

• [ ] getLowBalance
• [ ] setLowBalance

CDRs Data Retrieving

• [ ] Export Vendor CDRs (Mera) (exportVendorsCDRs_Mera)
• [X] Get Customer CDRs (getCustomerCDRs)
• [X] Get Account CDRs (getAccountCDRs)
• [ ] Get CDR SDP (getCDRSDP)

DID Management

• [ ] addDID
• [ ] updateDID
• [ ] deleteDID
• [ ] getDIDInfo
• [X] Get DIDs List (getDIDsList)
• [ ] getDIDChargingGroupInfo
• [ ] addDIDDelegation
• [ ] updateDIDDelegation
• [ ] deleteDIDDelegation

Miscellaneous

• [ ] getMonitoringGraph getMonitoringGraph
• [ ] Get Monitoring Graph Data (getMonitoringGraphData)

Credentials

You will need to have your Softswitch API credentials setup and enabled. When setting up the credentials you will be asked to enter your server domain name, please use a domain name that has been setup in your softswitch with a valid SSL certificate.

Please note, these credentials will not work with the standard HTTP Request node due to an issue in compatibility between the default digest authentication n8n uses and the implementation used by the softswitch.

Compatibility

This node should work in any version of n8n, however, has been tested only on versions since 1.0.0.

Usageincoming_did

• Trunks Management Due to changes in the Sippy Softswitch API, trunk management calls are only compatible with versions of the softswitch from 2022 onwards.
• DID Management New features present in 2023 have not yet been implemented such as DID Ranges.

Resources

• n8n community nodes documentation
• Sippy Software XML-RPC API documentation

Version history

1. This version was only used internally by node authors, once proof of concept was delivered, best practice of versioning nodes was implement. Version 1 has remained purely for backwards compatibility on those existing internal workflows and is not recommended for general use at all.
2. Following best practice of n8n node code directory structure, this version will be used while adding all the Softswitch API calls, of which there are many. Unless a major change to the Sippy API happens before completing that task.