pbxnsip - Access To the pbxnsip Database

Access To the pbxnsip Database

Purpose:

Accessing to a number of PBX databases serves as an excellent purpose to manage PBX servers from a single remote host management system. The type of access protocol we currently provide is Simple Object Access Protocol (SOAP). This protocol borrows from the well-known Hyper-Text Transfer Protocol(HTTP) which gives web developers and even software engineering with much more power and extensibility with the web/stand-alone application than what the HTTP and basic object/modular collaboration provides.

The basic requirement is that you have at least the fundamental understanding of how HTTP functions and it's request/response mechanism, and follow the proper syntax as described below. SOAP can be pretty simple as HTTP and all of that HTML syntaxes, however it is much more evolved and is becoming a widly accepted standard. The Internet Engineering Task Force (IETF) and the Request For Comment (RFC) entities have incorporated the protocol along with their documentation. If you are interested in comprehensively understanding in what and how SOAP works in great details, it is recommended that you start here.

The main SOAP request functions that accesses the PBX database are identified as:

• DBIndex -> DBIndexResponse
• DBSearch -> DBSearchResponse
• DBGet -> DBGetResponse
• DBSet -> DBSetResponse
• CreateExtension -> CreateExtensionResponse
• DeleteExtension -> DeleteExtensionResponse
• CreatePaging -> CreatePagingResponse
• DeletePaging -> DeletePagingResponse
• CreateDialplan -> CreateDialplanResponse (*)
• DeleteDialplan -> DeleteDialplanResponse (*)
• CreateTrunk -> CreateTrunkResponse (*)
• DeleteTrunk -> DeleteTrunkResponse (*)
• AddCredit -> AddCreditResponse (*)
• AgentLogin -> AgentLoginResponse
• AgentLogout -> AgentLogoutResponse
• (*) - Functionality supported on post 3.2.0.3132 version.

Applicable Table names and Column names can be found in the end of this article.

Note: After submitting with DBSet, it will return a DBSetResponse with the respective index tag e.g. 56. DBSearch, DBIndex and DBGet will return meaningful data in the response. CreateExtension will return the index of the created extension if successful else it returns an index '0'. The DeleteExtension will return 'true' or 'false' as the response.

Note: There are currently no error-checking in this database access.

For instance, if you submit a DBGet or DBSearch query with invalid table name and/or invalid column name(s), it will still return a DBResultset with the index tag (), in some case it may return a null value which usually means that the request is not being sent in correct text encoding such as using the ASCII format instead of UTF-8 format. This error-checking feature will be added soon.

There are also some helper function and an XML parser utilities to simplify such as encapsulating the required SOAP envelopes as well as generating DBIndex/DBSearch/DBGet/DBSet/CreateExtension/DeleteExtension text for the PBX server.

This will give IT professionals much greater control of the system especially when:

• Another PBX needs to be created in a remote location on-the-fly
• Automate creation of accounts, trunks and dial plans
• Back-up all new data in real time
• Store an exact database replica into a RDBMS such as Oracle and MySQL, for better statistics and fast restoration in case of failure.

Note: In order to use the below functions/messages successfully, make sure that the IP address of the sending
computer(device) is set under "Admin->Settings->General->SOAP Trusted IP".