Event Notifications: Overview
From SwitchvoxExtendAPI
The Event Notifications are set up in the Switchvox Admin Tool Suite:
https://your_switchvox/admin
Log into the Admin Suite and use the URL Manager page (System Setup > URL Manager).
For more information about using the Admin Suite and the URL Manager, see the Switchvox Administrator Manual.
Overview
You can set up Switchvox to notify your Web-based applications when a particular event occurs in Switchvox. Switchvox can submit information about the event, and then accept return XML that includes instructions to set a Caller ID for that call, transfer the call to an extension, and/or set a display URL for use in the Switchboard.
The URLs
For each event that you want a notification, you can set up a URL to your application. Those URLs can include variables that will resolve to event-specific data. When the event happens, Switchvox builds the URL with the event's data, then posts a request to the newly formed URL.
Also, you can set up a Default URL so that you do not have to enter a full URL for every event. Then for each event, you can choose to use that Default URL, or a different URL.
Example
This example is an external call routing engine. When an incoming call is received, Switchvox submits the Caller ID information to a remote web application. That application looks up the Caller ID number in a database, and transfers the call to the appropriate extension.
Let's assume that the remote web server is running at 192.168.0.100, and that the web application is called route.cgi.
In the Switchvox Admin Suite, the following URL is given for the On Incoming Call Event URL:
http://192.168.0.100/route.cgi?cid_number=%CALLER_ID_NUMBER%&cid_name=%CALLER_ID_NAME%
Switchvox receives a call, substitutes the variables with their actual values, and sends the request to the URL. In this example, a request would look like this:
http://192.168.0.100/route.cgi?cid_number=8585551212&cid_name=BOB+JOHNSON
After the URL is requested, route.cgi looks up the number 8585551212, decides to route the call to extension 333, and returns the following XML:
<call_info> <transfer_extension>333</transfer_extension> </call_info>
Switchvox receives this XML, and transfers the call to extension 333.