HttpSDMPBridge
HttpSDMPBridge (HSBridge for short) is an intermediate service between Softdial CallGem™ and any other application session. Its main purposes are:
- message broking - Http requests are translated into SDMP and back
- authentication - In order to establish a session you must first authenticate with HSBridge.
- Reporter Web backend service.
There are three different methods of handling messages:
- asynchronous - Message Verify [MV] or Error Report [ER]
- synchronous - Message Verify [MV] plus Softdial CallGem™ response (e.g. Agent Login [AL] has the response Logged In [LI])
- callbacks - HSBridge is able to callback application session straight away when there is a message from a dialer
In order to create a bridge session you must POST an html form to http://host:7003/AuthEx
See example html form
<form action="http//localhost:7003/authex" method="post">
<input name="tenant" value="tenant"/>
<input name="user" value="agent"/>
<input name="password" value="password"/>
<input name="session" value ="application sessionid"/>
<input name="session name" value="session id name"/>
<input name="session path" value="session path"/>
<input name="session domain" value="application server address"/>
<input name="callback url" value="application server url callback"/>
<input name="version" value="10.6"/>
<input name="capture url" value="http://..."/>
<input name="app session integration method" value="cookie|"/>
</form>
HSBridge opens a separate socket connection to the Softdial CallGem™ and tries to authenticate the user with the credentials from the form document - (tenant/user/password). If authentication is successful the response should be an xml document which conforms to the SXMP protocol.
From this point the HSBridge hosts the SDMP connection which is identified by the application session id from the xml document.
Each time there is a message from the application session to the bridge the session id should be present in the url. This allows the bridge to determine which SDMP connection should be used.
When HSBridge is to callback an application session, it creates an http cookie and attaches it to the request. This allows the bridge to determine which application session is to be used.
In application session you can POST and GET messages using these URL templates:
- Synchronous:
- send?sdmp={sdmp}&auth=authkey={session}
- post?authkey={session}
- Synchronous with Message Verify [MV] or Error Report [ER]
- sendsync?tk={tk}&authkey={session}&sdmp={sdmp}
- post?tk={tk}&authkey={session}
- Synchronous with Message Verify [MV] plus Softdial CallGem™ response (e.g. Agent Login [AL] has the response Logged In [LI]), or Error Report [ER]
- sendsyncex?sdmp={sdmp}&tk={tk}&authkey={session}
- postsyncex?tk={tk}&authkey={session}
The first url always expects the GET method while the second one always expects the POST method with the SDMP message in the body of the message.
The Console Tester utility which is accessed from the web services administration panel (http://localhost/apanel on the bridge server) provides facilities for extracting and testing the RESTful API for all web applications.