Developer's Guide: ARS Plug-in
Introduction
This plug-in interface provides enhancements on ARS Route Search functionality of Brekeke PBX. You will need to use the Java programming language to create your own plug-in.
ARS Route Search function uses conditions (matching patterns) for SIP headers (From, To, etc.). Those conditions, written as regular expressions, make ARS Search very flexible. Powerful uses of the ARS Plug-in include:
- Searching a telephone directory for a caller‘s number. For example, if the caller is in Do-Not-Call list, you can then decline the call.
- Searching for the least cost route by country number and area code number (Least Cost Routing).
- Searching a telephone directory for a caller’s name using the caller’s number. You can then change the display name with the caller’s name.
*1. For simple searches, you can use [Options] menu > [Notes] for making data list in the Brekeke PBX Admintool. There are default plug-ins for [Notes] menu, so you don’t have to create your own plug-in for it.
*2. Alternatively, you can also place a script in the [Notes] menu and execute it using the default plugin “script“. This method is known as the “Script Plug-in.”
This Script Plug-in approach is more suitable than implementing an ARS Plug-in for creating simple plugins based on JavaScript. Script Plugin>>
To view a topic of your interest, please click on the topics listed in the left column.
Related Links:
- ARS Plug-in Installation and Setup
- Sample ARS Plug-in
- Sample Script Plug-in
- Default Plug-ins for Notes
- Class NoteUtils API